A base class for resolutionIndex
models.
More...
Public Member Functions | |
TypeName ("resolutionIndexModel") | |
Runtime type information. More... | |
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. More... | |
resolutionIndexModel (const resolutionIndexModel &)=delete | |
No copy construct. More... | |
void | operator= (const resolutionIndexModel &)=delete |
No copy assignment. More... | |
virtual | ~resolutionIndexModel ()=default |
Destructor. More... | |
const fvMesh & | mesh () const noexcept |
Return const reference to the mesh. More... | |
const word & | resultName () const noexcept |
Return const reference to the result name. More... | |
virtual bool | read (const dictionary &dict) |
Read top-level dictionary. More... | |
virtual bool | execute ()=0 |
Calculate the result field. More... | |
virtual bool | write ()=0 |
Write the result field. More... | |
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. More... | |
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. More... | |
tmp< volScalarField > | V () const |
Return cell volume field. More... | |
A base class for resolutionIndex
models.
Definition at line 57 of file resolutionIndexModel.H.
resolutionIndexModel | ( | const word & | name, |
const fvMesh & | mesh, | ||
const dictionary & | dict | ||
) |
Construct from components.
Definition at line 60 of file resolutionIndexModel.C.
|
delete |
No copy construct.
|
virtualdefault |
Destructor.
|
protected |
Return requested field from the object registry or read+register the field to the object registry.
Definition at line 28 of file resolutionIndexModelTemplates.C.
|
protected |
Return cell volume field.
Definition at line 39 of file resolutionIndexModel.C.
References Foam::dimVolume, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, fvMesh::V(), and fvPatchFieldBase::zeroGradientType().
TypeName | ( | "resolutionIndexModel" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
resolutionIndexModel | , | ||
dictionary | , | ||
(const word &name, const fvMesh &mesh, const dictionary &dict) | , | ||
(name, mesh, dict) | |||
) |
|
static |
Return a reference to the selected resolutionIndex model.
Definition at line 27 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().
|
delete |
No copy assignment.
|
inlinenoexcept |
Return const reference to the mesh.
Definition at line 162 of file resolutionIndexModel.H.
|
inlinenoexcept |
Return const reference to the result name.
Definition at line 170 of file resolutionIndexModel.H.
|
virtual |
Read top-level dictionary.
Reimplemented in CelikEtaIndex, CelikNuIndex, and PopeIndex.
Definition at line 73 of file resolutionIndexModel.C.
References dict, Foam::dimless, dictionary::getOrDefault(), IOobjectOption::LAZY_READ, IOobjectOption::NO_WRITE, IOobjectOption::REGISTER, regIOobject::store(), Foam::type(), Foam::Zero, and fvPatchFieldBase::zeroGradientType().
Referenced by PopeIndex::read(), CelikNuIndex::read(), and CelikEtaIndex::read().
|
pure virtual |
Calculate the result field.
Implemented in CelikEtaIndex, CelikNuIndex, and PopeIndex.
|
pure virtual |
Write the result field.
Implemented in CelikEtaIndex, CelikNuIndex, and PopeIndex.