CarrierFieldBase< Type > Class Template Reference

Inheritance diagram for CarrierFieldBase< Type >:

Collaboration diagram for CarrierFieldBase< Type >:

Classes
class	Function
	Class to store an evaluation function. More...
class	Functor

Public Member Functions
	CarrierFieldBase (const VolField< Type > &)
	Construct from a reference to a carrier field. More...
	CarrierFieldBase (const word &name, const VolField< Type > &)
	Construct from a name and a reference to a carrier field. More...
template<class F >
	CarrierFieldBase (const word &name, const F &f)
	Construct from a name and an evaluation function. More...
const VolField< Type > &	psi () const
	Access the carrier field. More...
void	reset (const bool initial)
	Reset. More...
Public Member Functions inherited from CloudDerivedField< Type >
template<class F >
	CloudDerivedField (const word &name, const F &f)
	Construct from a name and a function. More...
template<class F >
	CloudDerivedField (const F &f)
	Construct from a function. More...
template<class C >
	CloudDerivedField (const word &name, const C &c, tmp< LagrangianSubField< Type >>(C::*m)(const LagrangianModelRef &, const LagrangianSubMesh &) const)
	Construct from a name, class and a method. More...
template<class C >
	CloudDerivedField (const C &c, tmp< LagrangianSubField< Type >>(C::*m)(const LagrangianModelRef &, const LagrangianSubMesh &) const)
	Construct from a class and a method. More...
	CloudDerivedField (const CloudDerivedField &)=delete
	Disallow default bitwise copy construction. More...
const word &	name () const
	Field name. More...
tmp< LagrangianInternalField< Type > >	field (const LagrangianMesh &mesh) const
	Compute and return an independent copy of the entire field. More...
LagrangianSubSubField< Type > &	ref (const LagrangianSubMesh &) const
	Access a part of the field. More...
void	clear (const bool final)
	Clear. More...
tmp< LagrangianInternalField< Type > >	operator() (const LagrangianMesh &mesh) const
	Compute and return the entire field. This will be a slice of the. More...
const LagrangianSubField< Type > &	operator() (const LagrangianSubMesh &subMesh) const
	Compute and access a part of the field. More...
const LagrangianSubField< Type > &	operator() (const LagrangianModelRef &model, const LagrangianSubMesh &subMesh) const
	Compute and access a part of the field associated with a model. More...
void	operator= (const CloudDerivedField &)=delete
	Disallow default bitwise assignment. More...

Protected Member Functions
bool	useOldTime (const LagrangianMesh &) const
	Return whether or not to interpolate in time as well as space. More...
const interpolation< Type > &	psiInterpolation (const LagrangianMesh &) const
	Return the interpolation engine. More...
const interpolation< Type > &	psi0Interpolation (const LagrangianMesh &) const
	Return the old-time interpolation engine. More...

Additional Inherited Members
Protected Attributes inherited from CloudDerivedField< Type >
const word	name_
	The name. May be word::null, in which case the name is. More...

Detailed Description

template<class Type>
class Foam::CarrierFieldBase< Type >

Definition at line 54 of file CarrierField.H.

Constructor & Destructor Documentation

CarrierFieldBase() [1/3]

CarrierFieldBase

(

const VolField< Type > &

psi

)

Construct from a reference to a carrier field.

Definition at line 306 of file CarrierField.C.

CarrierFieldBase() [2/3]

CarrierFieldBase	(	const word &	name,
		const VolField< Type > &	psi
	)

Construct from a name and a reference to a carrier field.

Definition at line 322 of file CarrierField.C.

CarrierFieldBase() [3/3]

CarrierFieldBase	(	const word &	name,
		const F &	f
	)

Construct from a name and an evaluation function.

Definition at line 338 of file CarrierField.C.

Member Function Documentation

useOldTime()

bool useOldTime ( const LagrangianMesh &  mesh ) const

protected

Return whether or not to interpolate in time as well as space.

Definition at line 251 of file CarrierField.C.

References objectRegistry::foundObject(), mesh, and psi.

Here is the call graph for this function:

psiInterpolation()

const Foam::interpolation< Type > & psiInterpolation ( const LagrangianMesh &  mesh ) const

protected

Return the interpolation engine.

Definition at line 264 of file CarrierField.C.

References fvSchemes::interpolation(), mesh, Foam::New(), psi, and fvMesh::schemes().

Here is the call graph for this function:

psi0Interpolation()

const Foam::interpolation< Type > & psi0Interpolation ( const LagrangianMesh &  mesh ) const

protected

Return the old-time interpolation engine.

Definition at line 284 of file CarrierField.C.

References fvSchemes::interpolation(), mesh, Foam::New(), psi, and fvMesh::schemes().

Here is the call graph for this function:

psi()

const Foam::VolField< Type > & psi

Access the carrier field.

Definition at line 360 of file CarrierField.C.

reset()

void reset

(

const bool

initial

)

Reset.

Definition at line 372 of file CarrierField.C.

References CloudDerivedField< Type >::clear().

Referenced by CarrierFieldGradBase< Type >::reset().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/Lagrangian/cloud/clouds/carried/CarrierField.H
• src/Lagrangian/cloud/clouds/carried/CarrierField.C