List of finite volume options. More...

Inheritance diagram for optionList:

Collaboration diagram for optionList:

[legend]

Public Member Functions
	TypeName ("optionList")

	optionList (const fvPatch &p)

	optionList (const fvPatch &p, const dictionary &)

virtual	~optionList ()=default

void	reset (const dictionary &dict)

bool	appliesToField (const word &fieldName) const

template<class Type >
tmp< faMatrix< Type > >	operator() (const areaScalarField &h, GeometricField< Type, faPatchField, areaMesh > &field)

template<class Type >
tmp< faMatrix< Type > >	operator() (const areaScalarField &h, GeometricField< Type, faPatchField, areaMesh > &field, const word &fieldName)

template<class Type >
tmp< faMatrix< Type > >	operator() (const areaScalarField &h, const areaScalarField &rho, GeometricField< Type, faPatchField, areaMesh > &field)

template<class Type >
tmp< faMatrix< Type > >	operator() (const areaScalarField &h, const areaScalarField &rho, GeometricField< Type, faPatchField, areaMesh > &field, const word &fieldName)

template<class Type >
tmp< faMatrix< Type > >	operator() (const areaScalarField &rho, GeometricField< Type, faPatchField, areaMesh > &field, const dimensionSet &ds)

template<class Type >
tmp< faMatrix< Type > >	d2dt2 (GeometricField< Type, faPatchField, areaMesh > &field)

template<class Type >
tmp< faMatrix< Type > >	d2dt2 (GeometricField< Type, faPatchField, areaMesh > &field, const word &fieldName)

template<class Type >
void	constrain (faMatrix< Type > &eqn)

template<class Type >
void	correct (GeometricField< Type, faPatchField, areaMesh > &field)

virtual bool	read (const dictionary &dict)

virtual bool	writeData (Ostream &os) const

template<class Type >
Foam::tmp< Foam::faMatrix< Type > >	source (GeometricField< Type, faPatchField, areaMesh > &field, const areaScalarField &h, const word &fieldName, const dimensionSet &ds)

template<class Type >
Foam::tmp< Foam::faMatrix< Type > >	operator() (const areaScalarField &h, GeometricField< Type, faPatchField, areaMesh > &field)

template<class Type >
Foam::tmp< Foam::faMatrix< Type > >	operator() (const areaScalarField &h, GeometricField< Type, faPatchField, areaMesh > &field, const word &fieldName)

template<class Type >
Foam::tmp< Foam::faMatrix< Type > >	operator() (const areaScalarField &h, const areaScalarField &rho, GeometricField< Type, faPatchField, areaMesh > &field)

template<class Type >
Foam::tmp< Foam::faMatrix< Type > >	operator() (const areaScalarField &h, const areaScalarField &rho, GeometricField< Type, faPatchField, areaMesh > &field, const word &fieldName)

template<class Type >
Foam::tmp< Foam::faMatrix< Type > >	operator() (const areaScalarField &rho, GeometricField< Type, faPatchField, areaMesh > &field, const dimensionSet &ds)

template<class Type >
Foam::tmp< Foam::faMatrix< Type > >	d2dt2 (GeometricField< Type, faPatchField, areaMesh > &field)

template<class Type >
Foam::tmp< Foam::faMatrix< Type > >	d2dt2 (GeometricField< Type, faPatchField, areaMesh > &field, const word &fieldName)

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< fa::option >
constexpr	PtrList () noexcept

	PtrList (const label len)

	PtrList (const PtrList< T > &list)

	PtrList (PtrList< T > &&list)

	PtrList (UList< T * > &list)

	PtrList (const PtrList< T > &list, const CloneArg &cloneArgs)

	PtrList (PtrList< T > &list, bool reuse)

	PtrList (const SLPtrList< T > &list)

	PtrList (Istream &is, const INew &inew)

	PtrList (Istream &is)

	PtrList (PtrList< T > &list, bool reuse)

	PtrList (const SLPtrList< T > &list)

constexpr	PtrList () noexcept

	PtrList (const label len)

	PtrList (const PtrList< T > &list)

	PtrList (PtrList< T > &&list)

	PtrList (UList< T * > &list)

	PtrList (Istream &is)

	~PtrList ()

PtrList< T >	clone (Args &&... args) const

Foam::PtrList< T >	clone (Args &&... args) const

const T *	set (const label i) const

