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)
	Default construct from mesh. 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...

template<class Type >
void	postProcessSens (Field< Type > &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
	Post process sensitivity field related to the fvOption. More...

virtual bool	read (const dictionary &dict)
	Read dictionary. More...

virtual bool	writeData (Ostream &os) const
	Write data to Ostream. More...

Public Member Functions inherited from PtrList< fv::option >
constexpr	PtrList () noexcept
	Default construct. More...

	PtrList (const label len)
	Construct with specified size, each element initialized to nullptr. More...

	PtrList (const PtrList< fv::option > &list)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< fv::option > &&list)
	Move construct. More...

	PtrList (UList< fv::option * > &list)
	Take ownership of pointers in the list, set old pointers to null. More...

	PtrList (const PtrList< fv::option > &list, const CloneArg &cloneArgs)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< fv::option > &list, bool reuse)
	Construct as copy or re-use as specified. More...

	PtrList (const SLPtrList< fv::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< fv::option >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements. More...

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

const fv::option *	set (const label i) const

autoPtr< fv::option >	set (const label i, fv::option *ptr)
	Set element to given pointer and return old element (can be null) More...

autoPtr< fv::option >	set (const label i, autoPtr< fv::option > &ptr)
	Set element to given autoPtr and return old element. More...

autoPtr< fv::option >	set (const label i, autoPtr< fv::option > &&ptr)
	Set element to given autoPtr and return old element. More...

autoPtr< fv::option >	set (const label i, std::unique_ptr< fv::option > &&ptr)
	Set element to given unique_ptr and return old element. More...

autoPtr< fv::option >	set (const label i, const refPtr< fv::option > &ptr)
	Set element to given refPtr and return old element. More...

autoPtr< fv::option >	set (const label i, const tmp< fv::option > &ptr)
	Set element to given tmp and return old element. More...

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	emplace_append (Args &&... args)
	Construct and append an element to the end of the list. More...

void	append (fv::option *ptr)
	Append an element to the end of the list. More...

void	append (autoPtr< fv::option > &ptr)
	Move append an element to the end of the list. More...

void	append (autoPtr< fv::option > &&ptr)
	Move append an element to the end of the list. More...

void	append (std::unique_ptr< fv::option > &&ptr)
	Move append an element to the end of the list. More...

void	append (const refPtr< fv::option > &ptr)
	Move or clone append a refPtr to the end of the list. More...

void	append (const tmp< fv::option > &ptr)
	Move or clone append a tmp to the end of the list. More...

void	append (PtrList< fv::option > &&other)
	Move append another list to the end of this list. More...

autoPtr< fv::option >	emplace (const label i, Args &&... args)
	Construct and set an element. More...

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

autoPtr< fv::option >	release (const label i)
	Release ownership of the pointer at the given position. More...

void	transfer (PtrList< fv::option > &list)
	Transfer into this list and annul the argument list. More...

void	operator= (const PtrList< fv::option > &list)
	Copy assignment. More...

void	operator= (PtrList< fv::option > &&list)
	Move assignment. More...

Public Member Functions inherited from UPtrList< T >
constexpr	UPtrList () noexcept
	Default construct. More...

	UPtrList (const label len)
	Construct with specified size, each element initialized to nullptr. More...

	UPtrList (const UPtrList< T > &list)
	Copy construct (shallow copies addresses) More...

	UPtrList (UPtrList< T > &&list)
	Move construct. More...

	UPtrList (UPtrList< T > &list, bool reuse)
	Construct as shallow copy or re-use as specified. More...

	UPtrList (PtrList< T > &list)
	Shallow copy from PtrList. More...

	UPtrList (const UList< T * > &list)
	Construct from UList of pointers (shallow copy) More...

	UPtrList (UList< T > &list)
	Construct from UList, taking the address of each list element. More...

label	size () const noexcept
	The number of elements in the list. More...

bool	empty () const noexcept
	True if the list 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...

const T *	test (const label i) const

T *	get (const label i)

const T *	get (const label i) const

const T *	set (const label i) const

void	clear ()
	Set list size to zero. More...

void	resize (const label newLen)
	Change the size of the list. More...

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

label	squeezeNull ()
	Squeeze out intermediate nullptr entries in the list of pointers. More...

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

void	append (UPtrList< T > &&other)
	Move append another list to the end of this list. More...

void	swap (UPtrList< T > &list)
	Swap content. More...

void	transfer (UPtrList< T > &list)
	Transfer contents into this list and annul the argument. More...

T *	set (const label i, T *ptr)

void	reorder (const labelUList &oldToNew, const bool check=false)

void	sortOrder (const labelUList &order, const bool check=false)

void	checkNonNull () const
	Check and raise FatalError if any nullptr exists in the list. More...

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

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

const T *	operator() (const label i) const
	Return const pointer to the element - same as get(). More...

void	operator= (const UPtrList< T > &list)
	Copy assignment (shallow copies addresses) More...

void	operator= (UPtrList< T > &&list)
	Move assignment. More...

T **	begin_ptr () noexcept
	Iterator to begin of raw pointers traversal (use with caution) More...

T **	end_ptr () noexcept
	Iterator beyond end of raw pointers traversal (use with caution) More...

iterator	begin () noexcept
	Return an iterator to begin of UPtrList traversal. More...

iterator	end () noexcept
	Return iterator beyond end of UPtrList traversal. More...

const_iterator	cbegin () const noexcept
	Return const_iterator to begin of UPtrList traversal. More...

const_iterator	cend () const noexcept
	Return const_iterator beyond end of UPtrList traversal. More...

const_iterator	begin () const noexcept
	Return const_iterator to begin of UPtrList traversal. More...

const_iterator	end () const noexcept
	Return const_iterator beyond end of UPtrList traversal. More...

Protected Member Functions
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< fv::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 Member Functions inherited from UPtrList< T >
void	setAddressableSize (const label n) noexcept
	Adjust addressable size. More...

	UPtrList (Detail::PtrListDetail< T > &&ptrs)
	Low-level move construct. More...

Static Protected Member Functions
static const dictionary &	optionsDict (const dictionary &dict)
	Return "options" sub-dictionary (if present) or return dict. 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...

Protected Attributes inherited from UPtrList< T >
Detail::PtrListDetail< T >	ptrs_
	The list of pointers. More...

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

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

typedef T &	reference
	A non-const reference to the value_type. More...

typedef const T &	const_reference
	A const reference to the value_type. More...

Detailed Description

List of finite volume options.

SourceFile optionList.C

Definition at line 69 of file fvOptionList.H.

Constructor & Destructor Documentation

◆ optionList() [1/3]

optionList ( const optionList & )

protecteddelete

No copy construct.

◆ optionList() [2/3]

optionList ( const fvMesh & mesh )

explicit

Default construct from mesh.

Definition at line 94 of file fvOptionList.C.

References fv().

Here is the call graph for this function:

◆ optionList() [3/3]

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

Construct from mesh and dictionary.

Definition at line 84 of file fvOptionList.C.

References dict, fv(), 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 )

