Base class for clouds which are carried by a fluid. More...

Inheritance diagram for carried:

[legend]

Collaboration diagram for carried:

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

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

virtual	~carried ()
	Destructor. More...

const word &	carrierPhaseName () const
	Return the name of the carrier phase. More...

const word &	phaseName (const bool strict=true) const
	Return the name of the corresponding Eulerian phase. More...

bool	hasPhase () const
	Return whether this cloud has a corresponding Eulerian phase. More...

const word	carrierPhaseFieldName (const word &name)
	Construct the name of a field associated with the carrier. I.e.,. More...

const word	phaseFieldName (const word &name)
	Construct the name of a field associated with the carrier. I.e.,. More...

template<class Type >
const CarrierField< Type > &	carrierField (const VolField< Type > &) const
	Add/get a carrier field to/from the cache. More...

template<class Type , class ... Args>
const CarrierField< Type > &	carrierField (const Args &... args) const
	Add/get a carrier field to/from the cache. More...

template<class Type >
const CarrierField< Type > &	noCarrierField (const word &symbolicName, const word &descriptiveName, const bool isPhase) const
	Generate a carrier field reference using a functor that raises. More...

template<class Type >
const Foam::CarrierField< Type > &	carrierField (const VolField< Type > &psi) const

template<class Type , class ... Args>
const Foam::CarrierField< Type > &	carrierField (const Args &... args) const

template<class Type >
const Foam::CarrierField< Type > &	noCarrierField (const word &symbolicName, const word &descriptiveName, const bool isPhase) const

Static Public Member Functions
static word	nameToCarrierName (const word &name)
	Convert a name to its disambiguated carrier equivalent name. I.e.,. More...

static word	nameToCarrierName (const word &name, const word &group)
	Convert a name to its disambiguated carrier equivalent name. I.e.,. More...

static word	carrierNameToName (const word &namec)
	Convert a disambiguated carrier name to its equivalent name. I.e.,. More...

Public Attributes
const CarrierField< vector > &	Uc
	Carrier velocity. More...

const CarrierField< vector > &	curlUc
	Carrier velocity curl. More...

const CarrierField< vector > &	DUDtc
	Carrier advective derivative. More...

const CarrierField< vector > &	UcPhase
	Corresponding Eulerian phase velocity. More...

Protected Member Functions
void	clearCarrierFields ()
	Clear the carrier fields. More...

void	resetCarrierFields (const bool initial)
	Reset the carrier fields. More...

Detailed Description

Base class for clouds which are carried by a fluid.

Source files

Definition at line 56 of file carried.H.

Constructor & Destructor Documentation

◆ carried()

carried	(	const cloud &	c,
		const dictionary &	dict
	)

Construct from a reference to the cloud.

Definition at line 151 of file carried.C.

References Foam::fvc::curl(), and carried::Uc.

Here is the call graph for this function:

◆ ~carried()

~carried ( )

virtual

Destructor.

Definition at line 236 of file carried.C.

Member Function Documentation

◆ clearCarrierFields()

void clearCarrierFields ( )

protected

Clear the carrier fields.

Definition at line 115 of file carried.C.

References CLEAR_TYPE_CARRIER_FIELDS, and Foam::FOR_ALL_FIELD_TYPES().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetCarrierFields()

void resetCarrierFields ( const bool initial )

protected

Reset the carrier fields.

Definition at line 132 of file carried.C.

References Foam::FOR_ALL_FIELD_TYPES(), and RESET_TYPE_CARRIER_FIELDS.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "carried" )

Run-time type information.

◆ carrierPhaseName()

const Foam::word & carrierPhaseName ( ) const

Return the name of the carrier phase.

Definition at line 242 of file carried.C.

◆ phaseName()

const Foam::word & phaseName ( const bool strict = true ) const

Return the name of the corresponding Eulerian phase.

Definition at line 248 of file carried.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ hasPhase()

bool hasPhase ( ) const

Return whether this cloud has a corresponding Eulerian phase.

Definition at line 267 of file carried.C.

References word::null.

◆ nameToCarrierName() [1/2]

Foam::word nameToCarrierName ( const word & name )

static

Convert a name to its disambiguated carrier equivalent name. I.e.,.