autoPtr< T >	set (const label i, T *ptr)

autoPtr< T >	set (const label i, autoPtr< T > &ptr)

autoPtr< T >	set (const label i, autoPtr< T > &&ptr)

autoPtr< T >	set (const label i, std::unique_ptr< T > &&ptr)

autoPtr< T >	set (const label i, const refPtr< T > &ptr)

autoPtr< T >	set (const label i, const tmp< T > &ptr)

void	clear ()

void	resize (const label newLen)

void	setSize (const label newLen)

void	emplace_append (Args &&... args)

void	append (T *ptr)

void	append (autoPtr< T > &ptr)

void	append (autoPtr< T > &&ptr)

void	append (std::unique_ptr< T > &&ptr)

void	append (const refPtr< T > &ptr)

void	append (const tmp< T > &ptr)

autoPtr< T >	emplace (const label i, Args &&... args)

Foam::autoPtr< T >	emplace (const label i, Args &&... args)

autoPtr< T >	release (const label i)

void	transfer (PtrList< T > &list)

void	operator= (const PtrList< T > &list)

void	operator= (PtrList< T > &&list)

Protected Member Functions
bool	readOptions (const dictionary &dict)

void	checkApplied () const

template<class Type >
tmp< faMatrix< Type > >	source (GeometricField< Type, faPatchField, areaMesh > &field, const areaScalarField &h, const word &fieldName, const dimensionSet &ds)

	optionList (const optionList &)=delete

void	operator= (const optionList &)=delete

Protected Member Functions inherited from PtrList< fa::option >
void	readIstream (Istream &is, const INew &inew)

void	free ()

Static Protected Member Functions
static const dictionary &	optionsDict (const dictionary &dict)

Protected Attributes
const fvMesh &	mesh_

const fvPatch &	patch_

label	checkTimeIndex_

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

Detailed Description

List of finite volume options.

SourceFile optionList.C

Definition at line 59 of file faOptionList.H.

Constructor & Destructor Documentation

◆ optionList() [1/3]

optionList ( const optionList & )

protecteddelete

◆ optionList() [2/3]

optionList ( const fvPatch & p )

explicit

Definition at line 90 of file faOptionList.C.

◆ optionList() [3/3]

optionList	(	const fvPatch &	p,
		const dictionary &	dict
	)

Definition at line 76 of file faOptionList.C.

References dict, and reset().

Here is the call graph for this function:

◆ ~optionList()

virtual ~optionList ( )

virtualdefault

Member Function Documentation

◆ optionsDict()

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

staticprotected

Definition at line 37 of file faOptionList.C.

References dict.

◆ readOptions()

bool readOptions ( const dictionary & dict )

protected

Definition at line 47 of file faOptionList.C.

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

Here is the call graph for this function:

◆ checkApplied()

void checkApplied ( ) const

protected

Definition at line 61 of file faOptionList.C.

References option::checkApplied().

Referenced by optionList::constrain().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ source() [1/3]

tmp<faMatrix<Type> > source	(	GeometricField< Type, faPatchField, areaMesh > &	field,
		const areaScalarField &	h,
		const word &	fieldName,
		const dimensionSet &	ds
	)

protected

Referenced by optionList::constrain().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const optionList & )

protecteddelete

◆ TypeName()

TypeName ( "optionList" )

◆ reset()

void reset ( const dictionary & dict )

Definition at line 101 of file faOptionList.C.

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

Here is the call graph for this function:

◆ appliesToField()

bool appliesToField ( const word & fieldName ) const

Definition at line 133 of file faOptionList.C.

References option::applyToField().

Here is the call graph for this function:

◆ operator()() [1/19]

tmp<faMatrix<Type> > operator()	(	const areaScalarField &	h,
		GeometricField< Type, faPatchField, areaMesh > &	field
	)

◆ operator()() [2/19]

tmp<faMatrix<Type> > operator()	(	const areaScalarField &	h,
		GeometricField< Type, faPatchField, areaMesh > &	field,
		const word &	fieldName
	)

◆ operator()() [3/19]

tmp<faMatrix<Type> > operator()	(	const areaScalarField &	h,
		const areaScalarField &	rho,
		GeometricField< Type, faPatchField, areaMesh > &	field
	)

◆ operator()() [4/19]

tmp<faMatrix<Type> > operator()	(	const areaScalarField &	h,
		const areaScalarField &	rho,
		GeometricField< Type, faPatchField, areaMesh > &	field,
		const word &	fieldName
	)

