Model to represent mass transfer into the carrier phase with a constant surface volume or mass flux. This model provides a crude approximation of phase change which neglects any thermal effects. It can be used by clouds and in solvers that do not feature any thermodynamic modelling. More...

Inheritance diagram for constantFluxCarrierTransfer:

[legend]

Collaboration diagram for constantFluxCarrierTransfer:

[legend]

Public Member Functions
	TypeName ("constantFluxCarrierTransfer")
	Runtime type information. More...

	constantFluxCarrierTransfer (const word &name, const LagrangianMesh &mesh, const dictionary &modelDict, const dictionary &stateDict)
	Construct from components. More...

virtual wordList	addSupFields () const
	Return the name of the volume or mass field. More...

virtual bool	addsSupToField (const word &fieldName, const word &eqnFieldName) const
	Return true if this is a Lagrangian field or a field of the. More...

virtual void	calculate (const LagrangianSubScalarField &deltaT, const bool final)
	Update the transfer rate and remove any consumed particles. More...

virtual tmp< LagrangianSubScalarField >	source (const word &fieldName, const LagrangianSubMesh &subMesh) const
	Return the source value. More...

virtual void	preAddSup (const LagrangianSubScalarField &deltaT, const bool final)
	Hook before source evaluation. More...

virtual void	postAddSup (const LagrangianSubScalarField &deltaT, const bool final)
	Add a source term to an equation. More...

virtual bool	read (const dictionary &modelDict)
	Read dictionary. More...

Public Member Functions inherited from LagrangianSource
	TypeName ("LagrangianSource")
	Runtime type information. More...

	LagrangianSource (const word &name, const LagrangianMesh &mesh)
	Construct from components. More...

virtual	~LagrangianSource ()
	Destructor. More...

