optionList Class Reference

List of finite volume options. More...

Inheritance diagram for optionList:

Collaboration diagram for optionList:

Public Member Functions
	TypeName ("optionList")
	Runtime type information. More...
	optionList (const fvMesh &mesh)
	Construct null. More...
	optionList (const fvMesh &mesh, const dictionary &dict)
	Construct from mesh and dictionary. More...
virtual	~optionList ()=default
	Destructor. More...
void	reset (const dictionary &dict)
	Reset the source list. More...
bool	appliesToField (const word &fieldName) const
	Return whether there is something to apply to the field. More...
template<class Type >
tmp< fvMatrix< Type > >	operator() (GeometricField< Type, fvPatchField, volMesh > &field)
	Return source for equation. More...
template<class Type >
tmp< fvMatrix< Type > >	operator() (GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName)
	Return source for equation with specified name. More...
template<class Type >
tmp< fvMatrix< Type > >	operator() (const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
	Return source for equation. More...
template<class Type >
tmp< fvMatrix< Type > >	operator() (const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName)
	Return source for equation with specified name. More...
template<class Type >
tmp< fvMatrix< Type > >	operator() (const volScalarField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
	Return source for equation. More...
template<class Type >
tmp< fvMatrix< Type > >	operator() (const volScalarField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName)
	Return source for equation with specified name. More...
template<class Type >
tmp< fvMatrix< Type > >	operator() (const volScalarField &alpha, const geometricOneField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
	Return source for equation. More...
template<class Type >
tmp< fvMatrix< Type > >	operator() (const geometricOneField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
	Return source for equation. More...
template<class Type >
tmp< fvMatrix< Type > >	operator() (const geometricOneField &alpha, const geometricOneField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
	Return source for equation. More...
template<class Type >
tmp< fvMatrix< Type > >	d2dt2 (GeometricField< Type, fvPatchField, volMesh > &field)
	Return source for equation with second time derivative. More...
template<class Type >
tmp< fvMatrix< Type > >	d2dt2 (GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName)
	Return source for equation with second time derivative. More...
template<class Type >
void	constrain (fvMatrix< Type > &eqn)
	Apply constraints to equation. More...
template<class Type >
void	correct (GeometricField< Type, fvPatchField, volMesh > &field)
	Apply correction to field. More...
virtual bool	read (const dictionary &dict)
	Read dictionary. More...
virtual bool	writeData (Ostream &os) const
	Write data to Ostream. More...
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds)
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	operator() (GeometricField< Type, fvPatchField, volMesh > &field)
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	operator() (GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName)
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	operator() (const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	operator() (const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName)
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	operator() (const volScalarField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	operator() (const volScalarField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName)
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	operator() (const geometricOneField &alpha, const geometricOneField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	operator() (const volScalarField &alpha, const geometricOneField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	operator() (const geometricOneField &alpha, const volScalarField &rho, GeometricField< Type, fvPatchField, volMesh > &field)
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	d2dt2 (GeometricField< Type, fvPatchField, volMesh > &field)
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	d2dt2 (GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName)
Public Member Functions inherited from PtrList< option >
constexpr	PtrList () noexcept
	Construct null. More...
	PtrList (const label len)
	Construct with specified size, each element initialized to nullptr. More...
	PtrList (const PtrList< option > &list)
	Copy construct using 'clone()' method on each element. More...
	PtrList (PtrList< option > &&list)
	Move construct. More...
	PtrList (UList< option * > &list)
	Take ownerskip of pointers in the list, set old pointers to null. More...
	PtrList (const PtrList< option > &list, const CloneArg &cloneArgs)
	Copy construct using 'clone()' method on each element. More...
	PtrList (PtrList< option > &list, bool reuse)
	Construct as copy or re-use as specified. More...
	PtrList (const SLPtrList< option > &list)
	Copy construct using 'clone()' on each element of SLPtrList<T> More...
	PtrList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class. More...
	PtrList (Istream &is)
	Construct from Istream using default Istream constructor class. More...
	~PtrList ()
	Destructor. More...
PtrList< option >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements. More...
Foam::PtrList< option >	clone (Args &&... args) const
void	clear ()
	Clear the PtrList. Delete allocated entries and set size to zero. More...
void	resize (const label newLen)
	Adjust size of PtrList. More...
void	setSize (const label newLen)
	Same as resize() More...
void	append (option *ptr)
	Append an element to the end of the list. More...
void	append (autoPtr< option > &aptr)
	Move append an element to the end of the list. More...
void	append (autoPtr< option > &&aptr)
	Move append an element to the end of the list. More...
void	append (const tmp< option > &tptr)
	Move or clone append a tmp to the end of the list. More...
void	transfer (PtrList< option > &list)
	Transfer into this list and annul the argument list. More...
const option *	set (const label i) const
	Return const pointer to element (if set) or nullptr. More...
autoPtr< option >	set (const label i, option *ptr)
	Set element to given pointer and return old element (can be null) More...
autoPtr< option >	set (const label i, autoPtr< option > &aptr)
	Set element to given autoPtr and return old element. More...
autoPtr< option >	set (const label i, autoPtr< option > &&aptr)
	Set element to given autoPtr and return old element. More...
autoPtr< option >	set (const label i, const tmp< option > &tptr)
	Set element to given tmp and return old element. More...
autoPtr< option >	release (const label i)
	Release ownership of the pointer at the given position. More...
void	operator= (const PtrList< option > &list)
	Copy assignment. More...
void	operator= (PtrList< option > &&list)
	Move assignment. More...

Protected Member Functions
const dictionary &	optionsDict (const dictionary &dict) const
	Return the "options" sub-dictionary if present otherwise return dict. More...
bool	readOptions (const dictionary &dict)
	Read options dictionary. More...
void	checkApplied () const
	Check that all sources have been applied. More...
template<class Type >
tmp< fvMatrix< Type > >	source (GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds)
	Return source for equation with specified name and dimensions. More...
	optionList (const optionList &)=delete
	No copy construct. More...
void	operator= (const optionList &)=delete
	No copy assignment. More...
Protected Member Functions inherited from PtrList< option >
void	readIstream (Istream &is, const INew &inew)
	Read from Istream using Istream constructor class. More...
void	free ()
	Delete the allocated entries, but retain the list size. More...

Protected Attributes
const fvMesh &	mesh_
	Reference to the mesh database. More...
label	checkTimeIndex_
	Time index to check that all defined sources have been applied. More...

Friends
Ostream &	operator<< (Ostream &os, const optionList &options)
	Ostream operator. More...

Detailed Description

List of finite volume options.

SourceFile optionList.C

Definition at line 67 of file fvOptionList.H.

Constructor & Destructor Documentation

optionList() [1/3]

optionList ( const optionList &  )

protecteddelete

No copy construct.

Referenced by kEpsilonLopesdaCosta< BasicTurbulenceModel >::setPorosityCoefficients().

Here is the caller graph for this function:

optionList() [2/3]

optionList

(

const fvMesh &

mesh

)

Construct null.

Definition at line 100 of file fvOptionList.C.

optionList() [3/3]

optionList	(	const fvMesh &	mesh,
		const dictionary &	dict
	)

Construct from mesh and dictionary.

Definition at line 90 of file fvOptionList.C.

References dict, optionList::optionsDict(), and optionList::reset().

Here is the call graph for this function:

~optionList()

virtual ~optionList ( )

virtualdefault

Destructor.

Member Function Documentation

optionsDict()

const Foam::dictionary & optionsDict ( const dictionary &  dict ) const

protected

Return the "options" sub-dictionary if present otherwise return dict.

Definition at line 45 of file fvOptionList.C.

References dict.

Referenced by optionList::optionList().

Here is the caller graph for this function:

readOptions()

bool readOptions ( const dictionary &  dict )

protected

Read options dictionary.

Definition at line 60 of file fvOptionList.C.

References optionList::checkTimeIndex_, dict, forAll, optionList::mesh_, option::name(), option::read(), fvMesh::time(), and TimeState::timeIndex().

Here is the call graph for this function:

checkApplied()

void checkApplied ( ) const

protected

Check that all sources have been applied.

Definition at line 75 of file fvOptionList.C.

References option::checkApplied(), and forAll.

Referenced by optionList::constrain().

Here is the call graph for this function:

Here is the caller graph for this function:

source() [1/2]

tmp<fvMatrix<Type> > source ( GeometricField< Type, fvPatchField, volMesh > &  field, const word &  fieldName, const dimensionSet &  ds  )

protected

Return source for equation with specified name and dimensions.

Referenced by optionList::constrain().

Here is the caller graph for this function:

operator=()

void operator= ( const optionList &  )

protecteddelete

No copy assignment.

TypeName()

TypeName

(

"optionList"

)

Runtime type information.

reset()

void reset

(

const dictionary &

dict

)

Reset the source list.

Definition at line 110 of file fvOptionList.C.

References Foam::BitOps::count(), dict, Foam::name(), option::New(), and resize().

Referenced by optionList::optionList().

Here is the call graph for this function:

Here is the caller graph for this function:

appliesToField()

bool appliesToField

(

const word &

fieldName

)

const

Return whether there is something to apply to the field.

Definition at line 142 of file fvOptionList.C.

References option::applyToField(), and forAll.

Here is the call graph for this function:

operator()() [1/18]

tmp<fvMatrix<Type> > operator()

(

GeometricField< Type, fvPatchField, volMesh > &

field

)

Return source for equation.

operator()() [2/18]

tmp<fvMatrix<Type> > operator()	(	GeometricField< Type, fvPatchField, volMesh > &	field,
		const word &	fieldName
	)

Return source for equation with specified name.

operator()() [3/18]

tmp<fvMatrix<Type> > operator()	(	const volScalarField &	rho,
		GeometricField< Type, fvPatchField, volMesh > &	field
	)

Return source for equation.

operator()() [4/18]

tmp<fvMatrix<Type> > operator()	(	const volScalarField &	rho,
		GeometricField< Type, fvPatchField, volMesh > &	field,
		const word &	fieldName
	)

Return source for equation with specified name.

operator()() [5/18]

tmp<fvMatrix<Type> > operator()	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		GeometricField< Type, fvPatchField, volMesh > &	field
	)

Return source for equation.

operator()() [6/18]

tmp<fvMatrix<Type> > operator()	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		GeometricField< Type, fvPatchField, volMesh > &	field,
		const word &	fieldName
	)

Return source for equation with specified name.

operator()() [7/18]

tmp<fvMatrix<Type> > operator()	(	const volScalarField &	alpha,
		const geometricOneField &	rho,
		GeometricField< Type, fvPatchField, volMesh > &	field
	)

Return source for equation.

operator()() [8/18]

tmp<fvMatrix<Type> > operator()	(	const geometricOneField &	alpha,
		const volScalarField &	rho,
		GeometricField< Type, fvPatchField, volMesh > &	field
	)

Return source for equation.

operator()() [9/18]

tmp<fvMatrix<Type> > operator()	(	const geometricOneField &	alpha,
		const geometricOneField &	rho,
		GeometricField< Type, fvPatchField, volMesh > &	field
	)

Return source for equation.

d2dt2() [1/4]

tmp<fvMatrix<Type> > d2dt2

(

GeometricField< Type, fvPatchField, volMesh > &

field

)

Return source for equation with second time derivative.

d2dt2() [2/4]

tmp<fvMatrix<Type> > d2dt2	(	GeometricField< Type, fvPatchField, volMesh > &	field,
		const word &	fieldName
	)

Return source for equation with second time derivative.

constrain()

void constrain

(

fvMatrix< Type > &

eqn

)

Apply constraints to equation.

Definition at line 288 of file fvOptionListTemplates.C.

References addProfiling, optionList::checkApplied(), Foam::expressions::patchExpr::debug, Foam::endl(), forAll, Foam::Info, fvMatrix< Type >::psi(), and optionList::source().

Referenced by kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::correct(), velocityComponentLaplacianFvMotionSolver::solve(), velocityLaplacianFvMotionSolver::solve(), displacementComponentLaplacianFvMotionSolver::solve(), displacementSBRStressFvMotionSolver::solve(), solidBodyDisplacementLaplacianFvMotionSolver::solve(), displacementLaplacianFvMotionSolver::solve(), and surfaceAlignedSBRStressFvMotionSolver::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

correct()

void correct

(

GeometricField< Type, fvPatchField, volMesh > &

field

)

Apply correction to field.

Definition at line 321 of file fvOptionListTemplates.C.

References addProfiling, option::applyToField(), option::correct(), Foam::expressions::patchExpr::debug, Foam::endl(), field(), forAll, Foam::Info, option::isActive(), option::name(), and option::setApplied().

Referenced by kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::correct(), dynamicLagrangian< BasicTurbulenceModel >::correctNut(), kEqn< BasicTurbulenceModel >::correctNut(), kOmega< BasicTurbulenceModel >::correctNut(), WALE< BasicTurbulenceModel >::correctNut(), continuousGasKEpsilon< BasicTurbulenceModel >::correctNut(), DeardorffDiffStress< BasicTurbulenceModel >::correctNut(), SmagorinskyZhang< BasicTurbulenceModel >::correctNut(), realizableKE< BasicTurbulenceModel >::correctNut(), Smagorinsky< BasicTurbulenceModel >::correctNut(), NicenoKEqn< BasicTurbulenceModel >::correctNut(), LaheyKEpsilon< BasicTurbulenceModel >::correctNut(), kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >::correctNut(), LaunderSharmaKE< BasicTurbulenceModel >::correctNut(), RNGkEpsilon< BasicTurbulenceModel >::correctNut(), dynamicKEqn< BasicTurbulenceModel >::correctNut(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::correctNut(), SSG< BasicTurbulenceModel >::correctNut(), mixtureKEpsilon< BasicTurbulenceModel >::correctNut(), LRR< BasicTurbulenceModel >::correctNut(), SpalartAllmaras< BasicTurbulenceModel >::correctNut(), kOmegaSSTSato< BasicTurbulenceModel >::correctNut(), kEpsilonPhitF< BasicTurbulenceModel >::correctNut(), v2f< BasicTurbulenceModel >::correctNut(), SpalartAllmarasDES< BasicTurbulenceModel >::correctNut(), kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::correctNut(), velocityComponentLaplacianFvMotionSolver::solve(), velocityLaplacianFvMotionSolver::solve(), displacementComponentLaplacianFvMotionSolver::solve(), displacementSBRStressFvMotionSolver::solve(), solidBodyDisplacementLaplacianFvMotionSolver::solve(), displacementLaplacianFvMotionSolver::solve(), and surfaceAlignedSBRStressFvMotionSolver::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

read()

bool read ( const dictionary &  dict )

virtual

Read dictionary.

Definition at line 160 of file fvOptionList.C.

References dict.

Referenced by IOoptionListAdjoint::read(), and options::read().

Here is the caller graph for this function:

writeData()

bool writeData ( Ostream &  os ) const

virtual

Write data to Ostream.

Definition at line 166 of file fvOptionList.C.

References forAll, IOstream::good(), and Foam::nl.

Referenced by Foam::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

source() [2/2]

Foam::tmp<Foam::fvMatrix<Type> > source	(	GeometricField< Type, fvPatchField, volMesh > &	field,
		const word &	fieldName,
		const dimensionSet &	ds
	)

Definition at line 35 of file fvOptionListTemplates.C.

References addProfiling, option::addSup(), option::applyToField(), Foam::expressions::patchExpr::debug, Foam::endl(), field(), forAll, Foam::Info, option::isActive(), option::name(), tmp< T >::ref(), and option::setApplied().

Here is the call graph for this function:

operator()() [10/18]

Foam::tmp<Foam::fvMatrix<Type> > operator()

(

GeometricField< Type, fvPatchField, volMesh > &

field

)

Definition at line 77 of file fvOptionListTemplates.C.

References field().

Here is the call graph for this function:

operator()() [11/18]

Foam::tmp<Foam::fvMatrix<Type> > operator()	(	GeometricField< Type, fvPatchField, volMesh > &	field,
		const word &	fieldName
	)

Definition at line 87 of file fvOptionListTemplates.C.

References Foam::dimTime, Foam::dimVolume, and field().

Here is the call graph for this function:

operator()() [12/18]

Foam::tmp<Foam::fvMatrix<Type> > operator()	(	const volScalarField &	rho,
		GeometricField< Type, fvPatchField, volMesh > &	field
	)

Definition at line 98 of file fvOptionListTemplates.C.

References field(), and rho.

Here is the call graph for this function:

operator()() [13/18]

Foam::tmp<Foam::fvMatrix<Type> > operator()	(	const volScalarField &	rho,
		GeometricField< Type, fvPatchField, volMesh > &	field,
		const word &	fieldName
	)

Definition at line 109 of file fvOptionListTemplates.C.

References addProfiling, option::addSup(), option::applyToField(), Foam::expressions::patchExpr::debug, Foam::dimTime, Foam::dimVolume, Foam::endl(), field(), forAll, Foam::Info, option::isActive(), option::name(), rho, and option::setApplied().

Here is the call graph for this function:

operator()() [14/18]

Foam::tmp<Foam::fvMatrix<Type> > operator()	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		GeometricField< Type, fvPatchField, volMesh > &	field
	)

Definition at line 156 of file fvOptionListTemplates.C.

References Foam::constant::atomic::alpha, field(), and rho.

Here is the call graph for this function:

operator()() [15/18]

Foam::tmp<Foam::fvMatrix<Type> > operator()	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		GeometricField< Type, fvPatchField, volMesh > &	field,
		const word &	fieldName
	)

Definition at line 168 of file fvOptionListTemplates.C.

References addProfiling, option::addSup(), Foam::constant::atomic::alpha, option::applyToField(), Foam::expressions::patchExpr::debug, dimensioned< Type >::dimensions(), Foam::dimTime, Foam::dimVolume, Foam::endl(), field(), forAll, Foam::Info, option::isActive(), option::name(), rho, and option::setApplied().

Here is the call graph for this function:

operator()() [16/18]

Foam::tmp<Foam::fvMatrix<Type> > operator()	(	const geometricOneField &	alpha,
		const geometricOneField &	rho,
		GeometricField< Type, fvPatchField, volMesh > &	field
	)

Definition at line 217 of file fvOptionListTemplates.C.

References field().

Here is the call graph for this function:

operator()() [17/18]

Foam::tmp<Foam::fvMatrix<Type> > operator()	(	const volScalarField &	alpha,
		const geometricOneField &	rho,
		GeometricField< Type, fvPatchField, volMesh > &	field
	)

Definition at line 229 of file fvOptionListTemplates.C.

References Foam::constant::atomic::alpha, Foam::dimless, and field().

Here is the call graph for this function:

operator()() [18/18]

Foam::tmp<Foam::fvMatrix<Type> > operator()	(	const geometricOneField &	alpha,
		const volScalarField &	rho,
		GeometricField< Type, fvPatchField, volMesh > &	field
	)

Definition at line 256 of file fvOptionListTemplates.C.

References field(), and rho.

Here is the call graph for this function:

d2dt2() [3/4]

Foam::tmp<Foam::fvMatrix<Type> > d2dt2

(

GeometricField< Type, fvPatchField, volMesh > &

field

)

Definition at line 268 of file fvOptionListTemplates.C.

References Foam::fac::d2dt2(), and field().

Here is the call graph for this function:

d2dt2() [4/4]

Foam::tmp<Foam::fvMatrix<Type> > d2dt2	(	GeometricField< Type, fvPatchField, volMesh > &	field,
		const word &	fieldName
	)

Definition at line 278 of file fvOptionListTemplates.C.

References Foam::dimTime, Foam::dimVolume, field(), and Foam::sqr().

Here is the call graph for this function:

Friends And Related Function Documentation

operator<<

Ostream& operator<< ( Ostream &  os, const optionList &  options  )

friend

Ostream operator.

Member Data Documentation

mesh_

const fvMesh& mesh_

protected

Reference to the mesh database.

Definition at line 76 of file fvOptionList.H.

Referenced by optionList::readOptions().

checkTimeIndex_

label checkTimeIndex_

protected

Time index to check that all defined sources have been applied.

Definition at line 79 of file fvOptionList.H.

Referenced by optionList::readOptions().

---

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

• src/finiteVolume/cfdTools/general/fvOptions/fvOptionList.H
• src/finiteVolume/cfdTools/general/fvOptions/fvOptionList.C
• src/finiteVolume/cfdTools/general/fvOptions/fvOptionListTemplates.C