◆ operator()() [5/19]

tmp<faMatrix<Type> > operator()	(	const areaScalarField &	rho,
		GeometricField< Type, faPatchField, areaMesh > &	field,
		const dimensionSet &	ds
	)

◆ d2dt2() [1/6]

tmp<faMatrix<Type> > d2dt2 ( GeometricField< Type, faPatchField, areaMesh > & field )

◆ d2dt2() [2/6]

tmp<faMatrix<Type> > d2dt2	(	GeometricField< Type, faPatchField, areaMesh > &	field,
		const word &	fieldName
	)

◆ constrain()

void constrain ( faMatrix< Type > & eqn )

Definition at line 242 of file faOptionListTemplates.C.

References addProfiling, optionList::checkApplied(), Foam::expressions::patchExpr::debug, Foam::endl(), Foam::Info, faMatrix::psi(), and optionList::source().

Referenced by kinematicThinFilm::evolveRegion(), KirchhoffShell::solveDisplacement(), and thermalShell::solveEnergy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correct()

void correct ( GeometricField< Type, faPatchField, areaMesh > & field )

Definition at line 283 of file faOptionListTemplates.C.

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

Referenced by kinematicThinFilm::evolveRegion(), KirchhoffShell::solveDisplacement(), and thermalShell::solveEnergy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Definition at line 149 of file faOptionList.C.

References dict.

Referenced by options::read().

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Definition at line 155 of file faOptionList.C.

References Foam::nl, os(), option::writeData(), option::writeFooter(), and option::writeHeader().

Referenced by Foam::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ source() [2/3]

Foam::tmp<Foam::faMatrix<Type> > source	(	GeometricField< Type, faPatchField, areaMesh > &	field,
		const areaScalarField &	h,
		const word &	fieldName,
		const dimensionSet &	ds
	)

Definition at line 28 of file faOptionListTemplates.C.

References addProfiling, option::addSup(), option::applyToField(), Foam::expressions::patchExpr::debug, Foam::endl(), field(), Foam::constant::universal::h, Foam::Info, option::isActive(), option::name(), tmp::ref(), and option::setApplied().

Here is the call graph for this function:

◆ operator()() [6/19]

Foam::tmp<Foam::faMatrix<Type> > operator()	(	const areaScalarField &	h,
		GeometricField< Type, faPatchField, areaMesh > &	field
	)

Definition at line 79 of file faOptionListTemplates.C.

References field(), and Foam::constant::universal::h.

Here is the call graph for this function:

◆ operator()() [7/19]

Foam::tmp<Foam::faMatrix<Type> > operator()	(	const areaScalarField &	h,
		GeometricField< Type, faPatchField, areaMesh > &	field,
		const word &	fieldName
	)

Definition at line 90 of file faOptionListTemplates.C.

References Foam::dimArea, Foam::dimTime, field(), and Foam::constant::universal::h.

Here is the call graph for this function:

◆ operator()() [8/19]

Foam::tmp<Foam::faMatrix<Type> > operator()	(	const areaScalarField &	h,
		const areaScalarField &	rho,
		GeometricField< Type, faPatchField, areaMesh > &	field
	)

Definition at line 102 of file faOptionListTemplates.C.

References field(), Foam::constant::universal::h, and rho.

Here is the call graph for this function:

◆ operator()() [9/19]

Foam::tmp<Foam::faMatrix<Type> > operator()	(	const areaScalarField &	h,
		const areaScalarField &	rho,
		GeometricField< Type, faPatchField, areaMesh > &	field,
		const word &	fieldName
	)

Definition at line 114 of file faOptionListTemplates.C.

References addProfiling, option::addSup(), option::applyToField(), Foam::expressions::patchExpr::debug, Foam::dimArea, Foam::dimTime, Foam::endl(), field(), Foam::constant::universal::h, Foam::Info, option::isActive(), option::name(), tmp::ref(), rho, and option::setApplied().

Here is the call graph for this function:

◆ operator()() [10/19]

Foam::tmp<Foam::faMatrix<Type> > operator()	(	const areaScalarField &	rho,
		GeometricField< Type, faPatchField, areaMesh > &	field,
		const dimensionSet &	ds
	)

Definition at line 170 of file faOptionListTemplates.C.