add a 'c' suffix to the member.

Definition at line 273 of file carried.C.

References IOobject::group(), IOobject::groupName(), IOobject::member(), and Foam::name().

Referenced by cloud::addsSupToField(), and totalPressureVelocityMagnitudeLagrangianScalarFieldSource::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nameToCarrierName() [2/2]

Foam::word nameToCarrierName	(	const word &	name,
		const word &	group
	)

static

Convert a name to its disambiguated carrier equivalent name. I.e.,.

add a 'c' suffix to the member.

Definition at line 284 of file carried.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::group(), Foam::constant::atomic::group, IOobject::groupName(), Foam::name(), and word::null.

Here is the call graph for this function:

◆ carrierNameToName()

Foam::word carrierNameToName ( const word & namec )

static

Convert a disambiguated carrier name to its equivalent name. I.e.,.

remove the 'c' suffix from the member.

Definition at line 307 of file carried.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::group(), IOobject::groupName(), and IOobject::member().

Referenced by coupled::carrierEqn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ carrierPhaseFieldName()

const word carrierPhaseFieldName ( const word & name )

Construct the name of a field associated with the carrier. I.e.,.

add a 'c' suffix and add the carrier phase group

◆ phaseFieldName()

const word phaseFieldName ( const word & name )

Construct the name of a field associated with the carrier. I.e.,.

add a 'c' suffix and add the corresponding Eulerian phase group

◆ carrierField() [1/4]

const CarrierField<Type>& carrierField ( const VolField< Type > & ) const

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

◆ carrierField() [2/4]

const CarrierField<Type>& carrierField ( const Args &... args ) const

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

◆ noCarrierField() [1/2]

const CarrierField<Type>& noCarrierField	(	const word &	symbolicName,
		const word &	descriptiveName,
		const bool	isPhase
	)		const

Generate a carrier field reference using a functor that raises.

an error to say that the field is not available

◆ carrierField() [3/4]

const Foam::CarrierField<Type>& carrierField ( const VolField< Type > & psi ) const

Definition at line 32 of file carriedTemplates.C.

References psi.

◆ carrierField() [4/4]

const Foam::CarrierField<Type>& carrierField ( const Args &... args ) const

Definition at line 42 of file carriedTemplates.C.

References args, HashTable< T, Key, Hash >::find(), and Foam::name().

Here is the call graph for this function:

◆ noCarrierField() [2/2]

const Foam::CarrierField<Type>& noCarrierField	(	const word &	symbolicName,
		const word &	descriptiveName,
		const bool	isPhase
	)		const

Definition at line 60 of file carriedTemplates.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

Member Data Documentation

◆ Uc

const CarrierField<vector>& Uc

Carrier velocity.

Definition at line 114 of file carried.H.

Referenced by carried::carried(), coupled::carrierEqn(), tracer::dUdt(), and sphericalCoupled::sphericalCoupled().

◆ curlUc

const CarrierField<vector>& curlUc

Carrier velocity curl.

Definition at line 117 of file carried.H.

◆ DUDtc

const CarrierField<vector>& DUDtc

Carrier advective derivative.

Definition at line 123 of file carried.H.

◆ UcPhase

const CarrierField<vector>& UcPhase

Corresponding Eulerian phase velocity.

Definition at line 126 of file carried.H.

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

src/Lagrangian/cloud/clouds/carried/carried.H
src/Lagrangian/cloud/clouds/carried/carried.C
src/Lagrangian/cloud/clouds/carried/carriedTemplates.C

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ carried()

◆ ~carried()

Member Function Documentation

◆ clearCarrierFields()

◆ resetCarrierFields()

◆ TypeName()

◆ carrierPhaseName()

◆ phaseName()

◆ hasPhase()

◆ nameToCarrierName() [1/2]

◆ nameToCarrierName() [2/2]

◆ carrierNameToName()

◆ carrierPhaseFieldName()

◆ phaseFieldName()

◆ carrierField() [1/4]

◆ carrierField() [2/4]

◆ noCarrierField() [1/2]

◆ carrierField() [3/4]

◆ carrierField() [4/4]

◆ noCarrierField() [2/2]

Member Data Documentation

◆ Uc

◆ curlUc

◆ DUDtc

◆ UcPhase