simpleFilter Class Reference

Simple top-hat filter used in dynamic LES models. More...

Inheritance diagram for simpleFilter:
Collaboration diagram for simpleFilter:

Public Member Functions

 TypeName ("simple")
 Runtime type information. More...
 
 simpleFilter (const fvMesh &mesh)
 Construct from components. More...
 
 simpleFilter (const fvMesh &mesh, const dictionary &)
 Construct from IOdictionary. More...
 
 simpleFilter (const simpleFilter &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~simpleFilter ()
 Destructor. More...
 
virtual void read (const dictionary &)
 Read the LESfilter dictionary. More...
 
virtual tmp< volScalarFieldoperator() (const tmp< volScalarField > &) const
 
virtual tmp< volVectorFieldoperator() (const tmp< volVectorField > &) const
 
virtual tmp< volSymmTensorFieldoperator() (const tmp< volSymmTensorField > &) const
 
virtual tmp< volTensorFieldoperator() (const tmp< volTensorField > &) const
 
void operator= (const simpleFilter &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from LESfilter
 TypeName ("LESfilter")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, LESfilter, dictionary,(const fvMesh &mesh, const dictionary &LESfilterDict),(mesh, LESfilterDict))
 
 LESfilter (const fvMesh &mesh)
 Construct from components. More...
 
 LESfilter (const LESfilter &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~LESfilter ()
 Destructor. More...
 
const fvMeshmesh () const
 Return mesh reference. More...
 
void operator= (const LESfilter &)=delete
 

Additional Inherited Members

- Static Public Member Functions inherited from LESfilter
static autoPtr< LESfilterNew (const fvMesh &, const dictionary &, const word &filterDictName="filter")
 Return a reference to the selected LES filter. More...
 
- Protected Member Functions inherited from LESfilter
template<class GeoFieldType >
void correctBoundaryConditions (const tmp< GeoFieldType > &tgf) const
 Temporary function to ensure the coupled boundary conditions of the. More...
 

Detailed Description

Simple top-hat filter used in dynamic LES models.

Implemented as a surface integral of the face interpolate of the field.

Source files

Definition at line 50 of file simpleFilter.H.

Constructor & Destructor Documentation

◆ simpleFilter() [1/3]

simpleFilter ( const fvMesh mesh)

Construct from components.

Definition at line 42 of file simpleFilter.C.

◆ simpleFilter() [2/3]

simpleFilter ( const fvMesh mesh,
const dictionary  
)

Construct from IOdictionary.

Definition at line 50 of file simpleFilter.C.

◆ simpleFilter() [3/3]

simpleFilter ( const simpleFilter )
delete

Disallow default bitwise copy construction.

◆ ~simpleFilter()

virtual ~simpleFilter ( )
inlinevirtual

Destructor.

Definition at line 74 of file simpleFilter.H.

References simpleFilter::operator=(), and simpleFilter::read().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "simple"  )

Runtime type information.

◆ read()

void read ( const dictionary )
virtual

Read the LESfilter dictionary.

Implements LESfilter.

Definition at line 58 of file simpleFilter.C.

Referenced by simpleFilter::~simpleFilter().

Here is the caller graph for this function:

◆ operator()() [1/4]

Foam::tmp< Foam::volSymmTensorField > operator() ( const tmp< volScalarField > &  unFilteredField) const
virtual

Implements LESfilter.

Definition at line 65 of file simpleFilter.C.

References LESfilter::correctBoundaryConditions(), Foam::fvc::interpolate(), LESfilter::mesh(), and Foam::fvc::surfaceSum().

Here is the call graph for this function:

◆ operator()() [2/4]

Foam::tmp< Foam::volVectorField > operator() ( const tmp< volVectorField > &  unFilteredField) const
virtual

Implements LESfilter.

Definition at line 83 of file simpleFilter.C.

References LESfilter::correctBoundaryConditions(), Foam::fvc::interpolate(), LESfilter::mesh(), and Foam::fvc::surfaceSum().

Here is the call graph for this function:

◆ operator()() [3/4]

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

Implements LESfilter.

◆ operator()() [4/4]

Foam::tmp< Foam::volTensorField > operator() ( const tmp< volTensorField > &  unFilteredField) const
virtual

Implements LESfilter.

Definition at line 119 of file simpleFilter.C.

References LESfilter::correctBoundaryConditions(), Foam::fvc::interpolate(), LESfilter::mesh(), and Foam::fvc::surfaceSum().

Here is the call graph for this function:

◆ operator=()

void operator= ( const simpleFilter )
delete

Disallow default bitwise assignment.

Referenced by simpleFilter::~simpleFilter().

Here is the caller graph for this function:

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