Loading...
Searching...
No Matches
resolutionIndexModel Class Referenceabstract

A base class for resolutionIndex models. More...

#include <resolutionIndexModel.H>

Inheritance diagram for resolutionIndexModel:
Inheritance graph
[legend]

Public Member Functions

 TypeName ("resolutionIndexModel")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, resolutionIndexModel, dictionary,(const word &name, const fvMesh &mesh, const dictionary &dict),(name, mesh, dict))
 resolutionIndexModel (const word &name, const fvMesh &mesh, const dictionary &dict)
 Construct from components.
 resolutionIndexModel (const resolutionIndexModel &)=delete
 No copy construct.
void operator= (const resolutionIndexModel &)=delete
 No copy assignment.
virtual ~resolutionIndexModel ()=default
 Destructor.
const fvMesh & mesh () const noexcept
 Return const reference to the mesh.
const word & resultName () const noexcept
 Return const reference to the result name.
virtual bool read (const dictionary &dict)
 Read the function-object dictionary.
virtual bool execute ()=0
 Execute the function-object operations.
virtual bool write ()=0
 Write the function-object results.

Static Public Member Functions

static autoPtr< resolutionIndexModel > New (const word &name, const fvMesh &mesh, const dictionary &dict)
 Return a reference to the selected resolutionIndex model.

Protected Member Functions

template<class GeoFieldType>
GeoFieldType & getOrReadField (const word &fieldName) const
 Return requested field from the object registry or read+register the field to the object registry.
tmp< volScalarField > V () const
 Return cell volume field.

Detailed Description

A base class for resolutionIndex models.

Source files

Definition at line 57 of file resolutionIndexModel.H.

Constructor & Destructor Documentation

◆ resolutionIndexModel() [1/2]

resolutionIndexModel ( const word & name,
const fvMesh & mesh,
const dictionary & dict )

Construct from components.

Definition at line 59 of file resolutionIndexModel.C.

References dict, mesh(), and Foam::name().

Referenced by CelikEtaIndex::CelikEtaIndex(), CelikNuIndex::CelikNuIndex(), declareRunTimeSelectionTable(), operator=(), PopeIndex::PopeIndex(), and resolutionIndexModel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ resolutionIndexModel() [2/2]

resolutionIndexModel ( const resolutionIndexModel & )
delete

No copy construct.

References resolutionIndexModel().

Here is the call graph for this function:

◆ ~resolutionIndexModel()

virtual ~resolutionIndexModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getOrReadField()

template<class GeoFieldType>
GeoFieldType & getOrReadField ( const word & fieldName) const
protected

Return requested field from the object registry or read+register the field to the object registry.

Definition at line 27 of file resolutionIndexModelTemplates.C.

References IOobjectOption::AUTO_WRITE, IOobjectOption::MUST_READ, IOobjectOption::REGISTER, and regIOobject::store().

Referenced by CelikEtaIndex::execute(), CelikNuIndex::execute(), PopeIndex::execute(), CelikEtaIndex::write(), CelikNuIndex::write(), and PopeIndex::write().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ V()

Foam::tmp< Foam::volScalarField > V ( ) const
protected

Return cell volume field.

Definition at line 39 of file resolutionIndexModel.C.

References Foam::dimVolume, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, and fvPatchFieldBase::zeroGradientType().

Referenced by CelikEtaIndex::execute().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TypeName()

TypeName ( "resolutionIndexModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr ,
resolutionIndexModel ,
dictionary ,
(const word &name, const fvMesh &mesh, const dictionary &dict) ,
(name, mesh, dict)  )

References dict, mesh(), Foam::name(), and resolutionIndexModel().

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::resolutionIndexModel > New ( const word & name,
const fvMesh & mesh,
const dictionary & dict )
static

Return a reference to the selected resolutionIndex model.

Definition at line 26 of file resolutionIndexModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, mesh(), Foam::name(), and Foam::nl.

Referenced by resolutionIndex::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

void operator= ( const resolutionIndexModel & )
delete

No copy assignment.

References resolutionIndexModel().

Here is the call graph for this function:

◆ mesh()

const fvMesh & mesh ( ) const
inlinenoexcept

Return const reference to the mesh.

Definition at line 162 of file resolutionIndexModel.H.

References Foam::noexcept.

Referenced by CelikEtaIndex::CelikEtaIndex(), CelikNuIndex::CelikNuIndex(), declareRunTimeSelectionTable(), New(), PopeIndex::PopeIndex(), resolutionIndexModel(), CelikEtaIndex::TypeName(), CelikNuIndex::TypeName(), and PopeIndex::TypeName().

Here is the caller graph for this function:

◆ resultName()

const word & resultName ( ) const
inlinenoexcept

Return const reference to the result name.

Definition at line 167 of file resolutionIndexModel.H.

References Foam::noexcept.

Referenced by CelikEtaIndex::execute(), CelikNuIndex::execute(), PopeIndex::execute(), CelikEtaIndex::write(), CelikNuIndex::write(), and PopeIndex::write().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary & dict)
virtual

Read the function-object dictionary.

Reimplemented in CelikEtaIndex, CelikNuIndex, and PopeIndex.

Definition at line 73 of file resolutionIndexModel.C.

References dict, Foam::dimless, IOobjectOption::LAZY_READ, IOobjectOption::NO_WRITE, IOobjectOption::REGISTER, regIOobject::store(), Foam::type(), Foam::Zero, and fvPatchFieldBase::zeroGradientType().

Referenced by CelikEtaIndex::read(), CelikNuIndex::read(), and PopeIndex::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ execute()

virtual bool execute ( )
pure virtual

Execute the function-object operations.

Implemented in CelikEtaIndex, CelikNuIndex, and PopeIndex.

◆ write()

virtual bool write ( )
pure virtual

Write the function-object results.

Implemented in CelikEtaIndex, CelikNuIndex, and PopeIndex.

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