CloudStateFieldRef< Type > Class Template Reference

Wrapper for a reference to a dynamic Lagrangian field. It provides convenient access consistent with that of the derived fields so that expressions involving both kinds of field are readable. It also ensures that old-time fields are maintained for a sub-mesh for the duration of the inner correction iterations. More...

Inheritance diagram for CloudStateFieldRef< Type >:

Public Member Functions
	CloudStateFieldRef (LagrangianDynamicField< Type > &)
	Construct from a field reference. More...
const word &	name () const
	Access the field's name. More...
const LagrangianMesh &	mesh () const
	Access the field's mesh. More...
const dimensionSet &	dimensions () const
	Access the field's dimensions. More...
const LagrangianSubSubField< Type > &	ref (const LagrangianSubMesh &) const
	Access a part of the field. More...
LagrangianSubSubField< Type > &	ref (const LagrangianSubMesh &)
	Access a part of the field. More...
	operator const LagrangianDynamicField< Type > & () const
	Cast to the field. More...
	operator LagrangianDynamicField< Type > & ()
	Cast to the field. More...
const LagrangianDynamicField< Type > &	operator() (const LagrangianMesh &) const
	Access the entire field. More...
const LagrangianSubSubField< Type > &	operator() (const LagrangianSubMesh &subMesh) const
	Access a part of the field. More...
tmp< LagrangianSubSubField< Type > >	operator() (const LagrangianModelRef &model, const LagrangianSubMesh &subMesh) const
	Compute and return part of the field associated with a model. More...

Detailed Description

template<class Type>
class Foam::CloudStateFieldRef< Type >

Wrapper for a reference to a dynamic Lagrangian field. It provides convenient access consistent with that of the derived fields so that expressions involving both kinds of field are readable. It also ensures that old-time fields are maintained for a sub-mesh for the duration of the inner correction iterations.

See also

Foam::CloudStateField Foam::CloudDerivedField

Source files

• CloudStateFieldRef.H
• CloudStateFieldRef.C

Definition at line 58 of file CloudStateFieldRef.H.

Constructor & Destructor Documentation

CloudStateFieldRef()

CloudStateFieldRef

(

LagrangianDynamicField< Type > &

ref

)

Construct from a field reference.

Definition at line 32 of file CloudStateFieldRef.C.

Member Function Documentation

name()

const Foam::word & name

Access the field's name.

Definition at line 45 of file CloudStateFieldRef.C.

mesh()

const Foam::LagrangianMesh & mesh

Access the field's mesh.

Definition at line 52 of file CloudStateFieldRef.C.

dimensions()

const Foam::dimensionSet & dimensions

Access the field's dimensions.

Definition at line 59 of file CloudStateFieldRef.C.

ref() [1/2]

const Foam::LagrangianSubSubField< Type > & ref

(

const LagrangianSubMesh &

subMesh

)

const

Access a part of the field.

Definition at line 66 of file CloudStateFieldRef.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, LagrangianSubMesh::index(), LagrangianSubMesh::mesh(), and LagrangianMesh::subAll().

Here is the call graph for this function:

ref() [2/2]

Foam::LagrangianSubSubField< Type > & ref

(

const LagrangianSubMesh &

subMesh

)

Access a part of the field.

Definition at line 92 of file CloudStateFieldRef.C.

operator const LagrangianDynamicField< Type > &()

operator const LagrangianDynamicField< Type > &

(

)

const

Cast to the field.

operator LagrangianDynamicField< Type > &()

operator LagrangianDynamicField< Type > &

Cast to the field.

Definition at line 115 of file CloudStateFieldRef.C.

operator()() [1/3]

const Foam::LagrangianDynamicField< Type > & operator()

(

const LagrangianMesh &

)

const

Access the entire field.

Definition at line 124 of file CloudStateFieldRef.C.

operator()() [2/3]

const Foam::LagrangianSubSubField< Type > & operator()

(

const LagrangianSubMesh &

subMesh

)

const

Access a part of the field.

Definition at line 132 of file CloudStateFieldRef.C.

References LagrangianSubMesh::index(), LagrangianSubMesh::mesh(), LagrangianSubMesh::sub(), and LagrangianMesh::subAll().

Here is the call graph for this function:

operator()() [3/3]

Foam::tmp< Foam::LagrangianSubSubField< Type > > operator()	(	const LagrangianModelRef &	model,
		const LagrangianSubMesh &	subMesh
	)		const

Compute and return part of the field associated with a model.

Definition at line 159 of file CloudStateFieldRef.C.

References LagrangianModelRef::injection(), LagrangianModelRef::isInjection(), LagrangianModelRef::isSource(), LagrangianModel::name(), LagrangianModelRef::source(), and Foam::toSubField().

Here is the call graph for this function:

---

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

• src/Lagrangian/cloud/fields/CloudStateField/CloudStateFieldRef.H
• src/Lagrangian/cloud/fields/CloudStateField/CloudStateFieldRef.C