Base abstract class for handling finite area options (i.e. faOption). More...

Inheritance diagram for option:

Collaboration diagram for option:

[legend]

Classes
class	iNew

Public Member Functions
	TypeName ("option")

	declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvPatch &patch),(name, modelType, dict, patch))

	option (const word &name, const word &modelType, const dictionary &dict, const fvPatch &patch)

autoPtr< option >	clone () const

virtual	~option ()=default

const word &	name () const noexcept

const fvMesh &	mesh () const noexcept

const fvPatch &	patch () const noexcept

const dictionary &	coeffs () const noexcept

bool	active () const noexcept

void	setApplied (const label fieldi)

const word &	regionName () const noexcept

const faMesh &	regionMesh () const

const volSurfaceMapping &	vsm () const

bool	active (const bool on) noexcept

virtual bool	isActive ()

virtual label	applyToField (const word &fieldName) const

virtual void	checkApplied () const

virtual void	addSup (const areaScalarField &h, faMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const areaScalarField &h, faMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (const areaScalarField &h, faMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const areaScalarField &h, faMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const areaScalarField &h, faMatrix< tensor > &eqn, const label fieldi)

virtual void	addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< tensor > &eqn, const label fieldi)

virtual void	constrain (faMatrix< scalar > &eqn, const label fieldi)

virtual void	constrain (faMatrix< vector > &eqn, const label fieldi)

virtual void	constrain (faMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	constrain (faMatrix< symmTensor > &eqn, const label fieldi)

virtual void	constrain (faMatrix< tensor > &eqn, const label fieldi)

virtual void	correct (areaScalarField &field)

virtual void	correct (areaVectorField &field)

virtual void	correct (areaSphericalTensorField &field)

virtual void	correct (areaSymmTensorField &field)

virtual void	correct (areaTensorField &field)

virtual void	writeHeader (Ostream &) const

virtual void	writeFooter (Ostream &) const

virtual void	writeData (Ostream &) const

virtual bool	read (const dictionary &dict)

Static Public Member Functions
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvPatch &patch)

Public Attributes
bool	log

Protected Member Functions
void	resetApplied ()

Protected Attributes
const word	name_

const word	modelType_

const fvMesh &	mesh_

const fvPatch &	patch_

dictionary	dict_

dictionary	coeffs_

wordList	fieldNames_

List< bool >	applied_

word	regionName_

Detailed Description

Base abstract class for handling finite area options (i.e. faOption).

Usage

Minimal example by using constant/faOptions:

<userDefinedName1>
{
    // Mandatory entries (unmodifiable)
    type              <faOptionName>;

    // Mandatory entries (runtime modifiable)
    region            <regionName>;

    // Optional entries (unmodifiable/runtime modifiable)
    <faOption>Coeffs
    {
        // subdictionary entries
    }

    // Optional entries (runtime modifiable)
    active            true;
    log               true;
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Name of operand faOption	word	yes	-
`region`	Name of operand region	word	yes	-
`<faOption>Coeffs`	Dictionary containing settings of the selected faOption settings	dictionary	no	-
`active`	Flag to (de)activate faOption	bool	no	true
`log`	Flag to log faOption-related info	bool	no	true

Note

Source/sink options are to be added to the right-hand side of equations.

Source files

Definition at line 129 of file faOption.H.

Constructor & Destructor Documentation

◆ option()

option	(	const word &	name,
		const word &	modelType,
		const dictionary &	dict,
		const fvPatch &	patch
	)

Definition at line 48 of file faOption.C.

References Foam::decrIndent(), Foam::endl(), Foam::incrIndent(), Foam::indent(), and Log.

Here is the call graph for this function:

◆ ~option()

virtual ~option ( )

virtualdefault

Member Function Documentation

◆ resetApplied()

void resetApplied ( )

protected

Definition at line 38 of file faOption.C.

References option::applied_, option::fieldNames_, and List::resize().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "option" )

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		option	,
		dictionary	,
		(const word &name, const word &modelType, const dictionary &dict, const fvPatch &patch)	,
		(name, modelType, dict, patch)
	)

◆ clone()

autoPtr<option> clone ( ) const

inline

Definition at line 228 of file faOption.H.

References NotImplemented.

◆ New()

Foam::autoPtr< Foam::fa::option > New	(	const word &	name,
		const dictionary &	dict,
		const fvPatch &	patch
	)

static

Definition at line 76 of file faOption.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::get(), Foam::indent(), Foam::Info, Foam::name(), Foam::nl, and Foam::foamVersion::patch.

