Finite volume model that solves for the evolution of a cloud. Provides two-way coupling with a finite-volume carrier phase. More...

Inheritance diagram for cloud:

[legend]

Collaboration diagram for cloud:

[legend]

Classes
class	Cloud
	Empty template class used to template the constructor on the type. More...

Public Member Functions
	TypeName ("cloud")
	Run-time type information. More...

virtual	~cloud ()
	Destructor. More...

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

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

virtual void	correct ()
	Add a source term to an equation. More...

virtual void	preUpdateMesh ()
	Prepare for mesh update. More...

virtual bool	movePoints ()
	Update for mesh motion. 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...

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	Sfield (const VolField< Type > &field, const dimensionSet &dims) const

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

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

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

virtual	~fvSource ()
	Destructor. More...

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

void	operator= (const fvSource &)=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 word &	keyword () const
	Return name as the keyword. More...

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

const dictionary &	coeffs (const dictionary &) const
	Return the coefficients sub-dictionary. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. 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

Protected Member Functions
template<class Type >
	cloud (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict, const Cloud< Type > &)
	Construct from components. 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...

Additional Inherited Members
Static Public Member Functions inherited from fvSource
static void	infoField (const word &name, const dimensionSet &dims, const scalarField &field, const bool print=true)
	Print min/average/max information for a given field. More...

static void	infoField (const word &name, const DimensionedField< scalar, fvMesh > &field, const bool print=true)
	Print min/average/max information for a given field. More...

static void	infoField (const DimensionedField< scalar, fvMesh > &field, const bool print=true)
	Print min/average/max information for a given field. More...

Static Public Member Functions inherited from fvModel
static const dictionary &	coeffs (const word &modelType, const dictionary &)
	Return the coefficients sub-dictionary for a given model type. More...

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...

Static Public Attributes inherited from fvModel
static const wordHashSet	keywords
	The keywords read by this class. More...

Detailed Description

Finite volume model that solves for the evolution of a cloud. Provides two-way coupling with a finite-volume carrier phase.

Source files

Definition at line 53 of file cloud_fvModel.H.

Constructor & Destructor Documentation

◆ cloud()

cloud	(	const word &	name,
		const word &	modelType,
		const fvMesh &	mesh,
		const dictionary &	dict,
		const Cloud< Type > &
	)

protected

Construct from components.

Definition at line 31 of file cloud_fvModelTemplates.C.

References cloud::LagrangianModels().

Here is the call graph for this function:

◆ ~cloud()

~cloud ( )

virtual

Destructor.

Definition at line 450 of file cloud_fvModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "cloud" )

Run-time type information.

◆ addsSupToField()

bool addsSupToField ( const word & fieldName ) const

virtual

Return true if the fvModel adds a source term to the given.

field's transport equation

Implements fvSource.

Definition at line 456 of file cloud_fvModel.C.

References LagrangianModels::addsSupToField(), Foam::FOR_ALL_FIELD_TYPES(), IOobject::group(), hasCarrierEqnType, LagrangianModels::LagrangianModels(), carried::nameToCarrierName(), and word::null.

Here is the call graph for this function:

◆ addSup()

void addSup ( fvMatrix< scalar > & eqn ) const

virtual

Add a source term to a field-less proxy equation.

Reimplemented from fvModel.

Definition at line 480 of file cloud_fvModel.C.

References DebugInFunction, Foam::endl(), Foam::notNull(), fvMatrix< Type >::psi(), and coupledToConstantDensityFluid::rhoByRhoc.

Here is the call graph for this function:

◆ correct()

void correct ( )

virtual

Add a source term to an equation.

Add a source term to a compressible equation Add a source term to a phase equation Solve the evolution of the cloud over the current time-step

Reimplemented from fvModel.

Definition at line 516 of file cloud_fvModel.C.

References dictionary::lookup(), objectRegistry::lookupObject(), singleRegionSolutionControl::mesh(), mesh, pimple(), fvMesh::solution(), and Foam::typeName().

Here is the call graph for this function:

◆ preUpdateMesh()

void preUpdateMesh ( )

virtual

Prepare for mesh update.

Reimplemented from fvModel.

Definition at line 538 of file cloud_fvModel.C.

◆ movePoints()

bool movePoints ( )

virtual

Update for mesh motion.

Implements fvModel.

Definition at line 544 of file cloud_fvModel.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Implements fvModel.

Definition at line 550 of file cloud_fvModel.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 556 of file cloud_fvModel.C.

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 562 of file cloud_fvModel.C.

◆ Sfield()

Foam::tmp<Foam::fvMatrix<Type> > Sfield	(	const VolField< Type > &	field,
		const dimensionSet &	dims
	)		const

Definition at line 182 of file cloud_fvModel.C.

References IOobject::group(), Foam::name(), Foam::fvm::S(), GeometricField< Type, GeoMesh, PrimitiveField >::sources(), and Foam::fvm::Sp().

Here is the call graph for this function:

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

src/Lagrangian/cloud/fvModel/cloud_fvModel.H
src/Lagrangian/cloud/fvModel/cloud_fvModel.C
src/Lagrangian/cloud/fvModel/cloud_fvModelTemplates.C

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cloud()

◆ ~cloud()

Member Function Documentation

◆ TypeName()

◆ addsSupToField()

◆ addSup()

◆ correct()

◆ preUpdateMesh()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ Sfield()