Base abstract class for handling finite volume options (i.e. fvOption). More...

Inheritance diagram for option:

[legend]

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 fvMesh &mesh),(name, modelType, dict, mesh))

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

autoPtr< option >	clone () const

virtual	~option ()=default

const word &	name () const noexcept

const fvMesh &	mesh () const noexcept

const dictionary &	coeffs () const noexcept

bool	active () const noexcept

void	setApplied (const label fieldi)

bool	active (const bool on) noexcept

virtual bool	isActive ()

virtual label	applyToField (const word &fieldName) const

virtual void	checkApplied () const

virtual void	addSup (fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< tensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)

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

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

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

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

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

virtual void	correct (volScalarField &field)

virtual void	correct (volVectorField &field)

virtual void	correct (volSphericalTensorField &field)

virtual void	correct (volSymmTensorField &field)

virtual void	correct (volTensorField &field)

virtual void	postProcessSens (scalarField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)

virtual void	postProcessSens (vectorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)

virtual void	postProcessSens (tensorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)

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

Public Attributes
bool	log

Protected Member Functions
void	resetApplied ()

Protected Attributes
const word	name_

const word	modelType_

const fvMesh &	mesh_

dictionary	dict_

dictionary	coeffs_

wordList	fieldNames_

List< bool >	applied_

bool	active_

Detailed Description

Base abstract class for handling finite volume options (i.e. fvOption).

Usage

Minimal example by using constant/fvOptions:

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

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

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

where the entries mean:

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

Source files

Definition at line 122 of file fvOption.H.

Constructor & Destructor Documentation

◆ option()

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

Definition at line 51 of file fvOption.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 41 of file fvOption.C.

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

Referenced by actuationDiskSource::actuationDiskSource(), atmBuoyancyTurbSource::atmBuoyancyTurbSource(), atmCoriolisUSource::atmCoriolisUSource(), atmLengthScaleTurbSource::atmLengthScaleTurbSource(), atmPlantCanopyTurbSource::atmPlantCanopyTurbSource(), buoyancyTurbSource::buoyancyTurbSource(), directionalPressureGradientExplicitSource::directionalPressureGradientExplicitSource(), effectivenessHeatExchangerSource::effectivenessHeatExchangerSource(), interRegionExplicitPorositySource::interRegionExplicitPorositySource(), interRegionHeatTransferModel::interRegionHeatTransferModel(), jouleHeatingSource::jouleHeatingSource(), multiphaseMangrovesSource::read(), multiphaseMangrovesTurbulenceModel::read(), velocityDampingConstraint::read(), explicitPorositySource::read(), acousticDampingSource::read(), rotorDiskSource::read(), solidificationMeltingSource::solidificationMeltingSource(), and viscousDissipation::viscousDissipation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "option" )

◆ 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

Definition at line 198 of file fvOption.H.

References NotImplemented.

◆ New()

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

static

Definition at line 75 of file fvOption.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

Definition at line 24 of file fvOptionI.H.

References option::name_.

Referenced by atmNutSource::correct(), optionList::correct(), multiphaseStabilizedTurbulence::correct(), optionList::operator()(), optionList::postProcessSens(), optionList::readOptions(), interRegionHeatTransferModel::setNbrModel(), and optionList::source().

Here is the caller graph for this function:

◆ mesh()

const Foam::fvMesh & mesh ( ) const

inlinenoexcept

Definition at line 30 of file fvOptionI.H.

◆ coeffs()

const Foam::dictionary & coeffs ( ) const

inlinenoexcept

Definition at line 36 of file fvOptionI.H.

◆ active() [1/2]

bool active ( ) const

inlinenoexcept

Definition at line 42 of file fvOptionI.H.

◆ setApplied()

void setApplied ( const label fieldi )

inline

Definition at line 56 of file fvOptionI.H.

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

Here is the caller graph for this function:

◆ active() [2/2]

bool active ( const bool on )

inlinenoexcept

Definition at line 48 of file fvOptionI.H.

◆ isActive()

bool isActive ( )

virtual

Reimplemented in cellSetOption.

Definition at line 112 of file fvOption.C.

