cell< Type > Class Template Reference
Inheritance diagram for cell< Type >:
Collaboration diagram for cell< Type >:

Public Member Functions

 TypeName ("cell")
 Runtime type information. More...
 
 cell (const word &name, const LagrangianMesh &mesh, const dimensionSet &dimensions, const Field< scalar > &weightSum)
 Construct with a name, for a mesh and with given dimensions. More...
 
virtual ~cell ()
 Destructor. More...
 
virtual void remove (const LagrangianSubSubField< scalar > &weight, const LagrangianSubSubField< Type > &psi)
 Remove weighted values from the average. More...
 
virtual void add (const LagrangianSubSubField< scalar > &weight, const LagrangianSubSubField< Type > &psi, const bool cache)
 Add weighted values to the average. More...
 
virtual void correct (const LagrangianSubSubField< scalar > &weight, const LagrangianSubSubField< Type > &psi, const bool cache)
 Correct weighted values in the average. More...
 
- Public Member Functions inherited from LagrangianAverage< Type >
 TypeName ("LagrangianAverage")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, LagrangianAverage, dictionary,(const word &name, const LagrangianMesh &mesh, const dimensionSet &dimensions, const Field< scalar > &cellWeightSum),(name, mesh, dimensions, cellWeightSum))
 Declare run-time constructor selection tables. More...
 
 LagrangianAverage (const word &name, const LagrangianMesh &mesh, const dimensionSet &dimensions)
 Construct with a name, for a mesh and with given dimensions. More...
 
virtual ~LagrangianAverage ()
 Destructor. More...
 
void remove (const LagrangianSubSubField< Type > &weightPsi)
 Remove values from the average. More...
 
void add (const LagrangianSubSubField< Type > &weightPsi, const bool cache)
 Add values to the average. More...
 
void correct (const LagrangianSubSubField< Type > &weightPsi, const bool cache)
 Correct values in the average. More...
 
tmp< LagrangianSubField< Type > > interpolate (const LagrangianSubMesh &subMesh) const
 Interpolate to a sub-mesh. More...
 
void operator= (const LagrangianAverage< Type > &)=delete
 Disallow default bitwise assignment. More...
 
template<template< class > class WeightPF, template< class > class PsiPF>
Foam::autoPtr< Foam::LagrangianAverage< Type > > New (const word &type, const word &name, const DimensionedField< scalar, LagrangianMesh, WeightPF > &weight, const DimensionedField< Type, LagrangianMesh, PsiPF > &psi)
 
template<class CellMesh , template< class > class PsiPF>
Foam::LagrangianAverageNewReturnType< CellMesh, Type >::type New (const word &type, const word &name, const DimensionedField< scalar, CellMesh > &cellWeightSum, const DimensionedField< Type, LagrangianMesh, PsiPF > &weightPsi)
 

Additional Inherited Members

- Static Public Member Functions inherited from LagrangianAverage< Type >
template<template< class > class WeightPF, template< class > class PsiPF>
static autoPtr< LagrangianAverage< Type > > New (const word &type, const word &name, const DimensionedField< scalar, LagrangianMesh, WeightPF > &weight, const DimensionedField< Type, LagrangianMesh, PsiPF > &psi)
 Select to average a field. More...
 
template<class CellMesh , template< class > class WeightPsiPF>
static LagrangianAverageNewReturnType< CellMesh, Type >::type New (const word &type, const word &name, const DimensionedField< scalar, CellMesh > &cellWeightSum, const DimensionedField< Type, LagrangianMesh, WeightPsiPF > &weightPsi)
 Select to average a field with a given cell weight sum. More...
 

Detailed Description

template<class Type>
class Foam::LagrangianAverages::cell< Type >

Definition at line 53 of file cell_LagrangianAverage.H.

Constructor & Destructor Documentation

◆ cell()

cell ( const word name,
const LagrangianMesh mesh,
const dimensionSet dimensions,
const Field< scalar > &  weightSum 
)

Construct with a name, for a mesh and with given dimensions.

Definition at line 225 of file cell_LagrangianAverage.C.

◆ ~cell()

~cell
virtual

Destructor.

Definition at line 244 of file cell_LagrangianAverage.C.

Member Function Documentation

◆ TypeName()

TypeName ( "cell< Type >"  )

Runtime type information.

References Foam::add().

Here is the call graph for this function:

◆ remove()

void remove ( const LagrangianSubSubField< scalar > &  weight,
const LagrangianSubSubField< Type > &  psi 
)
virtual

Remove weighted values from the average.

Implements LagrangianAverage< Type >.

Definition at line 251 of file cell_LagrangianAverage.C.

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

Here is the call graph for this function:

◆ add()

void add ( const LagrangianSubSubField< scalar > &  weight,
const LagrangianSubSubField< Type > &  psi,
const bool  cache 
)
virtual

Add weighted values to the average.

Implements LagrangianAverage< Type >.

Definition at line 269 of file cell_LagrangianAverage.C.

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

Here is the call graph for this function:

◆ correct()

void correct ( const LagrangianSubSubField< scalar > &  weight,
const LagrangianSubSubField< Type > &  psi,
const bool  cache 
)
virtual

Correct weighted values in the average.

Implements LagrangianAverage< Type >.

Definition at line 290 of file cell_LagrangianAverage.C.

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

Here is the call graph for this function:

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