Base class for lagrangian averaging methods. More...

Inheritance diagram for AveragingMethod:

[legend]

Collaboration diagram for AveragingMethod:

Public Member Functions
	TypeName ("averagingMethod")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, AveragingMethod, dictionary,(const IOobject &io, const dictionary &dict, const fvMesh &mesh),(io, dict, mesh))
	Declare runtime constructor selection table. More...

	AveragingMethod (const IOobject &io, const dictionary &dict, const fvMesh &mesh, const labelList &size)
	Constructors. More...

	AveragingMethod (const AveragingMethod< Type > &am)
	Construct a copy. More...

virtual autoPtr< AveragingMethod< Type > >	clone () const =0
	Construct and return a clone. More...

virtual	~AveragingMethod ()
	Destructor. More...

virtual void	add (const point position, const tetIndices &tetIs, const Type &value)=0
	Member Functions. More...

virtual Type	interpolate (const point position, const tetIndices &tetIs) const =0
	Interpolate. More...

virtual TypeGrad	interpolateGrad (const point position, const tetIndices &tetIs) const =0
	Interpolate gradient. More...

virtual void	average ()
	Calculate the average. More...

virtual void	average (const AveragingMethod< scalar > &weight)

virtual bool	writeData (Ostream &) const
	Dummy write. More...

virtual bool	write () const
	Write using setting from DB. More...

virtual tmp< Field< Type > >	internalField () const =0
	Return an internal field of the average. More...

void	operator= (const AveragingMethod< Type > &x)
	Assign to another average. More...

void	operator= (const Type &x)
	Assign to value. More...

void	operator= (tmp< FieldField< Field, Type > > x)
	Assign to tmp. More...

void	operator+= (tmp< FieldField< Field, Type > > x)
	Add-equal tmp. More...

void	operator*= (tmp< FieldField< Field, Type > > x)
	Multiply-equal tmp. More...

void	operator/= (tmp< FieldField< Field, scalar > > x)
	Divide-equal tmp. More...

Static Public Member Functions
static autoPtr< AveragingMethod< Type > >	New (const IOobject &io, const dictionary &dict, const fvMesh &mesh)
	Selector. More...

Protected Types
typedef outerProduct< vector, Type >::type	TypeGrad
	Protected typedefs. More...

Protected Member Functions
virtual void	updateGrad ()
	Protected member functions. More...

Protected Attributes
const dictionary &	dict_
	Protected data. More...

const fvMesh &	mesh_
	The mesh on which the averaging is to be done. More...

Detailed Description

Base class for lagrangian averaging methods.

Source files

Definition at line 55 of file MPPICParcel.H.

Member Typedef Documentation

◆ TypeGrad

typedef outerProduct<vector, Type>::type TypeGrad

protected

Protected typedefs.

Gradient type

Definition at line 62 of file AveragingMethod.H.

Constructor & Destructor Documentation

◆ AveragingMethod() [1/2]

AveragingMethod	(	const IOobject &	io,
		const dictionary &	dict,
		const fvMesh &	mesh,
		const labelList &	size
	)

Constructors.

Construct from components

Definition at line 34 of file AveragingMethod.C.

◆ AveragingMethod() [2/2]

AveragingMethod ( const AveragingMethod< Type > & am )

Construct a copy.

Definition at line 58 of file AveragingMethod.C.

◆ ~AveragingMethod()

~AveragingMethod ( )

virtual

Destructor.

Definition at line 105 of file AveragingMethod.C.

Member Function Documentation

◆ updateGrad()

void updateGrad ( )

protectedvirtual

Protected member functions.

Update the gradient calculation

Reimplemented in Moment< Type >, and Basic< Type >.

Definition at line 112 of file AveragingMethod.C.

◆ TypeName()

TypeName ( "averagingMethod" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		AveragingMethod	,
		dictionary	,
		(const IOobject &io, const dictionary &dict, const fvMesh &mesh)	,
		(io, dict, mesh)
	)

Declare runtime constructor selection table.

◆ clone()

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

pure virtual

Construct and return a clone.

◆ New()

