CloudAverageField< Type > Class Template Reference

A cloud field that is averaged and then interpolated back to the cloud. Uses CloudDerivedField to provide flexible access and caching. More...

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

Public Member Functions

 CloudAverageField (const word &name, const DimensionedField< scalar, volMesh > &cellWeightSum, const CloudDerivedField< Type > &weightPsi)
 Construct from a name, a cell weight sum and a derived field. More...
 
void remove (const LagrangianSubMesh &subMesh)
 Remove this sub-mesh from the average. More...
 
void add (const LagrangianSubMesh &subMesh, const bool cache)
 Add this sub-mesh to the average. More...
 
void correct (const LagrangianSubMesh &subMesh, const bool cache)
 Correct the average with values from the sub-mesh. More...
 
void reset ()
 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::CloudAverageField< Type >

A cloud field that is averaged and then interpolated back to the cloud. Uses CloudDerivedField to provide flexible access and caching.

See also
Foam::CloudDerivedField
Source files

Definition at line 57 of file CloudAverageField.H.

Constructor & Destructor Documentation

◆ CloudAverageField()

CloudAverageField ( const word name,
const DimensionedField< scalar, volMesh > &  cellWeightSum,
const CloudDerivedField< Type > &  weightPsi 
)

Construct from a name, a cell weight sum and a derived field.

Definition at line 208 of file CloudAverageField.C.

References Foam::complete.

Member Function Documentation

◆ remove()

void remove ( const LagrangianSubMesh subMesh)

Remove this sub-mesh from the average.

Definition at line 230 of file CloudAverageField.C.

References CloudDerivedField< Type >::clear().

Here is the call graph for this function:

◆ add()

void add ( const LagrangianSubMesh subMesh,
const bool  cache 
)

Add this sub-mesh to the average.

Definition at line 254 of file CloudAverageField.C.

References CloudDerivedField< Type >::clear().

Here is the call graph for this function:

◆ correct()

void correct ( const LagrangianSubMesh subMesh,
const bool  cache 
)

Correct the average with values from the sub-mesh.

Definition at line 285 of file CloudAverageField.C.

References CloudDerivedField< Type >::clear().

Here is the call graph for this function:

◆ reset()

void reset

Reset.

Definition at line 316 of file CloudAverageField.C.

References CloudDerivedField< Type >::clear().

Here is the call graph for this function:

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