resolutionIndexModel Class Reference

A base class for resolutionIndex models. More...

Inheritance diagram for resolutionIndexModel:

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...

Detailed Description

A base class for resolutionIndex models.

Source files

• resolutionIndexModel.H
• resolutionIndexModel.C
• resolutionIndexModelNew.C

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 67 of file resolutionIndexModel.C.

resolutionIndexModel() [2/2]

resolutionIndexModel ( const resolutionIndexModel &  )

delete

No copy construct.

~resolutionIndexModel()

virtual ~resolutionIndexModel ( )

virtualdefault

Destructor.

Member Function Documentation

getOrReadField()

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 28 of file resolutionIndexModelTemplates.C.

V()

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

protected

Return cell volume field.

Definition at line 39 of file resolutionIndexModel.C.

References Foam::dimVolume, tmp< T >::New(), IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, fvMesh::time(), Time::timeName(), fvMesh::V(), and fvPatchFieldBase::zeroGradientType().

Here is the call 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)
	)

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 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().

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.

mesh()

const fvMesh& mesh ( ) const

inlinenoexcept

Return const reference to the mesh.

Definition at line 162 of file resolutionIndexModel.H.

resultName()

const word& resultName ( ) const

inlinenoexcept

Return const reference to the result name.

Definition at line 170 of file resolutionIndexModel.H.

read()

bool read ( const dictionary &  dict )

virtual

Read top-level dictionary.

Reimplemented in CelikEtaIndex, CelikNuIndex, and PopeIndex.

Definition at line 80 of file resolutionIndexModel.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

execute()

virtual bool execute ( )

pure virtual

Calculate the result field.

Implemented in CelikEtaIndex, CelikNuIndex, and PopeIndex.

write()

virtual bool write ( )

pure virtual

Write the result field.

Implemented in CelikEtaIndex, CelikNuIndex, and PopeIndex.

---

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

• src/functionObjects/field/resolutionIndex/resolutionIndexModels/resolutionIndexModel/resolutionIndexModel.H
• src/functionObjects/field/resolutionIndex/resolutionIndexModels/resolutionIndexModel/resolutionIndexModel.C
• src/functionObjects/field/resolutionIndex/resolutionIndexModels/resolutionIndexModel/resolutionIndexModelNew.C
• src/functionObjects/field/resolutionIndex/resolutionIndexModels/resolutionIndexModel/resolutionIndexModelTemplates.C