Referenced by optionList::correct(), cellSetOption::isActive(), optionList::operator()(), optionList::postProcessSens(), 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 fvOption.C.

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

Here is the caller graph for this function:

◆ checkApplied()

void checkApplied ( ) const

virtual

Definition at line 124 of file fvOption.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/15]

void addSup	(	fvMatrix< scalar > &	eqn,
		const label	fieldi
	)

virtual

Reimplemented in effectivenessHeatExchangerSource, solidificationMeltingSource, buoyancyTurbSource, atmBuoyancyTurbSource, interRegionHeatTransferModel, atmLengthScaleTurbSource, atmAmbientTurbSource, multiphaseStabilizedTurbulence, atmPlantCanopyTurbSource, VoFSolidificationMeltingSource, atmPlantCanopyTSource, and multiphaseMangrovesTurbulenceModel.

Definition at line 139 of file fvOption.C.

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

Here is the caller graph for this function:

◆ addSup() [2/15]

void addSup	(	fvMatrix< vector > &	eqn,
		const label	fieldi
	)

virtual

Reimplemented in actuationDiskSource, rotorDiskSource, solidificationMeltingSource, directionalPressureGradientExplicitSource, acousticDampingSource, atmCoriolisUSource, meanVelocityForce, interRegionExplicitPorositySource, explicitPorositySource, radialActuationDiskSource, VoFSolidificationMeltingSource, buoyancyForce, atmPlantCanopyUSource, tabulatedAccelerationSource, and multiphaseMangrovesSource.

Definition at line 147 of file fvOption.C.

◆ addSup() [3/15]