Referenced by option::iNew::operator()(), and optionList::reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ name()

const Foam::word & name ( ) const

inlinenoexcept

Definition at line 23 of file faOptionI.H.

References option::name_.

Referenced by optionList::correct(), optionList::operator()(), optionList::readOptions(), and optionList::source().

Here is the caller graph for this function:

◆ mesh()

const Foam::fvMesh & mesh ( ) const

inlinenoexcept

Definition at line 29 of file faOptionI.H.

◆ patch()

const Foam::fvPatch & patch ( ) const

inlinenoexcept

Definition at line 35 of file faOptionI.H.

◆ coeffs()

const Foam::dictionary & coeffs ( ) const

inlinenoexcept

Definition at line 41 of file faOptionI.H.

◆ active() [1/2]

bool active ( ) const

inlinenoexcept

Definition at line 47 of file faOptionI.H.

◆ setApplied()

void setApplied ( const label fieldi )

inline

Definition at line 61 of file faOptionI.H.

Referenced by optionList::correct(), optionList::operator()(), and optionList::source().

Here is the caller graph for this function:

◆ regionName()

const Foam::word & regionName ( ) const

inlinenoexcept

Definition at line 67 of file faOptionI.H.

◆ regionMesh()

const Foam::faMesh & regionMesh ( ) const

inline

Definition at line 73 of file faOptionI.H.

◆ vsm()

const Foam::volSurfaceMapping & vsm ( ) const

inline

Definition at line 83 of file faOptionI.H.

◆ active() [2/2]

bool active ( const bool on )

inlinenoexcept

Definition at line 53 of file faOptionI.H.

◆ isActive()

bool isActive ( )

virtual

Reimplemented in faceSetOption.

Definition at line 112 of file faOption.C.

Referenced by optionList::correct(), faceSetOption::isActive(), optionList::operator()(), and optionList::source().

Here is the caller graph for this function:

◆ applyToField()

Foam::label applyToField ( const word & fieldName ) const

virtual

Definition at line 118 of file faOption.C.

Referenced by optionList::appliesToField(), optionList::correct(), optionList::operator()(), and optionList::source().

Here is the caller graph for this function:

◆ checkApplied()

void checkApplied ( ) const

virtual

Definition at line 124 of file faOption.C.

References Foam::endl(), forAll, and WarningInFunction.

Referenced by optionList::checkApplied().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSup() [1/10]

void addSup	(	const areaScalarField &	h,
		faMatrix< scalar > &	eqn,
		const label	fieldi
	)

virtual

Reimplemented in externalFileSource.

Definition at line 139 of file faOption.C.

Referenced by optionList::operator()(), and optionList::source().

Here is the caller graph for this function:

◆ addSup() [2/10]

