CarrierField< Type > Class Template Reference

A field interpolated from the carrier to the cloud. Uses CloudDerivedField to provide flexible access and caching. More...

Inheritance diagram for CarrierField< Type >:
Collaboration diagram for CarrierField< Type >:

Classes

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

Public Member Functions

 CarrierField (const VolField< Type > &)
 Construct from a reference to a carrier field. More...
 
template<class F >
 CarrierField (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...
 
const wordname () const
 Carrier field name. More...
 
void reset (const bool predict)
 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...
 
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...
 

Detailed Description

template<class Type>
class Foam::CarrierField< Type >

A field interpolated from the carrier to the cloud. Uses CloudDerivedField to provide flexible access and caching.

See also
Foam::CloudDerivedField
Source files

Definition at line 54 of file CarrierField.H.

Constructor & Destructor Documentation

◆ CarrierField() [1/2]

CarrierField ( const VolField< Type > &  psi)

Construct from a reference to a carrier field.

Definition at line 216 of file CarrierField.C.

◆ CarrierField() [2/2]

CarrierField ( const word name,
const F &  f 
)

Construct from a name and an evaluation function.

Definition at line 229 of file CarrierField.C.

Member Function Documentation

◆ psi()

const Foam::VolField< Type > & psi

Access the carrier field.

Definition at line 243 of file CarrierField.C.

Referenced by coupled::carrierEqn().

Here is the caller graph for this function:

◆ name()

const Foam::word & name

Carrier field name.

Definition at line 255 of file CarrierField.C.

Referenced by coupled::carrierField().

Here is the caller graph for this function:

◆ reset()

void reset ( const bool  predict)

Reset.

Definition at line 262 of file CarrierField.C.

References CloudDerivedField< Type >::clear().

Here is the call graph for this function:

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