Base class for clouds which are coupled to a carrier. More...

Inheritance diagram for coupled:

Collaboration diagram for coupled:

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

	coupled (const cloud &c, const carried &)
	Construct from a reference to the cloud. More...

virtual	~coupled ()
	Destructor. More...

bool	hasCarrierEqns () const
	Return if any carrier equations are cached. More...

template<class Type >
bool	hasCarrierEqn (const word &) const
	Return if a carrier equation is in the cache. More...

template<class Type >
const CarrierEqn< Type > &	carrierEqn (const word &) const
	Get a carrier equation from the cache. More...

template<class Type >
const HashTable< const CarrierEqn< Type > * >	carrierEqns (const word &) const
	Get multiple phase carrier equations from the cache. More...

template<class Type >
bool	hasCarrierEqn (const VolField< Type > &) const
	Return if a carrier equation is in the cache. More...

template<class Type >
const CarrierEqn< Type > &	carrierEqn (const VolField< Type > &) const
	Get a carrier equation from the cache. More...

template<class Type >
const HashTable< const CarrierEqn< Type > * >	carrierEqns (const VolField< Type > &) const
	Get multiple phase carrier equations from the cache. More...

template<class Type >
Foam::CarrierEqn< Type > &	carrierEqn (const CloudDerivedField< Type > &psic)

template<class Type >
Foam::CarrierEqn< Type > &	carrierEqn (const CarrierField< Type > &psic)

template<class Type >
Foam::tmp< Foam::LagrangianEqn< Type > >	psicEqn (const LagrangianSubScalarField &deltaT, const LagrangianSubScalarSubField &vOrM, const LagrangianSubSubField< Type > &psi, const CloudDerivedField< Type > &psic) const

template<class Type >
const Foam::CarrierEqn< Type > &	carrierEqn (const word &key) const

template<class Type >
const Foam::HashTable< const Foam::CarrierEqn< Type > * >	carrierEqns (const word &key) const

template<class Type >
const Foam::CarrierEqn< Type > &	carrierEqn (const VolField< Type > &psi) const

template<class Type >
const Foam::HashTable< const Foam::CarrierEqn< Type > * >	carrierEqns (const VolField< Type > &psi) const

Public Attributes
const CloudDerivedField< scalar > &	nuc
	Carrier kinematic viscosity. More...

Protected Member Functions
void	updateCarrier ()
	Update the cached carrier fields. More...

template<class Type >
CarrierEqn< Type > &	carrierEqn (const CloudDerivedField< Type > &)
	Add/get a carrier equation to/from the cache. More...

template<class Type >
CarrierEqn< Type > &	carrierEqn (const CarrierField< Type > &)
	Add/get a carrier equation to/from the cache. More...

void	clearCarrierEqns ()
	Clear the carrier equations. More...

template<class Type >
bool	initPsicDdt (const LagrangianSubScalarSubField &vOrM, const CloudDerivedField< Type > &psic) const
	Do we need to re-calculate particles that are modified? More...

tmp< LagrangianEqn< scalar > >	psicEqn (const LagrangianSubScalarField &deltaT, const LagrangianSubScalarSubField &vOrM, const CloudDerivedField< scalar > &oneOrRhoc) const
	Return the basic models-only equation for a carrier field. More...

template<class Type >
tmp< LagrangianEqn< Type > >	psicEqn (const LagrangianSubScalarField &deltaT, const LagrangianSubScalarSubField &vOrM, const LagrangianSubSubField< Type > &psi, const CloudDerivedField< Type > &psic) const
	Return the basic models-only equation for a carrier field. More...

Detailed Description

Base class for clouds which are coupled to a carrier.

Source files

Definition at line 54 of file coupled.H.

Constructor & Destructor Documentation

◆ coupled()

coupled	(	const cloud &	c,
		const carried &	carriedCloud
	)

Construct from a reference to the cloud.

Definition at line 148 of file coupled.C.

◆ ~coupled()

~coupled ( )

virtual

Destructor.

Definition at line 165 of file coupled.C.

Member Function Documentation

◆ updateCarrier()

void updateCarrier ( )

protected

Update the cached carrier fields.

Definition at line 101 of file coupled.C.

Referenced by kinematicParcel::solve(), kinematicParticle::solve(), and coupledToFluid::updateCarrier().

Here is the caller graph for this function:

◆ carrierEqn() [1/8]

CarrierEqn<Type>& carrierEqn ( const CloudDerivedField< Type > & )

protected

Add/get a carrier equation to/from the cache.

◆ carrierEqn() [2/8]

CarrierEqn<Type>& carrierEqn ( const CarrierField< Type > & )

protected

Add/get a carrier equation to/from the cache.

◆ clearCarrierEqns()

void clearCarrierEqns ( )

protected

Clear the carrier equations.

Definition at line 110 of file coupled.C.

References CLEAR_TYPE_CARRIER_EQNS, and Foam::FOR_ALL_FIELD_TYPES().

Referenced by dynamicParcel::solve(), dynamicParticle::solve(), kinematicParcel::solve(), kinematicParticle::solve(), multicomponentParcel::solve(), multicomponentParticle::solve(), parcel::solve(), and particle::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initPsicDdt()

bool initPsicDdt	(	const LagrangianSubScalarSubField &	vOrM,
		const CloudDerivedField< Type > &	psic
	)		const

protected

Do we need to re-calculate particles that are modified?

Definition at line 78 of file coupledTemplates.C.

References DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), Foam::Lagrangianm::initDdt(), and DimensionedField< Type, GeoMesh, PrimitiveField >::mesh().

Here is the call graph for this function:

◆ psicEqn() [1/3]

