This fvModel adds any number of Lagrangian clouds to any single-phase solver. The particles are tracked through, and exchange sources with, the Eulerian flow field. More...

Inheritance diagram for clouds:

[legend]

Collaboration diagram for clouds:

[legend]

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

	clouds (const word &sourceName, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from explicit source name and mesh. More...

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

virtual wordList	addSupFields () const
	Return the list of fields for which the option adds source term. More...

virtual void	correct ()
	Solve the Lagrangian clouds and update the sources. More...

virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn) const
	Add source to continuity equation. More...

virtual void	addSup (const volScalarField &rho, const volScalarField &field, fvMatrix< scalar > &eqn) const
	Add source to enthalpy or species equation. More...

virtual void	addSup (const volVectorField &U, fvMatrix< vector > &eqn) const
	Add source to incompressible momentum equation. More...

virtual void	addSup (const volScalarField &rho, const volVectorField &U, fvMatrix< vector > &eqn) const
	Add source to compressible momentum equation. More...

virtual void	preUpdateMesh ()
	Prepare for mesh update. 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	movePoints ()
	Update for mesh motion. More...

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

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

	declareRunTimeSelectionTable (autoPtr, fvModel, dictionary,(const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict),(name, modelType, mesh, dict))

	fvModel (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from components. More...

autoPtr< fvModel >	clone () const
	Return clone. More...

virtual	~fvModel ()
	Destructor. More...

const word &	name () const
	Return const access to the source name. More...

const fvMesh &	mesh () const
	Return const access to the mesh database. More...

const dictionary &	coeffs () const
	Return dictionary. More...

virtual bool	addsSupToField (const word &fieldName) const
	Return true if the fvModel adds a source term to the given. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

virtual void	addSup (fvMatrix< scalar > &eqn) const
	Add a source term to a field-less proxy equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const
	Add a source term to an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const VolField< Type > &field) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const
	Return source for an equation with a second time derivative. More...

virtual bool	read (const dictionary &dict)
	Read source dictionary. More...

virtual bool	write (const bool write=true) const
	Write fvModel data. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

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

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

template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const

Additional Inherited Members
Static Public Member Functions inherited from fvModel
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the dimensions of the matrix of a source term. More...

static const dimensionSet &	sourceDims (const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...

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

template<class AlphaRhoFieldType >
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField)
	Return the name of the field associated with a source term (base. More...

static const word &	fieldName ()
	Return the name of the field associated with a source term. Special. More...

static autoPtr< fvModel >	New (const word &name, const fvMesh &mesh, const dictionary &dict)
	Return a reference to the selected fvModel. More...

Protected Member Functions inherited from fvModel
template<class Type >
void	addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to an equation. More...

template<class Type >
void	addSupType (const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a compressible equation. More...

template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a phase equation. More...

template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const
	Return a source for an equation. More...

Detailed Description

This fvModel adds any number of Lagrangian clouds to any single-phase solver. The particles are tracked through, and exchange sources with, the Eulerian flow field.

As well as the fvModel controls, properties must be specified for each cloud. For a single cloud, these should be provided in the constant/cloudProperties file. For multiple clouds, the list of cloud names must first be provided in the constant/clouds file. Then, each named cloud has its properties specified in its constant/<cloudName>Properties file.

The application of sources to the Eulerian fields is controlled by the solution/coupled switch in each cloud's properties file. If set to "true" then the Eulerian phase will have forces, and heat and mass sources applied to it by the Lagrangian phase. If set to "false" then these will be omitted, and the Lagrangian phase will not affect the Eulerian phase.

If this model is used with an incompressible solver, then the density of the Eulerian phase must be specified in the constant/physicalProperties dictionary.

Gravity will be read from the constant/g file if present, otherwise it will default to zero.

Usage

Example usage:

clouds
{
    libs        ("liblagrangianParcel.so");
    type        clouds;
}

Property	Description	Required	Default value
`type`	Type name: clouds	yes
`rho`	Name of the density field	no	rho
`U`	Name of the velocity field	no	U

Source files

Definition at line 112 of file clouds.H.

Constructor & Destructor Documentation

◆ clouds() [1/2]

clouds	(	const word &	sourceName,
		const word &	modelType,
		const fvMesh &	mesh,
		const dictionary &	dict
	)

Construct from explicit source name and mesh.

Definition at line 51 of file clouds.C.

◆ clouds() [2/2]

clouds ( const clouds & )

delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "clouds" )

Runtime type information.

◆ addSupFields()

Foam::wordList addSupFields ( ) const

virtual

Return the list of fields for which the option adds source term.

to the transport equation

Reimplemented from fvModel.

Definition at line 158 of file clouds.C.

References List< T >::append(), fieldNames, forAll, basicThermo::he(), IOobject::name(), multicomponentThermo::solveSpecie(), and multicomponentThermo::Y().

Here is the call graph for this function:

◆ correct()

void correct ( )

virtual

Solve the Lagrangian clouds and update the sources.

Reimplemented from fvModel.

Definition at line 189 of file clouds.C.

References timeIndex.

◆ addSup() [1/4]

void addSup	(	const volScalarField &	rho,
		fvMatrix< scalar > &	eqn
	)		const

virtual

Add source to continuity equation.

Definition at line 207 of file clouds.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, fvMatrix< Type >::psi(), rho, and Foam::type().

Here is the call graph for this function:

◆ addSup() [2/4]

void addSup	(	const volScalarField &	rho,
		const volScalarField &	field,
		fvMatrix< scalar > &	eqn
	)		const

virtual

Add source to enthalpy or species equation.

Definition at line 239 of file clouds.C.

References multicomponentThermo::containsSpecie(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, basicThermo::he(), Foam::Info, IOobject::name(), fvMatrix< Type >::psi(), multicomponentThermo::specieIndex(), and Foam::type().

Here is the call graph for this function:

◆ addSup() [3/4]

void addSup	(	const volVectorField &	U,
		fvMatrix< vector > &	eqn
	)		const

virtual

Add source to incompressible momentum equation.

Definition at line 292 of file clouds.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, fvMatrix< Type >::psi(), Foam::type(), and U.

Here is the call graph for this function:

◆ addSup() [4/4]

void addSup	(	const volScalarField &	rho,
		const volVectorField &	U,
		fvMatrix< vector > &	eqn
	)		const

virtual

Add source to compressible momentum equation.

Definition at line 324 of file clouds.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, fvMatrix< Type >::psi(), Foam::type(), and U.

Here is the call graph for this function:

◆ preUpdateMesh()

void preUpdateMesh ( )

virtual

Prepare for mesh update.

Reimplemented from fvModel.

Definition at line 357 of file clouds.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Implements fvModel.

Definition at line 364 of file clouds.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 370 of file clouds.C.

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 376 of file clouds.C.

◆ movePoints()

bool movePoints ( )

virtual

Update for mesh motion.

Implements fvModel.

Definition at line 382 of file clouds.C.

◆ operator=()

void operator= ( const clouds & )

delete

Disallow default bitwise assignment.

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

src/lagrangian/parcel/fvModels/clouds/clouds.H
src/lagrangian/parcel/fvModels/clouds/clouds.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ clouds() [1/2]

◆ clouds() [2/2]

Member Function Documentation

◆ TypeName()

◆ addSupFields()

◆ correct()

◆ addSup() [1/4]

◆ addSup() [2/4]

◆ addSup() [3/4]

◆ addSup() [4/4]

◆ preUpdateMesh()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ movePoints()

◆ operator=()