void addSup	(	const areaScalarField &	h,
		faMatrix< vector > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 148 of file faOption.C.

◆ addSup() [3/10]

void addSup	(	const areaScalarField &	h,
		faMatrix< symmTensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 166 of file faOption.C.

◆ addSup() [4/10]

void addSup	(	const areaScalarField &	h,
		faMatrix< sphericalTensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 157 of file faOption.C.

◆ addSup() [5/10]

void addSup	(	const areaScalarField &	h,
		faMatrix< tensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 175 of file faOption.C.

◆ addSup() [6/10]

void addSup	(	const areaScalarField &	h,
		const areaScalarField &	rho,
		faMatrix< scalar > &	eqn,
		const label	fieldi
	)

virtual

Reimplemented in externalHeatFluxSource, jouleHeatingSource, and contactHeatFluxSource.

Definition at line 184 of file faOption.C.

◆ addSup() [7/10]

void addSup	(	const areaScalarField &	h,
		const areaScalarField &	rho,
		faMatrix< vector > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 194 of file faOption.C.

◆ addSup() [8/10]

void addSup	(	const areaScalarField &	h,
		const areaScalarField &	rho,
		faMatrix< symmTensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 214 of file faOption.C.

◆ addSup() [9/10]

void addSup	(	const areaScalarField &	h,
		const areaScalarField &	rho,
		faMatrix< sphericalTensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 204 of file faOption.C.

◆ addSup() [10/10]

void addSup	(	const areaScalarField &	h,
		const areaScalarField &	rho,
		faMatrix< tensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 224 of file faOption.C.

◆ constrain() [1/5]

void constrain	(	faMatrix< scalar > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 233 of file faOption.C.

◆ constrain() [2/5]

void constrain	(	faMatrix< vector > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 237 of file faOption.C.

◆ constrain() [3/5]

void constrain	(	faMatrix< sphericalTensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 242 of file faOption.C.

◆ constrain() [4/5]

void constrain	(	faMatrix< symmTensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 250 of file faOption.C.

◆ constrain() [5/5]

void constrain	(	faMatrix< tensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 257 of file faOption.C.

◆ correct() [1/5]

void correct ( areaScalarField & field )

virtual

Definition at line 261 of file faOption.C.

Referenced by optionList::correct().

Here is the caller graph for this function:

◆ correct() [2/5]

void correct ( areaVectorField & field )

virtual

Reimplemented in limitVelocity.

Definition at line 265 of file faOption.C.

◆ correct() [3/5]

virtual void correct ( areaSphericalTensorField & field )

virtual

Reimplemented in limitVelocity.

◆ correct() [4/5]

virtual void correct ( areaSymmTensorField & field )

virtual

Reimplemented in limitVelocity.

◆ correct() [5/5]

virtual void correct ( areaTensorField & field )

virtual

Reimplemented in limitVelocity.

◆ writeHeader()

void writeHeader ( Ostream & os ) const

virtual

Definition at line 25 of file faOptionIO.C.

References option::name_, and os().

Referenced by optionList::writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFooter()

void writeFooter ( Ostream & os ) const

virtual

Definition at line 31 of file faOptionIO.C.

References os().

Referenced by optionList::writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Definition at line 37 of file faOptionIO.C.

References Foam::nl, os(), and Foam::type().

Referenced by optionList::writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented in externalHeatFluxSource, jouleHeatingSource, faceSetOption, contactHeatFluxSource, externalFileSource, and limitVelocity.

Definition at line 47 of file faOptionIO.C.

References dict.

Referenced by externalFileSource::read(), contactHeatFluxSource::read(), faceSetOption::read(), jouleHeatingSource::read(), externalHeatFluxSource::read(), and optionList::readOptions().

Here is the caller graph for this function:

Member Data Documentation

◆ name_

const word name_

protected

Definition at line 142 of file faOption.H.

Referenced by option::name(), and option::writeHeader().

◆ modelType_

const word modelType_

protected

Definition at line 145 of file faOption.H.

◆ mesh_

const fvMesh& mesh_

protected

Definition at line 148 of file faOption.H.

Referenced by externalHeatFluxSource::read().

◆ patch_

const fvPatch& patch_

protected

Definition at line 151 of file faOption.H.

◆ dict_

dictionary dict_

protected

Definition at line 154 of file faOption.H.

◆ coeffs_

dictionary coeffs_

protected

Definition at line 157 of file faOption.H.

Referenced by limitVelocity::read().

◆ fieldNames_

wordList fieldNames_

protected

Definition at line 160 of file faOption.H.

Referenced by option::resetApplied().

◆ applied_

List<bool> applied_

protected

Definition at line 163 of file faOption.H.

Referenced by option::resetApplied().

◆ regionName_

word regionName_

protected

Definition at line 166 of file faOption.H.

◆ log

bool log

Definition at line 192 of file faOption.H.

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

src/faOptions/faOption/faOption.H
src/faOptions/faOption/faOption.C
src/faOptions/faOption/faOptionI.H
src/faOptions/faOption/faOptionIO.C

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ option()

◆ ~option()

Member Function Documentation

◆ resetApplied()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ name()

◆ mesh()

◆ patch()

◆ coeffs()

◆ active() [1/2]

◆ setApplied()

◆ regionName()

◆ regionMesh()

◆ vsm()

◆ active() [2/2]

◆ isActive()

◆ applyToField()

◆ checkApplied()

◆ addSup() [1/10]

◆ addSup() [2/10]

◆ addSup() [3/10]

◆ addSup() [4/10]

◆ addSup() [5/10]

◆ addSup() [6/10]

◆ addSup() [7/10]

◆ addSup() [8/10]

◆ addSup() [9/10]

◆ addSup() [10/10]

◆ constrain() [1/5]

◆ constrain() [2/5]

◆ constrain() [3/5]

◆ constrain() [4/5]

◆ constrain() [5/5]

◆ correct() [1/5]

◆ correct() [2/5]

◆ correct() [3/5]

◆ correct() [4/5]

◆ correct() [5/5]

◆ writeHeader()

◆ writeFooter()

◆ writeData()

◆ read()

Member Data Documentation

◆ name_

◆ modelType_

◆ mesh_

◆ patch_

◆ dict_

◆ coeffs_

◆ fieldNames_

◆ applied_

◆ regionName_

◆ log