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

void	reset (const dictionary &dict)
	Reset the source list. 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 >
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 > >	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)

Public Member Functions inherited from PtrList< option >
	PtrList ()
	Null Constructor. More...

	PtrList (const label)
	Construct with size specified. More...

	PtrList (const PtrList< T > &)
	Copy constructor. More...

	PtrList (const PtrList< T > &, const CloneArg &)
	Copy constructor with additional argument for clone. More...

	PtrList (const Xfer< PtrList< T > > &)
	Construct by transferring the parameter contents. More...

	PtrList (PtrList< T > &, bool reUse)
	Construct as copy or re-use as specified. More...

	PtrList (const SLPtrList< T > &)
	Construct as copy of SLPtrList<T> More...

	PtrList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

	PtrList (Istream &)
	Construct from Istream using default Istream constructor class. More...

	PtrList ()

	PtrList (const label s)

	PtrList (const PtrList< T > &a)

	PtrList (const Xfer< PtrList< T > > &lst)

	PtrList (PtrList< T > &a, bool reUse)

	PtrList (const SLPtrList< T > &sll)

	PtrList (Istream &is)

	~PtrList ()
	Destructor. More...

label	size () const
	Return the number of elements in the PtrList. More...

bool	empty () const
	Return true if the PtrList is empty (ie, size() is zero). More...

T &	first ()
	Return reference to the first element of the list. More...

const T &	first () const
	Return reference to first element of the list. More...

T &	last ()
	Return reference to the last element of the list. More...

const T &	last () const
	Return reference to the last element of the list. More...

void	setSize (const label)
	Reset size of PtrList. If extending the PtrList, new entries are. More...

void	resize (const label)
	Alias for setSize(const label) More...

void	clear ()
	Clear the PtrList, i.e. set size to zero deleting all the. More...

void	append (T *)
	Append an element at the end of the list. More...

void	append (const autoPtr< T > &)

void	append (const tmp< T > &)

void	transfer (PtrList< T > &)
	Transfer the contents of the argument PtrList into this PtrList. More...

Xfer< PtrList< T > >	xfer ()
	Transfer contents to the Xfer container. More...

bool	set (const label) const
	Is element set. More...

autoPtr< T >	set (const label, T *)
	Set element. Return old element (can be NULL). More...

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

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

void	reorder (const labelUList &)
	Reorders elements. Ordering does not have to be done in. More...

const T &	operator[] (const label) const
	Return element const reference. More...

T &	operator[] (const label)
	Return element reference. More...

const T *	operator() (const label) const
	Return element const pointer. More...

PtrList< T > &	operator= (const PtrList< T > &)
	Assignment. More...

iterator	begin ()
	Return an iterator to begin traversing the PtrList. More...

const_iterator	begin () const
	Return an const_iterator to begin traversing the PtrList. More...

iterator	end ()
	Return an iterator to end traversing the PtrList. More...

const_iterator	end () const
	Return an const_iterator to end traversing the PtrList. More...

const_iterator	cbegin () const
	Return an const_iterator to begin traversing the PtrList. More...

const_iterator	cend () const
	Return an const_iterator to end traversing the PtrList. 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...

	optionList (const optionList &)
	Disallow default bitwise copy construct. More...

void	operator= (const optionList &)
	Disallow default bitwise assignment. More...

Protected Member Functions inherited from PtrList< option >
void	read (Istream &, const INew &inewt)
	Read from Istream using given Istream constructor class. 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...

Additional Inherited Members
Public Types inherited from PtrList< option >
typedef T	value_type
	Type of values the PtrList contains. More...

typedef T &	reference
	Type that can be used for storing into PtrList::value_type objects. More...

Data Fields inherited from PtrList< option >
const typedef T &	const_reference
	Type that can be used for storing into constant PtrList::value_type. More...

Detailed Description

List of finite volume options.

SourceFile optionList.C

Definition at line 64 of file fvOptionList.H.

Constructor & Destructor Documentation

◆ optionList() [1/3]

optionList ( const optionList & )

protected

Disallow default bitwise copy construct.

◆ optionList() [2/3]

optionList ( const fvMesh & mesh )

Construct null.

Definition at line 98 of file fvOptionList.C.

◆ optionList() [3/3]

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

Construct from mesh and dictionary.