Public Member Functions inherited from LagrangianModel
	TypeName ("LagrangianModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, LagrangianModel, dictionary,(const word &name, const LagrangianMesh &mesh, const dictionary &modelDict, const dictionary &stateDict),(name, mesh, modelDict, stateDict))
	Declare run-time constructor selection table. More...

	LagrangianModel (const word &name, const LagrangianMesh &mesh)
	Construct from components. More...

	LagrangianModel (const LagrangianModel &)=delete
	Disallow default bitwise copy construction. More...

autoPtr< LagrangianModel >	clone () const
	Clone. More...

virtual	~LagrangianModel ()
	Destructor. More...

const word &	name () const
	The source name. More...

const objectRegistry &	db () const
	The database. More...

const Time &	time () const
	Return time. More...

const LagrangianMesh &	mesh () const
	The mesh. More...

template<class Type , template< class > class PrimitiveField, template< class > class PrimitiveEqnField>
bool	addsSupToField (const LagrangianSubField< Type, PrimitiveField > &field, const LagrangianSubField< Type, PrimitiveEqnField > &eqnfield) const
	Return true if the LagrangianModels adds a source term to the. More...

virtual void	postConstruct ()
	Do post construction steps which require access to other models. More...

virtual void	correct ()
	Correct the LagrangianModel. More...

virtual void	preModify (const LagrangianMesh &mesh, DynamicList< elementModification > &elementModifications) const
	Identify elements in the Lagrangian mesh which are to be. More...

virtual LagrangianSubMesh	modify (LagrangianMesh &mesh, const LagrangianSubMesh &modifiedMesh) const
	Instantaneously modify and/or create and remove elements in the. More...

virtual void	addSup (const LagrangianSubScalarField &deltaT, LagrangianEqn< scalar > &eqn) const
	Add a fractional source term. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

virtual bool	write (const bool write) const
	Write data. More...

void	operator= (const LagrangianModel &)=delete
	Disallow default bitwise assignment. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::word	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class Type , class GeoMesh , template< class > class PrimitiveField>
const Foam::word &	fieldName (const GeometricField< Type, GeoMesh, PrimitiveField > &field)

template<class Type , class GeoMesh , template< class > class PrimitiveField>
const Foam::word &	fieldName (const DimensionedField< Type, GeoMesh, PrimitiveField > &field)

template<class Type , template< class > class PrimitiveField>
Foam::word	fieldName (const DimensionedField< Type, LagrangianSubMesh, PrimitiveField > &field)

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::word	fieldsName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType >
Foam::word	fieldsName (const AlphaRhoFieldType &alphaRhoField)

Public Member Functions inherited from stateModel
	stateModel ()
	Construct null. More...

	stateModel (const stateModel &)=delete
	Disallow default bitwise copy construction. More...

virtual	~stateModel ()
	Destructor. More...

bool	writeState (const bool write) const
	Write state. More...

virtual void	writeState (Ostream &os) const
	Write state. More...

virtual void	writeProcessorState (Ostream &os) const
	Write processor state. More...

void	operator= (const stateModel &)=delete
	Disallow default bitwise assignment. More...

Additional Inherited Members
Public Types inherited from LagrangianModel
enum class	modification : label { change = 0 , remove = 1 }
	Enumeration of the types of instantaneous modification. More...

typedef LagrangianMesh::elementGroup< modification >	elementModification
	Class containing an element-index and a modification-enumeration. More...

Static Public Member Functions inherited from LagrangianModel
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static word	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the name of the field associated with a source term. More...

template<class Type , class GeoMesh , template< class > class PrimitiveField>
static const word &	fieldName (const GeometricField< Type, GeoMesh, PrimitiveField > &)
	Return the name of the field associated with a source term (base. More...

template<class Type , class GeoMesh , template< class > class PrimitiveField>
static const word &	fieldName (const DimensionedField< Type, GeoMesh, PrimitiveField > &)
	Return the name of the field associated with a source term (base. More...

template<class Type , template< class > class PrimitiveField>
static word	fieldName (const DimensionedField< Type, LagrangianSubMesh, PrimitiveField > &)
	Return the name of the field associated with a source term (base. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static word	fieldsName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the name of the product of the fields associated with a. More...

template<class AlphaRhoFieldType >
static word	fieldsName (const AlphaRhoFieldType &alphaRhoField)
	Return the name of the product of the fields associated with a. More...

static autoPtr< LagrangianModel >	New (const word &name, const LagrangianMesh &mesh, const dictionary &modelDict)
	Selector. More...

Static Public Member Functions inherited from stateModel
static dictionary	stateDict (const word &name, const objectRegistry &db)
	Construct and return the state dictionary for reading. More...

Protected Member Functions inherited from LagrangianModel
template<class Type >
void	addSupType (const LagrangianSubScalarField &deltaT, const LagrangianSubSubField< Type > &field, LagrangianEqn< Type > &eqn) const
	Add a source term to an equation. More...

template<class Type >
void	addSupType (const LagrangianSubScalarField &deltaT, const LagrangianSubScalarSubField &vOrM, const LagrangianSubSubField< Type > &field, LagrangianEqn< Type > &eqn) const
	Add a source term to a volume or mass-weighted equation. More...

Detailed Description

Model to represent mass transfer into the carrier phase with a constant surface volume or mass flux. This model provides a crude approximation of phase change which neglects any thermal effects. It can be used by clouds and in solvers that do not feature any thermodynamic modelling.

Usage

Example specification:

<LagrangianModelName>
{
    type        constantFluxCarrierTransfer;
    volumeFlux  1 [ml/cm^2/s];
}

Source files

Definition at line 65 of file constantFluxCarrierTransfer.H.

Constructor & Destructor Documentation

◆ constantFluxCarrierTransfer()

constantFluxCarrierTransfer	(	const word &	name,
		const LagrangianMesh &	mesh,
		const dictionary &	modelDict,
		const dictionary &	stateDict
	)

Construct from components.

Definition at line 214 of file constantFluxCarrierTransfer.C.

Member Function Documentation

◆ TypeName()

TypeName ( "constantFluxCarrierTransfer" )

Runtime type information.

◆ addSupFields()

Foam::wordList addSupFields ( ) const

virtual

Return the name of the volume or mass field.

Reimplemented from LagrangianModel.

Definition at line 241 of file constantFluxCarrierTransfer.C.

References massive::mName, and shaped::vName.

◆ addsSupToField()

bool addsSupToField	(	const word &	fieldName,
		const word &	eqnFieldName
	)		const

virtual

Return true if this is a Lagrangian field or a field of the.

Eulerian carrier phase

Implements LagrangianModel.

Definition at line 250 of file constantFluxCarrierTransfer.C.

References IOobject::group(), IOobject::member(), and word::null.

Here is the call graph for this function:

◆ calculate()

void calculate	(	const LagrangianSubScalarField &	deltaT,
		const bool	final
	)

virtual

Update the transfer rate and remove any consumed particles.

Reimplemented from LagrangianModel.

Definition at line 268 of file constantFluxCarrierTransfer.C.

References Foam::cbrt(), Foam::dimArea, Foam::dimMass, Foam::dimTime, forAll, DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), mesh, Foam::constant::mathematical::pi(), LagrangianSubMesh::sub(), and Foam::toBeRemoved.

Here is the call graph for this function:

◆ source()

Foam::tmp< Foam::LagrangianSubScalarField > source	(	const word &	fieldName,
		const LagrangianSubMesh &	subMesh
	)		const

virtual

Return the source value.

Implements LagrangianSource.

Definition at line 322 of file constantFluxCarrierTransfer.C.

References Foam::fvc::Sp().

Here is the call graph for this function:

◆ preAddSup()

void preAddSup	(	const LagrangianSubScalarField &	deltaT,
		const bool	final
	)

virtual

Hook before source evaluation.

Reimplemented from LagrangianModel.

Definition at line 339 of file constantFluxCarrierTransfer.C.

References Foam::dimless, Foam::findIndex(), DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), mesh, Foam::name(), LagrangianSubMesh::sub(), Foam::dimensions::time, and Foam::toBeRemoved.

Here is the call graph for this function:

◆ postAddSup()

virtual void postAddSup	(	const LagrangianSubScalarField &	deltaT,
		const bool	final
	)

virtual

Add a source term to an equation.

Add a source term to a volume or mass-weighted equation Hook after source evaluation

Reimplemented from LagrangianModel.

◆ read()

bool read ( const dictionary & modelDict )

virtual

Read dictionary.

Reimplemented from LagrangianModel.

Definition at line 393 of file constantFluxCarrierTransfer.C.

References LagrangianModel::read().

Here is the call graph for this function:

The documentation for this class was generated from the following files:

src/Lagrangian/cloud/LagrangianModels/constantFluxCarrierTransfer/constantFluxCarrierTransfer.H
src/Lagrangian/cloud/LagrangianModels/constantFluxCarrierTransfer/constantFluxCarrierTransfer.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ constantFluxCarrierTransfer()

Member Function Documentation

◆ TypeName()

◆ addSupFields()

◆ addsSupToField()

◆ calculate()

◆ source()

◆ preAddSup()

◆ postAddSup()

◆ read()