Loading...
Searching...
No Matches
option Class Reference

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

#include <fvOption.H>

Inheritance diagram for option:
Inheritance graph
[legend]
Collaboration diagram for option:
Collaboration graph
[legend]

Classes

class  iNew
 Return pointer to new fvOption object created. More...

Public Member Functions

 TypeName ("option")
 Runtime type information.
 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.
autoPtr< option > clone () const
 Return clone.
virtual ~option ()=default
 Destructor.
const word & name () const noexcept
 Return const access to the source name.
const fvMesh & mesh () const noexcept
 Return const access to the mesh database.
const dictionary & coeffs () const noexcept
 Return dictionary.
bool active () const noexcept
 True if source is active.
void setApplied (const label fieldi)
 Set the applied flag to true for field index fieldi.
bool active (const bool on) noexcept
 Change source active flag, return previous value.
virtual bool isActive ()
 Is the source active?
virtual label applyToField (const word &fieldName) const
 Return index of field name if found in fieldNames list.
virtual void checkApplied () const
 Check that the source has been applied.
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 correct (surfaceScalarField &field)
virtual void correct (surfaceVectorField &field)
virtual void correct (surfaceTensorField &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 postProcessAuxSens (const volScalarField &primalField, const volScalarField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void postProcessAuxSens (const volVectorField &primalField, const volVectorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void postProcessAuxSens (const volTensorField &primalField, const volTensorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void writeHeader (Ostream &) const
 Write the source header information.
virtual void writeFooter (Ostream &) const
 Write the source footer information.
virtual void writeData (Ostream &) const
 Write the source properties.
virtual bool read (const dictionary &dict)
 Read source dictionary.

Static Public Member Functions

static autoPtr< option > New (const word &name, const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected fvOption model.

Public Attributes

bool log
 Switch write log to Info.

Protected Member Functions

void resetApplied ()
 Resize/reset applied flag list for all fieldNames_ entries.

Protected Attributes

const word name_
 Source name.
const word modelType_
 Model type.
const fvMesh & mesh_
 Reference to the mesh database.
dictionary dict_
 Top level source dictionary.
dictionary coeffs_
 Dictionary containing source coefficients.
wordList fieldNames_
 Field names to apply source to - populated by derived models.
List< bool > applied_
 Applied flag list - corresponds to each fieldNames_ entry.
bool active_
 Source active flag.

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 123 of file fvOption.H.

Constructor & Destructor Documentation

◆ option()

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

Construct from components.

Definition at line 50 of file fvOption.C.

References active_, applied_, coeffs_, Foam::decrIndent(), dict, dict_, Foam::endl(), fieldNames_, Foam::incrIndent(), Foam::indent(), Log, log, mesh(), mesh_, modelType_, name(), and name_.

Referenced by buoyancyEnergy::buoyancyEnergy(), buoyancyForce::buoyancyForce(), cellSetOption::cellSetOption(), declareRunTimeSelectionTable(), interRegionOption::interRegionOption(), MapFieldConstraint< Type >::MapFieldConstraint(), multiphaseMangrovesSource::multiphaseMangrovesSource(), multiphaseMangrovesTurbulenceModel::multiphaseMangrovesTurbulenceModel(), multiphaseStabilizedTurbulence::multiphaseStabilizedTurbulence(), patchCellsSource::patchCellsSource(), PhaseLimitStabilization< Type >::PhaseLimitStabilization(), radiation::radiation(), tabulatedAccelerationSource::tabulatedAccelerationSource(), topOSource::topOSource(), and viscousDissipation::viscousDissipation().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~option()

virtual ~option ( )
virtualdefault

Destructor.

References active(), addSup(), alpha, applyToField(), checkApplied(), coeffs(), constrain(), correct(), field(), isActive(), mesh(), Foam::noexcept, rho, and setApplied().

Here is the call graph for this function:

Member Function Documentation

◆ resetApplied()

void resetApplied ( )
protected

Resize/reset applied flag list for all fieldNames_ entries.

Definition at line 41 of file fvOption.C.

References applied_, and fieldNames_.

Referenced by actuationDiskSource::actuationDiskSource(), atmNutSource::atmNutSource(), atmPlantCanopyTSource::atmPlantCanopyTSource(), atmPlantCanopyTurbSource::atmPlantCanopyTurbSource(), atmPlantCanopyUSource::atmPlantCanopyUSource(), buoyancyEnergy::buoyancyEnergy(), buoyancyForce::buoyancyForce(), directionalPressureGradientExplicitSource::directionalPressureGradientExplicitSource(), fanMomentumSource::fanMomentumSource(), fixedTemperatureConstraint::fixedTemperatureConstraint(), heatExchangerSource::heatExchangerSource(), interRegionExplicitPorositySource::interRegionExplicitPorositySource(), interRegionHeatTransferModel::interRegionHeatTransferModel(), meanVelocityForce::meanVelocityForce(), multiphaseStabilizedTurbulence::multiphaseStabilizedTurbulence(), patchCellsSource::patchCellsSource(), PhaseLimitStabilization< Type >::PhaseLimitStabilization(), radiation::radiation(), acousticDampingSource::read(), CodedSource< Type >::read(), explicitPorositySource::read(), FixedValueConstraint< Type >::read(), limitTemperature::read(), limitTurbulenceViscosity::read(), limitVelocity::read(), MapFieldConstraint< Type >::read(), multiphaseMangrovesSource::read(), multiphaseMangrovesTurbulenceModel::read(), rotorDiskSource::read(), velocityDampingConstraint::read(), solidificationMeltingSource::solidificationMeltingSource(), tabulatedAccelerationSource::tabulatedAccelerationSource(), and viscousDissipation::viscousDissipation().

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

References dict, mesh(), name(), and option().

Here is the call graph for this function:

◆ clone()

autoPtr< option > clone ( ) const
inline

Return clone.

Definition at line 225 of file fvOption.H.

References NotImplemented.

◆ New()

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

Return a reference to the selected fvOption model.

Definition at line 77 of file fvOption.C.

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

Referenced by actuationDiskSource::actuationDiskSource(), adjointSimple::addTopOFvOptions(), buoyancyForce::buoyancyForce(), fanMomentumSource::fanMomentumSource(), topOSource::getSource(), heatExchangerSource::heatExchangerSource(), option::iNew::operator()(), CodedSource< Type >::redirectOption(), optionList::reset(), rotorDiskSource::rotorDiskSource(), and topOSource::topOSource().

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 24 of file fvOptionI.H.

References name_, and Foam::noexcept.

Referenced by acousticDampingSource::acousticDampingSource(), actuationDiskSource::actuationDiskSource(), actuationDiskSource::actuationDiskSource(), cellSetOption::cellSetOption(), CodedSource< Type >::CodedSource(), constantHeatTransfer::constantHeatTransfer(), declareRunTimeSelectionTable(), directionalPressureGradientExplicitSource::directionalPressureGradientExplicitSource(), explicitPorositySource::explicitPorositySource(), fanMomentumSource::fanMomentumSource(), fixedTemperatureConstraint::fixedTemperatureConstraint(), FixedValueConstraint< Type >::FixedValueConstraint(), heatExchangerSource::heatExchangerSource(), option::iNew::iNew(), interRegionExplicitPorositySource::interRegionExplicitPorositySource(), interRegionHeatTransferModel::interRegionHeatTransferModel(), interRegionOption::interRegionOption(), limitTemperature::limitTemperature(), limitTurbulenceViscosity::limitTurbulenceViscosity(), limitVelocity::limitVelocity(), MapFieldConstraint< Type >::MapFieldConstraint(), multiphaseMangrovesSource::multiphaseMangrovesSource(), multiphaseMangrovesTurbulenceModel::multiphaseMangrovesTurbulenceModel(), New(), option(), PhaseLimitStabilization< Type >::PhaseLimitStabilization(), radialActuationDiskSource::radialActuationDiskSource(), radiation::radiation(), optionList::readOptions(), rotorDiskSource::rotorDiskSource(), SemiImplicitSource< Type >::SemiImplicitSource(), interRegionHeatTransferModel::setNbrModel(), tabulatedAccelerationSource::tabulatedAccelerationSource(), tabulatedHeatTransfer::tabulatedHeatTransfer(), tabulatedNTUHeatTransfer::tabulatedNTUHeatTransfer(), topOSource::topOSource(), acousticDampingSource::TypeName(), cellSetOption::TypeName(), CodedSource< Type >::TypeName(), constantHeatTransfer::TypeName(), explicitPorositySource::TypeName(), fixedTemperatureConstraint::TypeName(), FixedValueConstraint< Type >::TypeName(), heatExchangerSource::TypeName(), interRegionExplicitPorositySource::TypeName(), interRegionHeatTransferModel::TypeName(), interRegionOption::TypeName(), limitTemperature::TypeName(), limitTurbulenceViscosity::TypeName(), limitVelocity::TypeName(), MapFieldConstraint< Type >::TypeName(), multiphaseMangrovesSource::TypeName(), multiphaseMangrovesTurbulenceModel::TypeName(), PhaseLimitStabilization< Type >::TypeName(), radialActuationDiskSource::TypeName(), rotorDiskSource::TypeName(), SemiImplicitSource< Type >::TypeName(), tabulatedAccelerationSource::TypeName(), tabulatedHeatTransfer::TypeName(), tabulatedNTUHeatTransfer::TypeName(), topOSource::TypeName(), variableHeatTransfer::TypeName(), velocityDampingConstraint::TypeName(), variableHeatTransfer::variableHeatTransfer(), velocityDampingConstraint::velocityDampingConstraint(), and rotorDiskSource::writeField().

◆ mesh()

const Foam::fvMesh & mesh ( ) const
inlinenoexcept

Return const access to the mesh database.

Definition at line 30 of file fvOptionI.H.

References mesh_, and Foam::noexcept.

Referenced by acousticDampingSource::acousticDampingSource(), actuationDiskSource::actuationDiskSource(), actuationDiskSource::actuationDiskSource(), atmAmbientTurbSource::atmAmbientTurbSource(), atmBuoyancyTurbSource::atmBuoyancyTurbSource(), atmCoriolisUSource::atmCoriolisUSource(), atmLengthScaleTurbSource::atmLengthScaleTurbSource(), atmNutSource::atmNutSource(), atmPlantCanopyTSource::atmPlantCanopyTSource(), atmPlantCanopyTurbSource::atmPlantCanopyTurbSource(), atmPlantCanopyUSource::atmPlantCanopyUSource(), buoyancyEnergy::buoyancyEnergy(), buoyancyForce::buoyancyForce(), buoyancyTurbSource::buoyancyTurbSource(), cellSetOption::cellSetOption(), CodedSource< Type >::CodedSource(), constantHeatTransfer::constantHeatTransfer(), declareRunTimeSelectionTable(), directionalPressureGradientExplicitSource::directionalPressureGradientExplicitSource(), explicitPorositySource::explicitPorositySource(), fanMomentumSource::fanMomentumSource(), fixedTemperatureConstraint::fixedTemperatureConstraint(), FixedValueConstraint< Type >::FixedValueConstraint(), heatExchangerSource::heatExchangerSource(), option::iNew::iNew(), interRegionExplicitPorositySource::interRegionExplicitPorositySource(), interRegionHeatTransferModel::interRegionHeatTransferModel(), interRegionOption::interRegionOption(), jouleHeatingSource::jouleHeatingSource(), limitTemperature::limitTemperature(), limitTurbulenceViscosity::limitTurbulenceViscosity(), limitVelocity::limitVelocity(), MapFieldConstraint< Type >::MapFieldConstraint(), meanVelocityForce::meanVelocityForce(), multiphaseMangrovesSource::multiphaseMangrovesSource(), multiphaseMangrovesTurbulenceModel::multiphaseMangrovesTurbulenceModel(), multiphaseStabilizedTurbulence::multiphaseStabilizedTurbulence(), New(), option(), patchCellsSource::patchCellsSource(), patchMeanVelocityForce::patchMeanVelocityForce(), PhaseLimitStabilization< Type >::PhaseLimitStabilization(), radialActuationDiskSource::radialActuationDiskSource(), radiation::radiation(), rotorDiskSource::rotorDiskSource(), SemiImplicitSource< Type >::SemiImplicitSource(), solidificationMeltingSource::solidificationMeltingSource(), tabulatedAccelerationSource::tabulatedAccelerationSource(), tabulatedHeatTransfer::tabulatedHeatTransfer(), tabulatedNTUHeatTransfer::tabulatedNTUHeatTransfer(), topOSource::topOSource(), acousticDampingSource::TypeName(), atmAmbientTurbSource::TypeName(), atmBuoyancyTurbSource::TypeName(), atmCoriolisUSource::TypeName(), atmLengthScaleTurbSource::TypeName(), atmNutSource::TypeName(), atmPlantCanopyTSource::TypeName(), atmPlantCanopyTurbSource::TypeName(), atmPlantCanopyUSource::TypeName(), buoyancyEnergy::TypeName(), buoyancyForce::TypeName(), buoyancyTurbSource::TypeName(), cellSetOption::TypeName(), CodedSource< Type >::TypeName(), constantHeatTransfer::TypeName(), directionalPressureGradientExplicitSource::TypeName(), explicitPorositySource::TypeName(), fanMomentumSource::TypeName(), fixedTemperatureConstraint::TypeName(), FixedValueConstraint< Type >::TypeName(), heatExchangerSource::TypeName(), interRegionExplicitPorositySource::TypeName(), interRegionHeatTransferModel::TypeName(), interRegionOption::TypeName(), limitTemperature::TypeName(), limitTurbulenceViscosity::TypeName(), limitVelocity::TypeName(), MapFieldConstraint< Type >::TypeName(), meanVelocityForce::TypeName(), multiphaseMangrovesSource::TypeName(), multiphaseMangrovesTurbulenceModel::TypeName(), multiphaseStabilizedTurbulence::TypeName(), patchCellsSource::TypeName(), patchMeanVelocityForce::TypeName(), PhaseLimitStabilization< Type >::TypeName(), radialActuationDiskSource::TypeName(), radiation::TypeName(), rotorDiskSource::TypeName(), SemiImplicitSource< Type >::TypeName(), solidificationMeltingSource::TypeName(), tabulatedAccelerationSource::TypeName(), tabulatedHeatTransfer::TypeName(), tabulatedNTUHeatTransfer::TypeName(), topOSource::TypeName(), variableHeatTransfer::TypeName(), velocityDampingConstraint::TypeName(), viscousDissipation::TypeName(), variableHeatTransfer::variableHeatTransfer(), velocityDampingConstraint::velocityDampingConstraint(), viscousDissipation::viscousDissipation(), VoFSolidificationMeltingSource::VoFSolidificationMeltingSource(), and ~option().

◆ coeffs()

const Foam::dictionary & coeffs ( ) const
inlinenoexcept

Return dictionary.

Definition at line 36 of file fvOptionI.H.

References coeffs_, and Foam::noexcept.

Referenced by New(), directionalPressureGradientExplicitSource::read(), and ~option().

Here is the caller graph for this function:

◆ active() [1/2]

bool active ( ) const
inlinenoexcept

True if source is active.

Definition at line 42 of file fvOptionI.H.

References active_, and Foam::noexcept.

Referenced by constantHeatTransfer::constantHeatTransfer(), interRegionHeatTransferModel::interRegionHeatTransferModel(), interRegionOption::interRegionOption(), and ~option().

Here is the caller graph for this function:

◆ setApplied()

void setApplied ( const label fieldi)
inline

Set the applied flag to true for field index fieldi.

Definition at line 56 of file fvOptionI.H.

References applied_.

Referenced by ~option().

Here is the caller graph for this function:

◆ active() [2/2]

bool active ( const bool on)
inlinenoexcept

Change source active flag, return previous value.

Definition at line 48 of file fvOptionI.H.

References active_.

◆ isActive()

bool isActive ( )
virtual

Is the source active?

Reimplemented in cellSetOption.

Definition at line 115 of file fvOption.C.

References active_.

Referenced by fanMomentumSource::fanMomentumSource(), cellSetOption::isActive(), and ~option().

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 121 of file fvOption.C.

References fieldNames_.

Referenced by topOSource::postProcessSens(), and ~option().

Here is the caller graph for this function:

◆ checkApplied()

void checkApplied ( ) const
virtual

Check that the source has been applied.

Definition at line 127 of file fvOption.C.

References applied_, Foam::endl(), fieldNames_, forAll, name_, and WarningInFunction.

Referenced by optionList::checkApplied(), and ~option().

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 atmAmbientTurbSource, atmBuoyancyTurbSource, atmLengthScaleTurbSource, atmPlantCanopyTSource, atmPlantCanopyTurbSource, buoyancyTurbSource, heatExchangerSource, interRegionHeatTransferModel, multiphaseMangrovesTurbulenceModel, multiphaseStabilizedTurbulence, solidificationMeltingSource, topOSource, and VoFSolidificationMeltingSource.

Definition at line 141 of file fvOption.C.

Referenced by addSup(), addSup(), addSup(), addSup(), addSup(), and ~option().

Here is the caller graph for this function:

◆ addSup() [2/15]

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

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

Definition at line 149 of file fvOption.C.

◆ addSup() [3/15]

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

Definition at line 165 of file fvOption.C.

◆ addSup() [4/15]

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

Definition at line 157 of file fvOption.C.

◆ addSup() [5/15]

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

Definition at line 173 of file fvOption.C.

◆ addSup() [6/15]

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

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

Definition at line 181 of file fvOption.C.

References rho.

◆ addSup() [7/15]

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

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

Definition at line 190 of file fvOption.C.

References rho.

◆ addSup() [8/15]

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

Definition at line 208 of file fvOption.C.

References rho.

◆ addSup() [9/15]

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

Definition at line 199 of file fvOption.C.

References rho.

◆ addSup() [10/15]

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

Definition at line 217 of file fvOption.C.

References rho.

◆ addSup() [11/15]

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

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

Definition at line 226 of file fvOption.C.

References addSup(), alpha, and rho.

Here is the call graph for this function:

◆ addSup() [12/15]

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

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

Definition at line 238 of file fvOption.C.

References addSup(), alpha, and rho.

Here is the call graph for this function:

◆ addSup() [13/15]

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

Definition at line 262 of file fvOption.C.

References addSup(), alpha, and rho.

Here is the call graph for this function:

◆ addSup() [14/15]

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

Definition at line 250 of file fvOption.C.

References addSup(), alpha, and rho.

Here is the call graph for this function:

◆ addSup() [15/15]

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

Definition at line 274 of file fvOption.C.

References addSup(), alpha, and rho.

Here is the call graph for this function:

◆ constrain() [1/5]

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

Reimplemented in fixedTemperatureConstraint.

Definition at line 286 of file fvOption.C.

Referenced by ~option().

Here is the caller graph for this function:

◆ constrain() [2/5]

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

Reimplemented in directionalPressureGradientExplicitSource, meanVelocityForce, and velocityDampingConstraint.

Definition at line 290 of file fvOption.C.

◆ constrain() [3/5]

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

Definition at line 294 of file fvOption.C.

◆ constrain() [4/5]

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

Definition at line 302 of file fvOption.C.

◆ constrain() [5/5]

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

Definition at line 310 of file fvOption.C.

◆ correct() [1/8]

void correct ( volScalarField & field)
virtual

Reimplemented in atmNutSource, limitTemperature, limitTurbulenceViscosity, and multiphaseStabilizedTurbulence.

Definition at line 314 of file fvOption.C.

References field().

Referenced by correct(), correct(), correct(), rotorDiskSource::setFaceArea(), and ~option().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ correct() [2/8]

void correct ( volVectorField & field)
virtual

Reimplemented in directionalPressureGradientExplicitSource, limitVelocity, and meanVelocityForce.

Definition at line 318 of file fvOption.C.

References field().

Here is the call graph for this function:

◆ correct() [3/8]

virtual void correct ( volSphericalTensorField & field)
virtual

Reimplemented in directionalPressureGradientExplicitSource, limitVelocity, and meanVelocityForce.

References correct(), and field().

Here is the call graph for this function:

◆ correct() [4/8]

virtual void correct ( volSymmTensorField & field)
virtual

Reimplemented in directionalPressureGradientExplicitSource, limitVelocity, and meanVelocityForce.

References correct(), and field().

Here is the call graph for this function:

◆ correct() [5/8]

void correct ( volTensorField & field)
virtual

Definition at line 330 of file fvOption.C.

References field().

Here is the call graph for this function:

◆ correct() [6/8]

void correct ( surfaceScalarField & field)
virtual

Definition at line 334 of file fvOption.C.

References field().

Here is the call graph for this function:

◆ correct() [7/8]

void correct ( surfaceVectorField & field)
virtual

Definition at line 338 of file fvOption.C.

References field().

Here is the call graph for this function:

◆ correct() [8/8]

virtual void correct ( surfaceTensorField & field)
virtual

Reimplemented in directionalPressureGradientExplicitSource, limitVelocity, and meanVelocityForce.

References correct(), dict, field(), postProcessAuxSens(), postProcessSens(), read(), writeData(), writeFooter(), and writeHeader().

Here is the call graph for this function:

◆ postProcessSens() [1/3]

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

Reimplemented in topOSource.

Definition at line 346 of file fvOption.C.

Referenced by correct().

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 355 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 364 of file fvOption.C.

◆ postProcessAuxSens() [1/3]

void postProcessAuxSens ( const volScalarField & primalField,
const volScalarField & adjointField,
scalarField & sensField,
const word & fieldName = word::null )
virtual

Definition at line 373 of file fvOption.C.

Referenced by correct().

Here is the caller graph for this function:

◆ postProcessAuxSens() [2/3]

void postProcessAuxSens ( const volVectorField & primalField,
const volVectorField & adjointField,
scalarField & sensField,
const word & fieldName = word::null )
virtual

Definition at line 383 of file fvOption.C.

◆ postProcessAuxSens() [3/3]

void postProcessAuxSens ( const volTensorField & primalField,
const volTensorField & adjointField,
scalarField & sensField,
const word & fieldName = word::null )
virtual

Definition at line 393 of file fvOption.C.

◆ writeHeader()

void writeHeader ( Ostream & os) const
virtual

Write the source header information.

Definition at line 26 of file fvOptionIO.C.

References name_, and os().

Referenced by correct(), and 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 32 of file fvOptionIO.C.

References os().

Referenced by correct(), and 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.

Reimplemented in directionalPressureGradientExplicitSource, and velocityDampingConstraint.

Definition at line 38 of file fvOptionIO.C.

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

Referenced by correct(), and 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 acousticDampingSource, actuationDiskSource, atmAmbientTurbSource, atmBuoyancyTurbSource, atmCoriolisUSource, atmLengthScaleTurbSource, atmNutSource, atmPlantCanopyTSource, atmPlantCanopyTurbSource, atmPlantCanopyUSource, buoyancyEnergy, buoyancyForce, buoyancyTurbSource, cellSetOption, CodedSource< Type >, constantHeatTransfer, directionalPressureGradientExplicitSource, explicitPorositySource, fanMomentumSource, fixedTemperatureConstraint, FixedValueConstraint< Type >, heatExchangerSource, interRegionExplicitPorositySource, interRegionHeatTransferModel, interRegionOption, jouleHeatingSource, limitTemperature, limitTurbulenceViscosity, limitVelocity, MapFieldConstraint< Type >, meanVelocityForce, multiphaseMangrovesSource, multiphaseMangrovesTurbulenceModel, multiphaseStabilizedTurbulence, patchCellsSource, PhaseLimitStabilization< Type >, radialActuationDiskSource, radiation, rotorDiskSource, SemiImplicitSource< Type >, solidificationMeltingSource, tabulatedAccelerationSource, tabulatedHeatTransfer, tabulatedNTUHeatTransfer, topOSource, variableHeatTransfer, velocityDampingConstraint, viscousDissipation, and VoFSolidificationMeltingSource.

Definition at line 48 of file fvOptionIO.C.

References active_, coeffs_, dict, log, and modelType_.

Referenced by correct(), buoyancyEnergy::read(), cellSetOption::read(), interRegionOption::read(), MapFieldConstraint< Type >::read(), multiphaseMangrovesSource::read(), multiphaseMangrovesTurbulenceModel::read(), patchCellsSource::read(), PhaseLimitStabilization< Type >::read(), radiation::read(), tabulatedAccelerationSource::read(), tabulatedNTUHeatTransfer::read(), topOSource::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 132 of file fvOption.H.

Referenced by acousticDampingSource::acousticDampingSource(), velocityDampingConstraint::addDamping(), acousticDampingSource::addSup(), acousticDampingSource::addSup(), acousticDampingSource::addSup(), directionalPressureGradientExplicitSource::addSup(), fanMomentumSource::addSup(), fanMomentumSource::addSup(), interRegionExplicitPorositySource::addSup(), interRegionExplicitPorositySource::addSup(), meanVelocityForce::addSup(), patchCellsSource::addSup(), rotorDiskSource::addSup(), rotorDiskSource::addSup(), SemiImplicitSource< Type >::addSup(), checkApplied(), directionalPressureGradientExplicitSource::constrain(), FixedValueConstraint< Type >::constrain(), MapFieldConstraint< Type >::constrain(), meanVelocityForce::constrain(), limitTemperature::correct(), limitTurbulenceViscosity::correct(), limitVelocity::correct(), directionalPressureGradientExplicitSource::directionalPressureGradientExplicitSource(), explicitPorositySource::explicitPorositySource(), fanMomentumSource::fanMomentumSource(), interRegionExplicitPorositySource::initialise(), meanVelocityForce::meanVelocityForce(), name(), option(), radialActuationDiskSource::radialActuationDiskSource(), acousticDampingSource::read(), rotorDiskSource::setFaceArea(), solidificationMeltingSource::solidificationMeltingSource(), velocityDampingConstraint::writeData(), writeHeader(), and meanVelocityForce::writeProps().

◆ modelType_

const word modelType_
protected

Model type.

Definition at line 137 of file fvOption.H.

Referenced by option(), read(), and CodedSource< Type >::redirectOption().

◆ mesh_

const fvMesh& mesh_
protected

Reference to the mesh database.

Definition at line 142 of file fvOption.H.

Referenced by acousticDampingSource::acousticDampingSource(), velocityDampingConstraint::addDamping(), buoyancyEnergy::addSup(), directionalPressureGradientExplicitSource::addSup(), fanMomentumSource::addSup(), fanMomentumSource::addSup(), heatExchangerSource::addSup(), interRegionExplicitPorositySource::addSup(), interRegionExplicitPorositySource::addSup(), interRegionHeatTransferModel::addSup(), meanVelocityForce::addSup(), multiphaseMangrovesTurbulenceModel::addSup(), multiphaseMangrovesTurbulenceModel::addSup(), multiphaseStabilizedTurbulence::addSup(), patchCellsSource::addSup(), PhaseLimitStabilization< Type >::addSup(), radialActuationDiskSource::addSup(), radialActuationDiskSource::addSup(), radiation::addSup(), rotorDiskSource::addSup(), rotorDiskSource::addSup(), SemiImplicitSource< Type >::addSup(), solidificationMeltingSource::addSup(), viscousDissipation::addSup(), atmNutSource::atmNutSource(), atmPlantCanopyTurbSource::atmPlantCanopyTurbSource(), rotorDiskSource::calculate(), tabulatedHeatTransfer::calculateHtc(), tabulatedNTUHeatTransfer::calculateHtc(), variableHeatTransfer::calculateHtc(), constantHeatTransfer::constantHeatTransfer(), directionalPressureGradientExplicitSource::constrain(), fixedTemperatureConstraint::constrain(), MapFieldConstraint< Type >::constrain(), meanVelocityForce::constrain(), rotorDiskSource::constructGeometry(), directionalPressureGradientExplicitSource::correct(), interRegionHeatTransferModel::correct(), limitTemperature::correct(), limitTurbulenceViscosity::correct(), limitVelocity::correct(), meanVelocityForce::correct(), multiphaseStabilizedTurbulence::correct(), rotorDiskSource::createCoordinateSystem(), directionalPressureGradientExplicitSource::directionalPressureGradientExplicitSource(), actuationDiskSource::diskDir(), multiphaseMangrovesSource::dragCoeff(), multiphaseMangrovesTurbulenceModel::epsilonCoeff(), explicitPorositySource::explicitPorositySource(), fanMomentumSource::fanMomentumSource(), fixedTemperatureConstraint::fixedTemperatureConstraint(), topOSource::getSource(), heatExchangerSource::heatExchangerSource(), multiphaseMangrovesSource::inertiaCoeff(), rotorDiskSource::inflowVelocity(), interRegionExplicitPorositySource::initialise(), cellSetOption::inTimeLimits(), cellSetOption::isActive(), multiphaseMangrovesTurbulenceModel::kCoeff(), CodedSource< Type >::libs(), meanVelocityForce::magUbarAve(), patchMeanVelocityForce::magUbarAve(), MapFieldConstraint< Type >::MapFieldConstraint(), meanVelocityForce::meanVelocityForce(), mesh(), multiphaseStabilizedTurbulence::multiphaseStabilizedTurbulence(), limitTurbulenceViscosity::nu(), option(), topOSource::postProcessSens(), radiation::radiation(), fixedTemperatureConstraint::read(), limitTemperature::read(), multiphaseMangrovesSource::read(), multiphaseMangrovesTurbulenceModel::read(), topOSource::read(), CodedSource< Type >::redirectOption(), acousticDampingSource::setBlendingFactor(), cellSetOption::setCellSelection(), rotorDiskSource::setFaceArea(), interRegionOption::setMapper(), interRegionHeatTransferModel::setNbrModel(), cellSetOption::setSelection(), cellSetOption::setVol(), solidificationMeltingSource::solidificationMeltingSource(), variableHeatTransfer::variableHeatTransfer(), viscousDissipation::viscousDissipation(), rotorDiskSource::writeField(), and meanVelocityForce::writeProps().

◆ dict_

dictionary dict_
protected

Top level source dictionary.

Definition at line 147 of file fvOption.H.

Referenced by option(), CodedSource< Type >::redirectOption(), and velocityDampingConstraint::writeData().

◆ coeffs_

dictionary coeffs_
protected

Dictionary containing source coefficients.

Definition at line 152 of file fvOption.H.

Referenced by actuationDiskSource::actuationDiskSource(), rotorDiskSource::addSup(), atmAmbientTurbSource::atmAmbientTurbSource(), atmBuoyancyTurbSource::atmBuoyancyTurbSource(), atmCoriolisUSource::atmCoriolisUSource(), atmLengthScaleTurbSource::atmLengthScaleTurbSource(), atmPlantCanopyTSource::atmPlantCanopyTSource(), buoyancyEnergy::buoyancyEnergy(), buoyancyForce::buoyancyForce(), buoyancyTurbSource::buoyancyTurbSource(), cellSetOption::cellSetOption(), rotorDiskSource::checkData(), CodedSource< Type >::codeDict(), coeffs(), rotorDiskSource::createCoordinateSystem(), directionalPressureGradientExplicitSource::directionalPressureGradientExplicitSource(), explicitPorositySource::explicitPorositySource(), fanMomentumSource::fanMomentumSource(), fixedTemperatureConstraint::fixedTemperatureConstraint(), heatExchangerSource::heatExchangerSource(), interRegionExplicitPorositySource::initialise(), interRegionExplicitPorositySource::interRegionExplicitPorositySource(), interRegionHeatTransferModel::interRegionHeatTransferModel(), interRegionOption::interRegionOption(), meanVelocityForce::meanVelocityForce(), multiphaseStabilizedTurbulence::multiphaseStabilizedTurbulence(), option(), patchCellsSource::patchCellsSource(), patchMeanVelocityForce::patchMeanVelocityForce(), PhaseLimitStabilization< Type >::PhaseLimitStabilization(), radialActuationDiskSource::radialActuationDiskSource(), acousticDampingSource::read(), buoyancyEnergy::read(), cellSetOption::read(), CodedSource< Type >::read(), explicitPorositySource::read(), fixedTemperatureConstraint::read(), FixedValueConstraint< Type >::read(), interRegionExplicitPorositySource::read(), limitTemperature::read(), limitTurbulenceViscosity::read(), limitVelocity::read(), MapFieldConstraint< Type >::read(), multiphaseMangrovesSource::read(), multiphaseMangrovesTurbulenceModel::read(), read(), PhaseLimitStabilization< Type >::read(), radialActuationDiskSource::read(), rotorDiskSource::read(), SemiImplicitSource< Type >::read(), solidificationMeltingSource::read(), tabulatedAccelerationSource::read(), tabulatedNTUHeatTransfer::read(), topOSource::read(), variableHeatTransfer::read(), velocityDampingConstraint::read(), rotorDiskSource::rotorDiskSource(), interRegionOption::setMapper(), solidificationMeltingSource::solidificationMeltingSource(), tabulatedAccelerationSource::tabulatedAccelerationSource(), tabulatedHeatTransfer::tabulatedHeatTransfer(), tabulatedNTUHeatTransfer::tabulatedNTUHeatTransfer(), variableHeatTransfer::variableHeatTransfer(), viscousDissipation::viscousDissipation(), and writeData().

◆ fieldNames_

wordList fieldNames_
protected

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

Definition at line 157 of file fvOption.H.

Referenced by actuationDiskSource::actuationDiskSource(), directionalPressureGradientExplicitSource::addSup(), fanMomentumSource::addSup(), fanMomentumSource::addSup(), meanVelocityForce::addSup(), SemiImplicitSource< Type >::addSup(), applyToField(), atmNutSource::atmNutSource(), atmPlantCanopyTSource::atmPlantCanopyTSource(), atmPlantCanopyTurbSource::atmPlantCanopyTurbSource(), atmPlantCanopyUSource::atmPlantCanopyUSource(), buoyancyEnergy::buoyancyEnergy(), buoyancyForce::buoyancyForce(), checkApplied(), MapFieldConstraint< Type >::constrain(), multiphaseStabilizedTurbulence::correct(), directionalPressureGradientExplicitSource::directionalPressureGradientExplicitSource(), fanMomentumSource::fanMomentumSource(), fixedTemperatureConstraint::fixedTemperatureConstraint(), heatExchangerSource::heatExchangerSource(), interRegionExplicitPorositySource::interRegionExplicitPorositySource(), interRegionHeatTransferModel::interRegionHeatTransferModel(), meanVelocityForce::meanVelocityForce(), multiphaseStabilizedTurbulence::multiphaseStabilizedTurbulence(), option(), patchCellsSource::patchCellsSource(), PhaseLimitStabilization< Type >::PhaseLimitStabilization(), radiation::radiation(), acousticDampingSource::read(), CodedSource< Type >::read(), explicitPorositySource::read(), FixedValueConstraint< Type >::read(), limitTemperature::read(), limitTurbulenceViscosity::read(), limitVelocity::read(), MapFieldConstraint< Type >::read(), multiphaseMangrovesSource::read(), multiphaseMangrovesTurbulenceModel::read(), rotorDiskSource::read(), topOSource::read(), velocityDampingConstraint::read(), resetApplied(), solidificationMeltingSource::solidificationMeltingSource(), tabulatedAccelerationSource::tabulatedAccelerationSource(), and viscousDissipation::viscousDissipation().

◆ applied_

List<bool> applied_
protected

Applied flag list - corresponds to each fieldNames_ entry.

Definition at line 162 of file fvOption.H.

Referenced by checkApplied(), option(), topOSource::read(), resetApplied(), and setApplied().

◆ active_

bool active_
protected

Source active flag.

Definition at line 167 of file fvOption.H.

Referenced by active(), active(), interRegionExplicitPorositySource::interRegionExplicitPorositySource(), isActive(), option(), read(), and writeData().

◆ log

bool log

Switch write log to Info.

Definition at line 183 of file fvOption.H.

Referenced by heatExchangerSource::addSup(), option(), and read().

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