LESfilter Class Reference

Abstract class for LES filters. More...

#include <LESfilter.H>

Inheritance diagram for LESfilter:

Public Member Functions
	TypeName ("LESfilter")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, LESfilter, dictionary,(const fvMesh &mesh, const dictionary &LESfilterDict),(mesh, LESfilterDict))
	LESfilter (const fvMesh &mesh)
	Construct from components.
virtual	~LESfilter ()=default
	Destructor.
const fvMesh &	mesh () const
	Return mesh reference.
virtual void	read (const dictionary &)=0
	Read the LESfilter dictionary.
virtual tmp< volScalarField >	operator() (const tmp< volScalarField > &) const =0
virtual tmp< volVectorField >	operator() (const tmp< volVectorField > &) const =0
virtual tmp< volSymmTensorField >	operator() (const tmp< volSymmTensorField > &) const =0
virtual tmp< volTensorField >	operator() (const tmp< volTensorField > &) const =0

Static Public Member Functions
static autoPtr< LESfilter >	New (const fvMesh &, const dictionary &, const word &filterDictName="filter")
	Return a reference to the selected LES filter.

Protected Member Functions
template<class GeoFieldType>
void	correctBoundaryConditions (const tmp< GeoFieldType > &tgf) const
	Temporary function to ensure the coupled boundary conditions of the.

Detailed Description

Abstract class for LES filters.

Source files

• LESfilter.H
• LESfilter.C
• newFilter.C

Definition at line 53 of file LESfilter.H.

Constructor & Destructor Documentation

LESfilter()

LESfilter ( const fvMesh & mesh )

inline

Construct from components.

Definition at line 121 of file LESfilter.H.

References mesh().

Here is the call graph for this function:

~LESfilter()

virtual ~LESfilter ( )

virtualdefault

Destructor.

Member Function Documentation

correctBoundaryConditions()

template<class GeoFieldType>

void correctBoundaryConditions ( const tmp< GeoFieldType > & tgf ) const

inlineprotected

Temporary function to ensure the coupled boundary conditions of the.

field are correct for filtering.

Following the rewrite of the turbulence models to use GeometricField::InternalField for sources etc. delta() will return a GeometricField::InternalField and filters will take a tmp<GeometricField::InternalField> argument and handle the coupled BCs appropriately

Definition at line 87 of file LESfilter.H.

References tmp< T >::constCast().

Here is the call graph for this function:

TypeName()

TypeName

(

"LESfilter"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		LESfilter	,
		dictionary	,
		(const fvMesh &mesh, const dictionary &LESfilterDict)	,
		(mesh, LESfilterDict)	)

References mesh().

Here is the call graph for this function:

New()

Foam::autoPtr< Foam::LESfilter > New ( const fvMesh & mesh, const dictionary & dict, const word & filterDictName = "filter" )

static

Return a reference to the selected LES filter.

Definition at line 36 of file LESfilter.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and mesh().

Here is the call graph for this function:

mesh()

const fvMesh & mesh ( ) const

inline

Return mesh reference.

Definition at line 151 of file LESfilter.H.

Referenced by anisotropicFilter::anisotropicFilter(), anisotropicFilter::anisotropicFilter(), declareRunTimeSelectionTable(), laplaceFilter::laplaceFilter(), laplaceFilter::laplaceFilter(), LESfilter(), New(), simpleFilter::simpleFilter(), simpleFilter::simpleFilter(), anisotropicFilter::TypeName(), laplaceFilter::TypeName(), and simpleFilter::TypeName().

Here is the caller graph for this function:

read()

virtual void read ( const dictionary & )

pure virtual

Read the LESfilter dictionary.

Implemented in anisotropicFilter, laplaceFilter, and simpleFilter.

operator()() [1/4]

virtual tmp< volScalarField > operator() ( const tmp< volScalarField > & ) const

pure virtual

Implemented in anisotropicFilter, laplaceFilter, and simpleFilter.

operator()() [2/4]

virtual tmp< volVectorField > operator() ( const tmp< volVectorField > & ) const

pure virtual

Implemented in anisotropicFilter, anisotropicFilter, laplaceFilter, laplaceFilter, simpleFilter, and simpleFilter.

operator()() [3/4]

virtual tmp< volSymmTensorField > operator() ( const tmp< volSymmTensorField > & ) const

pure virtual

Implemented in anisotropicFilter, anisotropicFilter, laplaceFilter, laplaceFilter, simpleFilter, and simpleFilter.

operator()() [4/4]

virtual tmp< volTensorField > operator() ( const tmp< volTensorField > & ) const

pure virtual

Implemented in anisotropicFilter, laplaceFilter, and simpleFilter.

---

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

• src/TurbulenceModels/turbulenceModels/LES/LESfilters/LESfilter/LESfilter.H
• src/TurbulenceModels/turbulenceModels/LES/LESfilters/LESfilter/LESfilter.C