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

Inheritance diagram for option:

Collaboration diagram for option:

[legend]

Classes
class	iNew
	Return pointer to new faOption object created on the freestore from an Istream. More...

Public Member Functions
	TypeName ("option")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))

	option (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...

autoPtr< option >	clone () const
	Return clone. More...

virtual	~option ()=default
	Destructor. More...

const word &	name () const noexcept
	Return const access to the source name. More...

const fvMesh &	mesh () const noexcept
	Return const access to the mesh database. More...

const dictionary &	coeffs () const noexcept
	Return dictionary. More...

bool	active () const noexcept
	True if source is active. More...

void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi. More...

const word &	regionName () const noexcept
	The region name. More...

const faMesh &	regionMesh () const
	Return the region mesh database (demand-driven) More...

const volSurfaceMapping &	vsm () const
	Return volSurfaceMapping (demand-driven) More...

bool	active (const bool on) noexcept
	Change source active flag, return previous value. More...

virtual bool	isActive ()
	Is the source active? More...

virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list. More...

virtual void	checkApplied () const
	Check that the source has been applied. More...

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
	Write the source header information. More...

virtual void	writeFooter (Ostream &) const
	Write the source footer information. More...

virtual void	writeData (Ostream &) const
	Write the source properties. More...

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

Static Public Member Functions
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected faOption model. More...

Public Attributes
bool	log
	Switch write log to Info. More...

Protected Member Functions
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries. More...

Protected Attributes
const word	name_
	Source name. More...

const word	modelType_
	Model type. More...

const fvMesh &	mesh_
	Reference to the mesh database. More...

dictionary	dict_
	Top level source dictionary. More...

dictionary	coeffs_
	Dictionary containing source coefficients. More...

wordList	fieldNames_
	Field names to apply source to - populated by derived models. More...

List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry. More...

word	regionName_
	Region name (finite-area) More...

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 fvMesh &	mesh
	)

Construct from components.

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

Destructor.

Member Function Documentation

◆ resetApplied()

void resetApplied ( )

protected

Resize/reset applied flag list for all fieldNames_ entries.

Definition at line 38 of file faOption.C.

References option::applied_, option::fieldNames_, List< T >::resize_nocopy(), and UList< T >::size().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "option" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		option	,
		dictionary	,
		(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)	,
		(name, modelType, dict, mesh)
	)

◆ clone()

autoPtr<option> clone ( ) const

inline

Return clone.

Definition at line 259 of file faOption.H.

References NotImplemented.

◆ New()

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

static

Return a reference to the selected faOption model.

Definition at line 75 of file faOption.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), Foam::indent(), Foam::Info, mesh, and Foam::name().

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

Return const access to the source name.

Definition at line 23 of file faOptionI.H.

References option::name_.

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

Here is the caller graph for this function:

◆ mesh()

const Foam::fvMesh & mesh ( ) const

inlinenoexcept

Return const access to the mesh database.

Definition at line 29 of file faOptionI.H.

◆ coeffs()

const Foam::dictionary & coeffs ( ) const

inlinenoexcept

Return dictionary.

Definition at line 35 of file faOptionI.H.

◆ active() [1/2]

bool active ( ) const

inlinenoexcept

True if source is active.

Definition at line 41 of file faOptionI.H.

◆ setApplied()

void setApplied ( const label fieldi )

inline

Set the applied flag to true for field index fieldi.

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

The region name.

Definition at line 61 of file faOptionI.H.

◆ regionMesh()

const Foam::faMesh & regionMesh ( ) const

inline

Return the region mesh database (demand-driven)

Definition at line 67 of file faOptionI.H.

◆ vsm()

const Foam::volSurfaceMapping & vsm ( ) const

inline

Return volSurfaceMapping (demand-driven)

Definition at line 77 of file faOptionI.H.

◆ active() [2/2]

bool active ( const bool on )

inlinenoexcept

Change source active flag, return previous value.

Definition at line 47 of file faOptionI.H.

◆ isActive()

bool isActive ( )

virtual

Is the source active?

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

Return index of field name if found in fieldNames list.

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

Check that the source has been applied.

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

Reimplemented in limitHeight.

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]

void correct ( areaSphericalTensorField & field )

virtual

Definition at line 269 of file faOption.C.

◆ correct() [4/5]

void correct ( areaSymmTensorField & field )

virtual

Definition at line 273 of file faOption.C.

◆ correct() [5/5]

void correct ( areaTensorField & field )

virtual

Definition at line 277 of file faOption.C.

◆ writeHeader()

void writeHeader ( Ostream & os ) const

virtual

Write the source header information.

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

Write the source footer information.

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

Write the source properties.

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

Read source dictionary.

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

Definition at line 47 of file faOptionIO.C.

References dict.

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

Here is the caller graph for this function:

Member Data Documentation

◆ name_

const word name_

protected

Source name.

Definition at line 146 of file faOption.H.

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

◆ modelType_

const word modelType_

protected

Model type.

Definition at line 151 of file faOption.H.

◆ mesh_

const fvMesh& mesh_

protected

Reference to the mesh database.

Definition at line 156 of file faOption.H.

Referenced by externalHeatFluxSource::read().

◆ dict_

dictionary dict_

protected

Top level source dictionary.

Definition at line 161 of file faOption.H.

◆ coeffs_

dictionary coeffs_

protected

Dictionary containing source coefficients.

Definition at line 166 of file faOption.H.

Referenced by limitVelocity::read(), and limitHeight::read().

◆ fieldNames_

wordList fieldNames_

protected

Field names to apply source to - populated by derived models.

Definition at line 171 of file faOption.H.

Referenced by limitHeight::read(), and option::resetApplied().

◆ applied_

List<bool> applied_

protected

Applied flag list - corresponds to each fieldNames_ entry.

Definition at line 176 of file faOption.H.

Referenced by limitHeight::read(), and option::resetApplied().

◆ regionName_

word regionName_

protected

Region name (finite-area)

Definition at line 181 of file faOption.H.

◆ log

bool log

Switch write log to Info.

Definition at line 217 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()

◆ 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_

◆ dict_

◆ coeffs_

◆ fieldNames_

◆ applied_

◆ regionName_

◆ log