Public Types | Public Member Functions | List of all members
Basic< Type > Class Template Reference

Basic lagrangian averaging procedure. More...

Inheritance diagram for Basic< Type >:
Inheritance graph
[legend]
Collaboration diagram for Basic< Type >:
Collaboration graph
[legend]

Public Types

typedef AveragingMethod< Type >::TypeGrad TypeGrad
 

Public Member Functions

 TypeName ("basic")
 
 Basic (const IOobject &io, const dictionary &dict, const fvMesh &mesh)
 
 Basic (const Basic< Type > &am)
 
virtual autoPtr< AveragingMethod< Type > > clone () const
 
virtual ~Basic ()
 
void add (const barycentric &coordinates, const tetIndices &tetIs, const Type &value)
 
Type interpolate (const barycentric &coordinates, const tetIndices &tetIs) const
 
TypeGrad interpolateGrad (const barycentric &coordinates, const tetIndices &tetIs) const
 
tmp< Field< Type > > primitiveField () const
 
tmp< Field< TypeGrad > > internalFieldGrad () const
 
- Public Member Functions inherited from AveragingMethod< Type >
 TypeName ("averagingMethod")
 
 declareRunTimeSelectionTable (autoPtr, AveragingMethod, dictionary,(const IOobject &io, const dictionary &dict, const fvMesh &mesh),(io, dict, mesh))
 
 AveragingMethod (const IOobject &io, const dictionary &dict, const fvMesh &mesh, const labelList &size)
 
 AveragingMethod (const AveragingMethod< Type > &am)
 
virtual autoPtr< AveragingMethod< Type > > clone () const=0
 
virtual ~AveragingMethod ()=default
 
virtual void average ()
 
virtual void average (const AveragingMethod< scalar > &weight)
 
virtual bool writeData (Ostream &) const
 
virtual bool write (const bool valid=true) const
 
virtual tmp< Field< Type > > primitiveField () const=0
 
void operator= (const AveragingMethod< Type > &x)
 
void operator= (const Type &x)
 
void operator= (tmp< FieldField< Field, Type >> x)
 
void operator+= (tmp< FieldField< Field, Type >> x)
 
void operator*= (tmp< FieldField< Field, Type >> x)
 
void operator/= (tmp< FieldField< Field, scalar >> x)
 

Additional Inherited Members

- Static Public Member Functions inherited from AveragingMethod< Type >
static autoPtr< AveragingMethod< Type > > New (const IOobject &io, const dictionary &dict, const fvMesh &mesh)
 
- Protected Types inherited from AveragingMethod< Type >
typedef outerProduct< vector, Type >::type TypeGrad
 
- Protected Attributes inherited from AveragingMethod< Type >
const dictionarydict_
 
const fvMeshmesh_
 

Detailed Description

template<class Type>
class Foam::AveragingMethods::Basic< Type >

Basic lagrangian averaging procedure.

This is a cell-volume based average. Point values are summed over the computational cells and the result is divided by the cell volume.

Interpolation is done assuming a constant value over each cells. Cell gradients are calculated by the default fvc::grad scheme, and are also assumed constant when interpolated.

Source files

Definition at line 61 of file Basic.H.

Member Typedef Documentation

◆ TypeGrad

Definition at line 70 of file Basic.H.

Constructor & Destructor Documentation

◆ Basic() [1/2]

Basic ( const IOobject io,
const dictionary dict,
const fvMesh mesh 
)

Definition at line 28 of file Basic.C.

◆ Basic() [2/2]

Basic ( const Basic< Type > &  am)

Definition at line 42 of file Basic.C.

◆ ~Basic()

~Basic
virtual

Definition at line 55 of file Basic.C.

Member Function Documentation

◆ TypeName()

TypeName ( "basic"  )

◆ clone()

virtual autoPtr<AveragingMethod<Type> > clone ( ) const
inlinevirtual

Definition at line 110 of file Basic.H.

◆ add()

void add ( const barycentric coordinates,
const tetIndices tetIs,
const Type &  value 
)
virtual

Implements AveragingMethod< Type >.

Definition at line 88 of file Basic.C.

References tetIndices::cell().

Here is the call graph for this function:

◆ interpolate()

Type interpolate ( const barycentric coordinates,
const tetIndices tetIs 
) const
virtual

Implements AveragingMethod< Type >.

Definition at line 100 of file Basic.C.

References tetIndices::cell().

Here is the call graph for this function:

◆ interpolateGrad()

Foam::AveragingMethods::Basic< Type >::TypeGrad interpolateGrad ( const barycentric coordinates,
const tetIndices tetIs 
) const
virtual

Implements AveragingMethod< Type >.

Definition at line 112 of file Basic.C.

References tetIndices::cell().

Here is the call graph for this function:

◆ primitiveField()

Foam::tmp< Foam::Field< Type > > primitiveField

Definition at line 123 of file Basic.C.

◆ internalFieldGrad()

tmp<Field<TypeGrad> > internalFieldGrad ( ) const

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