Definition at line 88 of file fvOptionList.C.

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

Here is the call graph for this function:

◆ ~optionList()

virtual ~optionList ( )

inlinevirtual

Destructor.

Definition at line 113 of file fvOptionList.H.

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 43 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 58 of file fvOptionList.C.

References optionList::checkTimeIndex_, dict, forAll, optionList::mesh_, option::name(), PtrList< option >::operator[](), 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 73 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:

◆ operator=()

void operator= ( const optionList & )

protected

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "optionList" )

Runtime type information.

◆ reset()

void reset ( const dictionary & dict )

Reset the source list.

Definition at line 108 of file fvOptionList.C.

References dict, forAllConstIter(), Foam::name(), option::New(), and setSize().

Referenced by optionList::optionList().

Here is the call graph for this function:

Here is the caller 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.

◆ constrain()

void constrain ( fvMatrix< Type > & eqn )

Apply constraints to equation.

Definition at line 246 of file fvOptionListTemplates.C.

References option::applyToField(), optionList::checkApplied(), option::constrain(), Foam::endl(), forAll, Foam::Info, option::isActive(), option::name(), PtrList< option >::operator[](), fvMatrix::psi(), and option::setApplied().

Here is the call graph for this function:

◆ correct()

void correct ( GeometricField< Type, fvPatchField, volMesh > & field )

Apply correction to field.

Definition at line 277 of file fvOptionListTemplates.C.

References option::applyToField(), option::correct(), Foam::endl(), forAll, Foam::Info, option::isActive(), option::name(), and option::setApplied().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Definition at line 139 of file fvOptionList.C.

References dict.

Referenced by options::read().

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Write data to Ostream.

Definition at line 145 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:

◆ operator()() [10/18]

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

Definition at line 30 of file fvOptionListTemplates.C.

◆ operator()() [11/18]

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

Definition at line 40 of file fvOptionListTemplates.C.

References option::addSup(), option::applyToField(), Foam::dimTime, Foam::dimVolume, Foam::endl(), forAll, Foam::Info, option::isActive(), option::name(), and option::setApplied().

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 81 of file fvOptionListTemplates.C.

References rho.

◆ operator()() [13/18]

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

Definition at line 92 of file fvOptionListTemplates.C.

References option::addSup(), option::applyToField(), Foam::dimTime, Foam::dimVolume, Foam::endl(), 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 137 of file fvOptionListTemplates.C.

References Foam::constant::atomic::alpha, and rho.

◆ 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 149 of file fvOptionListTemplates.C.

References option::addSup(), Foam::constant::atomic::alpha, option::applyToField(), dimensioned::dimensions(), Foam::dimTime, Foam::dimVolume, Foam::endl(), 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 196 of file fvOptionListTemplates.C.

◆ operator()() [17/18]

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

Definition at line 208 of file fvOptionListTemplates.C.

References Foam::constant::atomic::alpha, and Foam::dimless.

◆ operator()() [18/18]

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

Definition at line 235 of file fvOptionListTemplates.C.

References rho.

Friends And Related Function Documentation

◆ operator<<

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

friend

Ostream operator.

Field Documentation

◆ mesh_

const fvMesh& mesh_

protected

Reference to the mesh database.

Definition at line 73 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 76 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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ optionList() [1/3]

◆ optionList() [2/3]

◆ optionList() [3/3]

◆ ~optionList()

Member Function Documentation

◆ optionsDict()

◆ readOptions()

◆ checkApplied()

◆ operator=()

◆ TypeName()

◆ reset()

◆ operator()() [1/18]

◆ operator()() [2/18]

◆ operator()() [3/18]

◆ operator()() [4/18]

◆ operator()() [5/18]

◆ operator()() [6/18]

◆ operator()() [7/18]

◆ operator()() [8/18]

◆ operator()() [9/18]

◆ constrain()

◆ correct()

◆ read()

◆ writeData()

◆ operator()() [10/18]

◆ operator()() [11/18]

◆ operator()() [12/18]

◆ operator()() [13/18]

◆ operator()() [14/18]

◆ operator()() [15/18]

◆ operator()() [16/18]

◆ operator()() [17/18]

◆ operator()() [18/18]

Friends And Related Function Documentation

◆ operator<<

Field Documentation

◆ mesh_

◆ checkTimeIndex_