staticprotected

Return "options" sub-dictionary (if present) or return dict.

Definition at line 45 of file fvOptionList.C.

References dict, keyType::LITERAL, and dictionary::optionalSubDict().

Referenced by optionList::optionList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readOptions()

bool readOptions ( const dictionary & dict )

protected

Read options dictionary.

Definition at line 56 of file fvOptionList.C.

References dict, option::name(), and option::read().

Here is the call graph for this function:

◆ checkApplied()

void checkApplied ( ) const

protected

Check that all sources have been applied.

Definition at line 70 of file fvOptionList.C.

References option::checkApplied().

Referenced by optionList::source().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ source()

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

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

References dict, Foam::name(), Time::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 136 of file fvOptionList.C.

References option::applyToField().

Here is the call graph for this function:

◆ operator()() [1/9]

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

Return source for equation.

◆ operator()() [2/9]

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

Return source for equation with specified name.

◆ operator()() [3/9]

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

Return source for equation.

◆ operator()() [4/9]

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

Return source for equation with specified name.

◆ operator()() [5/9]

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

Return source for equation.

◆ operator()() [6/9]

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/9]

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

Return source for equation.

◆ operator()() [8/9]

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

Return source for equation.

◆ operator()() [9/9]

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

Return source for equation.

◆ d2dt2() [1/2]

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

Return source for equation with second time derivative.

◆ d2dt2() [2/2]

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

References addProfiling, option::applyToField(), option::constrain(), Foam::endl(), Foam::Info, option::isActive(), option::name(), fvMatrix< Type >::psi(), and option::setApplied().

Referenced by kOmegaSSTBase< BasicEddyViscosityModel >::correct(), incompressiblePrimalSolver::correctBoundaryConditions(), adjointSimple::mainIter(), simple::mainIter(), displacementComponentLaplacianFvMotionSolver::solve(), velocityComponentLaplacianFvMotionSolver::solve(), displacementLaplacianFvMotionSolver::solve(), displacementSBRStressFvMotionSolver::solve(), solidBodyDisplacementLaplacianFvMotionSolver::solve(), surfaceAlignedSBRStressFvMotionSolver::solve(), and velocityLaplacianFvMotionSolver::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 354 of file fvOptionListTemplates.C.

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

Referenced by kOmegaSSTBase< BasicEddyViscosityModel >::correct(), adjointSimple::mainIter(), simple::mainIter(), displacementComponentLaplacianFvMotionSolver::solve(), velocityComponentLaplacianFvMotionSolver::solve(), displacementLaplacianFvMotionSolver::solve(), displacementSBRStressFvMotionSolver::solve(), solidBodyDisplacementLaplacianFvMotionSolver::solve(), surfaceAlignedSBRStressFvMotionSolver::solve(), and velocityLaplacianFvMotionSolver::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ postProcessSens()

void postProcessSens	(	Field< Type > &	sensField,
		const word &	fieldName = `word::null`,
		const word &	designVariablesName = `word::null`
	)

Post process sensitivity field related to the fvOption.

Definition at line 397 of file fvOptionListTemplates.C.

References addProfiling, option::applyToField(), Foam::endl(), Foam::Info, option::isActive(), option::name(), and option::postProcessSens().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented in options.

Definition at line 152 of file fvOptionList.C.

References dict.

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Write data to Ostream.

Definition at line 158 of file fvOptionList.C.

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

Referenced by Foam::operator<<(), and optionList::writeData().

Here is the call graph for this function:

Here is the caller 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 78 of file fvOptionList.H.

◆ checkTimeIndex_

label checkTimeIndex_

protected

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

Definition at line 81 of file fvOptionList.H.

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

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

◆ source()

◆ operator=()

◆ TypeName()

◆ reset()

◆ appliesToField()

◆ operator()() [1/9]

◆ operator()() [2/9]

◆ operator()() [3/9]

◆ operator()() [4/9]

◆ operator()() [5/9]

◆ operator()() [6/9]

◆ operator()() [7/9]

◆ operator()() [8/9]

◆ operator()() [9/9]

◆ d2dt2() [1/2]

◆ d2dt2() [2/2]

◆ constrain()

◆ correct()

◆ postProcessSens()

◆ read()

◆ writeData()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ mesh_

◆ checkTimeIndex_