Inheritance diagram for turbulentDispersion:

Collaboration diagram for turbulentDispersion:

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

	turbulentDispersion (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 velocity field. More...

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

virtual void	calculate (const LagrangianSubScalarField &deltaT, const bool final)
	Solve equations and/or update continually changing properties. More...

virtual void	addSup (const LagrangianSubScalarField &deltaT, const LagrangianSubVectorSubField &U, LagrangianEqn< vector > &eqn) const
	Add a source term to the velocity equation. More...

virtual void	addSup (const LagrangianSubScalarField &deltaT, const LagrangianSubScalarSubField &vOrM, const LagrangianSubVectorSubField &U, LagrangianEqn< vector > &eqn) const
	Add a source term to the momentum equation. More...

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

template<class Type >
Foam::Tuple2< bool, Foam::CloudStateField< Type > & >	initialiseTurbField (const word &name, const dimensionSet &dims, const Type &value)

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 LagrangianMesh &	mesh () const
	The mesh. More...

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

template<class Type , template< class > class PrimitiveField>
bool	addsSupToField (const LagrangianSubField< Type, PrimitiveField > &field) const
	Return true if the LagrangianModels adds a source term to the. 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, LagrangianSubScalarField &S) const
	Add a fractional source term. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Add a source term to an equation. 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	read (const dictionary &modelDict)
	Read dictionary. 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 AlphaRhoFieldType >
Foam::word	fieldName (const AlphaRhoFieldType &alphaRhoField)

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

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 AlphaRhoFieldType >
static word	fieldName (const AlphaRhoFieldType &alphaRhoField)
	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 &m, const LagrangianSubSubField< Type > &field, LagrangianEqn< Type > &eqn) const
	Add a source term to a mass-weighted equation. More...

Detailed Description

Definition at line 63 of file turbulentDispersion.H.

Constructor & Destructor Documentation

◆ turbulentDispersion()

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

Construct from components.

Definition at line 112 of file turbulentDispersion.C.

References momentumTransportModel::k().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "turbulentDispersion" )

Runtime type information.

◆ addSupFields()

Foam::wordList addSupFields ( ) const

virtual

Return the name of the velocity field.

Reimplemented from LagrangianModel.

Definition at line 162 of file turbulentDispersion.C.

References U.

◆ postConstruct()

void postConstruct ( )

virtual

Do post construction steps which require access to other models.

Reimplemented from LagrangianModel.

Definition at line 168 of file turbulentDispersion.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, and cloud::LagrangianModels().

Here is the call graph for this function:

◆ calculate()

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

virtual

Solve equations and/or update continually changing properties.

Reimplemented from LagrangianModel.

Definition at line 203 of file turbulentDispersion.C.

References Foam::cos(), Foam::dimEnergy, Foam::dimless, Foam::dimMass, Foam::dimTime, Foam::dimVelocity, forAll, Foam::labelMax, Foam::labelMin, Foam::mag(), Foam::max(), DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), Foam::min(), DimensionedField< Type, GeoMesh, PrimitiveField >::New(), OldTimeField< FieldType >::oldTime(), rndGen(), standardNormal::sample(), Foam::sin(), Foam::sqr(), Foam::sqrt(), Foam::constant::mathematical::twoPi(), U, and Foam::Zero.

Here is the call graph for this function:

◆ addSup() [1/2]

void addSup	(	const LagrangianSubScalarField &	deltaT,
		const LagrangianSubVectorSubField &	U,
		LagrangianEqn< vector > &	eqn
	)		const

virtual

Add a source term to the velocity equation.

Definition at line 316 of file turbulentDispersion.C.

References DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), and LagrangianEqn< Type >::Su.

Here is the call graph for this function:

◆ addSup() [2/2]

void addSup	(	const LagrangianSubScalarField &	deltaT,
		const LagrangianSubScalarSubField &	vOrM,
		const LagrangianSubVectorSubField &	U,
		LagrangianEqn< vector > &	eqn
	)		const