Foam::tmp< Foam::LagrangianEqn< Foam::scalar > > psicEqn	(	const LagrangianSubScalarField &	deltaT,
		const LagrangianSubScalarSubField &	vOrM,
		const CloudDerivedField< scalar > &	oneOrRhoc
	)		const

protected

Return the basic models-only equation for a carrier field.

Definition at line 129 of file coupled.C.

References DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), LagrangianModels::LagrangianModels(), DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), Foam::Lagrangianm::noDdt(), and LagrangianModels::sourceProxy().

Here is the call graph for this function:

◆ psicEqn() [2/3]

tmp<LagrangianEqn<Type> > psicEqn	(	const LagrangianSubScalarField &	deltaT,
		const LagrangianSubScalarSubField &	vOrM,
		const LagrangianSubSubField< Type > &	psi,
		const CloudDerivedField< Type > &	psic
	)		const

protected

Return the basic models-only equation for a carrier field.

◆ TypeName()

TypeName ( "coupled" )

Run-time type information.

◆ hasCarrierEqns()

bool hasCarrierEqns ( ) const

Return if any carrier equations are cached.

Definition at line 171 of file coupled.C.

◆ hasCarrierEqn() [1/2]

bool hasCarrierEqn ( const word & key ) const

Return if a carrier equation is in the cache.

Definition at line 112 of file coupledTemplates.C.

◆ carrierEqn() [3/8]

const CarrierEqn<Type>& carrierEqn ( const word & ) const

Get a carrier equation from the cache.

◆ carrierEqns() [1/4]

const HashTable<const CarrierEqn<Type>*> carrierEqns ( const word & ) const

Get multiple phase carrier equations from the cache.

◆ hasCarrierEqn() [2/2]

bool hasCarrierEqn ( const VolField< Type > & psi ) const

Return if a carrier equation is in the cache.

Definition at line 152 of file coupledTemplates.C.

References psi.

◆ carrierEqn() [4/8]

const CarrierEqn<Type>& carrierEqn ( const VolField< Type > & ) const

Get a carrier equation from the cache.

◆ carrierEqns() [2/4]

const HashTable<const CarrierEqn<Type>*> carrierEqns ( const VolField< Type > & ) const

Get multiple phase carrier equations from the cache.

◆ carrierEqn() [5/8]

Foam::CarrierEqn<Type>& carrierEqn ( const CloudDerivedField< Type > & psic )

Definition at line 33 of file coupledTemplates.C.

References carried::carrierNameToName(), HashTable< T, Key, Hash >::find(), CloudDerivedField< Type >::name(), and carried::Uc.

Here is the call graph for this function:

◆ carrierEqn() [6/8]

Foam::CarrierEqn<Type>& carrierEqn ( const CarrierField< Type > & psic )

Definition at line 56 of file coupledTemplates.C.

References HashTable< T, Key, Hash >::find().

Here is the call graph for this function:

◆ psicEqn() [3/3]

Foam::tmp<Foam::LagrangianEqn<Type> > psicEqn	(	const LagrangianSubScalarField &	deltaT,
		const LagrangianSubScalarSubField &	vOrM,
		const LagrangianSubSubField< Type > &	psi,
		const CloudDerivedField< Type > &	psic
	)		const

Definition at line 91 of file coupledTemplates.C.

References DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), LagrangianModels::LagrangianModels(), DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), Foam::Lagrangianm::noDdt(), psi, and LagrangianModels::sourceProxy().

Here is the call graph for this function:

◆ carrierEqn() [7/8]

const Foam::CarrierEqn<Type>& carrierEqn ( const word & key ) const

Definition at line 120 of file coupledTemplates.C.

◆ carrierEqns() [3/4]

const Foam::HashTable<const Foam::CarrierEqn<Type>*> carrierEqns ( const word & key ) const

Definition at line 128 of file coupledTemplates.C.

References forAllConstIter, IOobject::group(), and IOobject::member().

Here is the call graph for this function:

◆ carrierEqn() [8/8]

const Foam::CarrierEqn<Type>& carrierEqn ( const VolField< Type > & psi ) const

Definition at line 160 of file coupledTemplates.C.

References psi.

◆ carrierEqns() [4/4]

const Foam::HashTable<const Foam::CarrierEqn<Type>*> carrierEqns ( const VolField< Type > & psi ) const

Definition at line 168 of file coupledTemplates.C.

References psi.

Member Data Documentation

◆ nuc

const CloudDerivedField<scalar>& nuc

Carrier kinematic viscosity.

Definition at line 156 of file coupled.H.

Referenced by coupledToFluid::coupledToFluid(), and sphericalCoupled::sphericalCoupled().

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

src/Lagrangian/cloud/clouds/coupled/coupled.H
src/Lagrangian/cloud/clouds/coupled/coupled.C
src/Lagrangian/cloud/clouds/coupled/coupledTemplates.C

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ coupled()

◆ ~coupled()

Member Function Documentation

◆ updateCarrier()

◆ carrierEqn() [1/8]

◆ carrierEqn() [2/8]

◆ clearCarrierEqns()

◆ initPsicDdt()

◆ psicEqn() [1/3]

◆ psicEqn() [2/3]

◆ TypeName()

◆ hasCarrierEqns()

◆ hasCarrierEqn() [1/2]

◆ carrierEqn() [3/8]

◆ carrierEqns() [1/4]

◆ hasCarrierEqn() [2/2]

◆ carrierEqn() [4/8]

◆ carrierEqns() [2/4]

◆ carrierEqn() [5/8]

◆ carrierEqn() [6/8]

◆ psicEqn() [3/3]

◆ carrierEqn() [7/8]

◆ carrierEqns() [3/4]

◆ carrierEqn() [8/8]

◆ carrierEqns() [4/4]

Member Data Documentation

◆ nuc