References addProfiling, option::addSup(), option::applyToField(), Foam::expressions::patchExpr::debug, Foam::dimArea, Foam::endl(), field(), Foam::Info, option::isActive(), option::name(), tmp::ref(), rho, and option::setApplied().

Here is the call graph for this function:

◆ d2dt2() [3/6]

Foam::tmp<Foam::faMatrix<Type> > d2dt2 ( GeometricField< Type, faPatchField, areaMesh > & field )

Definition at line 222 of file faOptionListTemplates.C.

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

Here is the call graph for this function:

◆ d2dt2() [4/6]

Foam::tmp<Foam::faMatrix<Type> > d2dt2	(	GeometricField< Type, faPatchField, areaMesh > &	field,
		const word &	fieldName
	)

Definition at line 232 of file faOptionListTemplates.C.

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

Here is the call graph for this function:

◆ source() [3/3]

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

Definition at line 30 of file fvOptionListTemplates.C.

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

Here is the call graph for this function:

◆ operator()() [11/19]

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

Definition at line 80 of file fvOptionListTemplates.C.

References field().

Here is the call graph for this function:

◆ operator()() [12/19]

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

Definition at line 90 of file fvOptionListTemplates.C.

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

Here is the call graph for this function:

◆ operator()() [13/19]

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

Definition at line 101 of file fvOptionListTemplates.C.

References field(), and rho.

Here is the call graph for this function:

◆ operator()() [14/19]

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

Definition at line 112 of file fvOptionListTemplates.C.

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

Here is the call graph for this function:

◆ operator()() [15/19]

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

Definition at line 167 of file fvOptionListTemplates.C.

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

Here is the call graph for this function:

◆ operator()() [16/19]

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

Definition at line 179 of file fvOptionListTemplates.C.

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

Here is the call graph for this function:

◆ operator()() [17/19]

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

Definition at line 236 of file fvOptionListTemplates.C.

References field().

Here is the call graph for this function:

◆ operator()() [18/19]

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

Definition at line 248 of file fvOptionListTemplates.C.

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

Here is the call graph for this function:

◆ operator()() [19/19]

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

Definition at line 275 of file fvOptionListTemplates.C.

References field(), and rho.

Here is the call graph for this function:

◆ d2dt2() [5/6]

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

Definition at line 287 of file fvOptionListTemplates.C.

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

Here is the call graph for this function:

◆ d2dt2() [6/6]

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

Definition at line 297 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

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Definition at line 68 of file faOptionList.H.

Referenced by optionList::readOptions().

◆ patch_

const fvPatch& patch_

protected

Definition at line 71 of file faOptionList.H.

◆ checkTimeIndex_

label checkTimeIndex_

protected

Definition at line 74 of file faOptionList.H.

Referenced by optionList::readOptions().

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

src/faOptions/faOption/faOptionList.H
src/faOptions/faOption/faOptionList.C
src/faOptions/faOption/faOptionListTemplates.C
src/finiteVolume/cfdTools/general/fvOptions/fvOptionListTemplates.C

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ optionList() [1/3]

◆ optionList() [2/3]

◆ optionList() [3/3]

◆ ~optionList()

Member Function Documentation

◆ optionsDict()

◆ readOptions()

◆ checkApplied()

◆ source() [1/3]

◆ operator=()

◆ TypeName()

◆ reset()

◆ appliesToField()

◆ operator()() [1/19]

◆ operator()() [2/19]

◆ operator()() [3/19]

◆ operator()() [4/19]

◆ operator()() [5/19]

◆ d2dt2() [1/6]

◆ d2dt2() [2/6]

◆ constrain()

◆ correct()

◆ read()

◆ writeData()

◆ source() [2/3]

◆ operator()() [6/19]

◆ operator()() [7/19]

◆ operator()() [8/19]

◆ operator()() [9/19]

◆ operator()() [10/19]

◆ d2dt2() [3/6]

◆ d2dt2() [4/6]

◆ source() [3/3]

◆ operator()() [11/19]

◆ operator()() [12/19]

◆ operator()() [13/19]

◆ operator()() [14/19]

◆ operator()() [15/19]

◆ operator()() [16/19]

◆ operator()() [17/19]

◆ operator()() [18/19]

◆ operator()() [19/19]

◆ d2dt2() [5/6]

◆ d2dt2() [6/6]

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ mesh_

◆ patch_

◆ checkTimeIndex_