Foam::autoPtr< Foam::AveragingMethod< Type > > New	(	const IOobject &	io,
		const dictionary &	dict,
		const fvMesh &	mesh
	)

static

Selector.

Definition at line 74 of file AveragingMethod.C.

◆ add()

virtual void add	(	const point	position,
		const tetIndices &	tetIs,
		const Type &	value
	)

pure virtual

Member Functions.

Add point value to interpolation

Implemented in Dual< Type >, Moment< Type >, and Basic< Type >.

Referenced by Stochastic< CloudType >::calculate(), and MPPICParcel::TrackingData< CloudType >::updateAverages().

Here is the caller graph for this function:

◆ interpolate()

virtual Type interpolate	(	const point	position,
		const tetIndices &	tetIs
	)		const

pure virtual

Interpolate.

Implemented in Dual< Type >, Moment< Type >, and Basic< Type >.

Referenced by Stochastic< CloudType >::calculate().

Here is the caller graph for this function:

◆ interpolateGrad()

virtual TypeGrad interpolateGrad	(	const point	position,
		const tetIndices &	tetIs
	)		const

pure virtual

Interpolate gradient.

Implemented in Dual< Type >, Moment< Type >, and Basic< Type >.

◆ average() [1/2]

void average ( )

virtual

Calculate the average.

Reimplemented in Dual< Type >.

Definition at line 121 of file AveragingMethod.C.

Referenced by Stochastic< CloudType >::calculate(), and MPPICParcel::TrackingData< CloudType >::updateAverages().

Here is the caller graph for this function:

◆ average() [2/2]

void average ( const AveragingMethod< scalar > & weight )

virtual

Reimplemented in Dual< Type >.

Definition at line 129 of file AveragingMethod.C.

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Dummy write.

Definition at line 140 of file AveragingMethod.C.

◆ write()

bool write ( ) const

virtual

Write using setting from DB.

Definition at line 147 of file AveragingMethod.C.

◆ internalField()

virtual tmp<Field<Type> > internalField ( ) const

pure virtual

Return an internal field of the average.

Referenced by Implicit< CloudType >::cacheFields().

Here is the caller graph for this function:

◆ operator=() [1/3]

void operator= ( const AveragingMethod< Type > & x )

inline

Assign to another average.

Definition at line 30 of file AveragingMethodI.H.

◆ operator=() [2/3]

void operator= ( const Type & x )

inline

Assign to value.

Definition at line 41 of file AveragingMethodI.H.

◆ operator=() [3/3]

void operator= ( tmp< FieldField< Field, Type > > x )

inline

Assign to tmp.

Definition at line 52 of file AveragingMethodI.H.

◆ operator+=()

void operator+= ( tmp< FieldField< Field, Type > > x )

inline

Add-equal tmp.

Definition at line 63 of file AveragingMethodI.H.

◆ operator*=()

void operator*= ( tmp< FieldField< Field, Type > > x )

inline

Multiply-equal tmp.

Definition at line 74 of file AveragingMethodI.H.

◆ operator/=()

void operator/= ( tmp< FieldField< Field, scalar > > x )

inline

Divide-equal tmp.

Definition at line 85 of file AveragingMethodI.H.

Field Documentation

◆ dict_

const dictionary& dict_

protected

Protected data.

Dictionary

Definition at line 68 of file AveragingMethod.H.

◆ mesh_

const fvMesh& mesh_

protected

The mesh on which the averaging is to be done.

Definition at line 71 of file AveragingMethod.H.

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

src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcel.H
src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethod.H
src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethod.C
src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethodI.H

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ TypeGrad

Constructor & Destructor Documentation

◆ AveragingMethod() [1/2]

◆ AveragingMethod() [2/2]

◆ ~AveragingMethod()

Member Function Documentation

◆ updateGrad()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ add()

◆ interpolate()

◆ interpolateGrad()

◆ average() [1/2]

◆ average() [2/2]

◆ writeData()

◆ write()

◆ internalField()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator+=()

◆ operator*=()

◆ operator/=()

Field Documentation

◆ dict_

◆ mesh_