void addSup	(	fvMatrix< symmTensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 163 of file fvOption.C.

◆ addSup() [4/15]

void addSup	(	fvMatrix< sphericalTensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 155 of file fvOption.C.

◆ addSup() [5/15]

void addSup	(	fvMatrix< tensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 171 of file fvOption.C.

◆ addSup() [6/15]

void addSup	(	const volScalarField &	rho,
		fvMatrix< scalar > &	eqn,
		const label	fieldi
	)

virtual

Reimplemented in effectivenessHeatExchangerSource, solidificationMeltingSource, buoyancyTurbSource, jouleHeatingSource, atmBuoyancyTurbSource, interRegionHeatTransferModel, atmLengthScaleTurbSource, atmAmbientTurbSource, multiphaseStabilizedTurbulence, atmPlantCanopyTurbSource, VoFSolidificationMeltingSource, viscousDissipation, buoyancyEnergy, atmPlantCanopyTSource, multiphaseMangrovesTurbulenceModel, and radiation.

Definition at line 179 of file fvOption.C.

◆ addSup() [7/15]

void addSup	(	const volScalarField &	rho,
		fvMatrix< vector > &	eqn,
		const label	fieldi
	)

virtual

Reimplemented in actuationDiskSource, rotorDiskSource, solidificationMeltingSource, directionalPressureGradientExplicitSource, acousticDampingSource, atmCoriolisUSource, meanVelocityForce, interRegionExplicitPorositySource, VoFSolidificationMeltingSource, explicitPorositySource, radialActuationDiskSource, buoyancyForce, atmPlantCanopyUSource, tabulatedAccelerationSource, and multiphaseMangrovesSource.

Definition at line 188 of file fvOption.C.

◆ addSup() [8/15]

void addSup	(	const volScalarField &	rho,
		fvMatrix< symmTensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 206 of file fvOption.C.

◆ addSup() [9/15]

void addSup	(	const volScalarField &	rho,
		fvMatrix< sphericalTensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 197 of file fvOption.C.

◆ addSup() [10/15]

void addSup	(	const volScalarField &	rho,
		fvMatrix< tensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 215 of file fvOption.C.

◆ addSup() [11/15]

void addSup	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		fvMatrix< scalar > &	eqn,
		const label	fieldi
	)

virtual

Reimplemented in buoyancyTurbSource, atmBuoyancyTurbSource, atmLengthScaleTurbSource, atmAmbientTurbSource, atmPlantCanopyTurbSource, and atmPlantCanopyTSource.

Definition at line 224 of file fvOption.C.

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

◆ addSup() [12/15]

void addSup	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		fvMatrix< vector > &	eqn,
		const label	fieldi
	)

virtual

Reimplemented in actuationDiskSource, acousticDampingSource, atmCoriolisUSource, explicitPorositySource, and atmPlantCanopyUSource.

Definition at line 236 of file fvOption.C.

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

◆ addSup() [13/15]

void addSup	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		fvMatrix< symmTensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 260 of file fvOption.C.

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

◆ addSup() [14/15]

void addSup	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		fvMatrix< sphericalTensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 248 of file fvOption.C.

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

◆ addSup() [15/15]

void addSup	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		fvMatrix< tensor > &	eqn,
		const label	fieldi
	)

virtual

Definition at line 272 of file fvOption.C.

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

◆ constrain() [1/5]

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

virtual

Reimplemented in fixedTemperatureConstraint.

Definition at line 283 of file fvOption.C.

◆ constrain() [2/5]

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

virtual

Reimplemented in directionalPressureGradientExplicitSource, meanVelocityForce, and velocityDampingConstraint.

Definition at line 287 of file fvOption.C.

◆ constrain() [3/5]

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

virtual

Definition at line 292 of file fvOption.C.

◆ constrain() [4/5]

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

virtual

Definition at line 300 of file fvOption.C.

◆ constrain() [5/5]

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

virtual

Definition at line 307 of file fvOption.C.

◆ correct() [1/5]

void correct ( volScalarField & field )

virtual

Reimplemented in limitTemperature, multiphaseStabilizedTurbulence, and atmNutSource.

Definition at line 311 of file fvOption.C.

Referenced by optionList::correct().

Here is the caller graph for this function:

◆ correct() [2/5]

void correct ( volVectorField & field )

virtual

Reimplemented in directionalPressureGradientExplicitSource, meanVelocityForce, and limitVelocity.

Definition at line 315 of file fvOption.C.

◆ correct() [3/5]

void correct ( volSphericalTensorField & field )

virtual

Definition at line 319 of file fvOption.C.

◆ correct() [4/5]

virtual void correct ( volSymmTensorField & field )

virtual

◆ correct() [5/5]

virtual void correct ( volTensorField & field )

virtual

◆ postProcessSens() [1/3]

void postProcessSens	(	scalarField &	sensField,
		const word &	fieldName = `word::null`,
		const word &	designVariablesName = `word::null`
	)

virtual

Definition at line 332 of file fvOption.C.

Referenced by optionList::postProcessSens().

Here is the caller graph for this function:

◆ postProcessSens() [2/3]

void postProcessSens	(	vectorField &	sensField,
		const word &	fieldName = `word::null`,
		const word &	designVariablesName = `word::null`
	)

virtual

Definition at line 341 of file fvOption.C.

◆ postProcessSens() [3/3]

void postProcessSens	(	tensorField &	sensField,
		const word &	fieldName = `word::null`,
		const word &	designVariablesName = `word::null`
	)

virtual

Definition at line 350 of file fvOption.C.

◆ writeHeader()

void writeHeader ( Ostream & os ) const

virtual

Definition at line 26 of file fvOptionIO.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 32 of file fvOptionIO.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

Reimplemented in directionalPressureGradientExplicitSource, and velocityDampingConstraint.

Definition at line 38 of file fvOptionIO.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 actuationDiskSource, rotorDiskSource, effectivenessHeatExchangerSource, solidificationMeltingSource, tabulatedNTUHeatTransfer, directionalPressureGradientExplicitSource, buoyancyTurbSource, atmBuoyancyTurbSource, jouleHeatingSource, cellSetOption, interRegionHeatTransferModel, atmLengthScaleTurbSource, atmAmbientTurbSource, acousticDampingSource, variableHeatTransfer, atmCoriolisUSource, CodedSource< Type >, multiphaseStabilizedTurbulence, meanVelocityForce, atmPlantCanopyTurbSource, explicitPorositySource, interRegionExplicitPorositySource, VoFSolidificationMeltingSource, radialActuationDiskSource, fixedTemperatureConstraint, viscousDissipation, velocityDampingConstraint, buoyancyEnergy, atmPlantCanopyTSource, atmPlantCanopyUSource, PhaseLimitStabilization< Type >, tabulatedHeatTransfer, buoyancyForce, tabulatedAccelerationSource, limitTemperature, FixedValueConstraint< Type >, interRegionOption, limitVelocity, multiphaseMangrovesTurbulenceModel, atmNutSource, multiphaseMangrovesSource, radiation, and constantHeatTransfer.

Definition at line 48 of file fvOptionIO.C.

References dict, and Foam::log().

Referenced by radiation::read(), multiphaseMangrovesSource::read(), multiphaseMangrovesTurbulenceModel::read(), interRegionOption::read(), tabulatedAccelerationSource::read(), buoyancyEnergy::read(), cellSetOption::read(), jouleHeatingSource::read(), tabulatedNTUHeatTransfer::read(), and optionList::readOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ name_

const word name_

protected

Definition at line 129 of file fvOption.H.

Referenced by velocityDampingConstraint::addDamping(), interRegionExplicitPorositySource::initialise(), option::name(), and option::writeHeader().

◆ modelType_

const word modelType_

protected

Definition at line 132 of file fvOption.H.

◆ mesh_

const fvMesh& mesh_

protected

Definition at line 135 of file fvOption.H.

Referenced by velocityDampingConstraint::addDamping(), variableHeatTransfer::calculateHtc(), meanVelocityForce::correct(), multiphaseStabilizedTurbulence::correct(), multiphaseMangrovesSource::dragCoeff(), interRegionExplicitPorositySource::initialise(), multiphaseMangrovesTurbulenceModel::read(), fixedTemperatureConstraint::read(), acousticDampingSource::setBlendingFactor(), interRegionOption::setMapper(), and interRegionHeatTransferModel::setNbrModel().

◆ dict_

dictionary dict_

protected

Definition at line 138 of file fvOption.H.

◆ coeffs_

dictionary coeffs_

protected

Definition at line 141 of file fvOption.H.

Referenced by interRegionExplicitPorositySource::initialise(), multiphaseMangrovesTurbulenceModel::read(), limitVelocity::read(), limitTemperature::read(), tabulatedAccelerationSource::read(), buoyancyEnergy::read(), fixedTemperatureConstraint::read(), radialActuationDiskSource::read(), explicitPorositySource::read(), and interRegionOption::setMapper().

◆ fieldNames_

wordList fieldNames_

protected

Definition at line 144 of file fvOption.H.

Referenced by multiphaseStabilizedTurbulence::correct(), multiphaseMangrovesTurbulenceModel::read(), explicitPorositySource::read(), and option::resetApplied().

◆ applied_

List<bool> applied_

protected

Definition at line 147 of file fvOption.H.

Referenced by option::resetApplied().

◆ active_

bool active_

protected

Definition at line 150 of file fvOption.H.

◆ log

bool log

Definition at line 162 of file fvOption.H.

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

src/finiteVolume/cfdTools/general/fvOptions/fvOption.H
src/finiteVolume/cfdTools/general/fvOptions/fvOption.C
src/finiteVolume/cfdTools/general/fvOptions/fvOptionI.H
src/finiteVolume/cfdTools/general/fvOptions/fvOptionIO.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()

◆ active() [2/2]

◆ isActive()

◆ applyToField()

◆ checkApplied()

◆ addSup() [1/15]

◆ addSup() [2/15]

◆ addSup() [3/15]

◆ addSup() [4/15]

◆ addSup() [5/15]

◆ addSup() [6/15]

◆ addSup() [7/15]

◆ addSup() [8/15]

◆ addSup() [9/15]

◆ addSup() [10/15]

◆ addSup() [11/15]

◆ addSup() [12/15]

◆ addSup() [13/15]

◆ addSup() [14/15]

◆ addSup() [15/15]

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

◆ postProcessSens() [1/3]

◆ postProcessSens() [2/3]

◆ postProcessSens() [3/3]

◆ writeHeader()

◆ writeFooter()

◆ writeData()

◆ read()

Member Data Documentation

◆ name_

◆ modelType_

◆ mesh_

◆ dict_

◆ coeffs_

◆ fieldNames_

◆ applied_

◆ active_

◆ log