Base abstract class for handling finite volume options (i.e. fvOption
).
More...
Classes | |
class | iNew |
Return pointer to new fvOption object created. 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... | |
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 (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 |
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 fvOption 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... | |
bool | active_ |
Source active flag. More... | |
Base abstract class for handling finite volume options (i.e. fvOption
).
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 |
Definition at line 126 of file fvOption.H.
option | ( | const word & | name, |
const word & | modelType, | ||
const dictionary & | dict, | ||
const fvMesh & | mesh | ||
) |
Construct from components.
Definition at line 58 of file fvOption.C.
References Foam::decrIndent(), Foam::endl(), Foam::incrIndent(), Foam::indent(), and Log.
|
virtualdefault |
Destructor.
|
protected |
Resize/reset applied flag list for all fieldNames_ entries.
Definition at line 48 of file fvOption.C.
References option::applied_, option::fieldNames_, and List< T >::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().
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) | |||
) |
|
static |
Return a reference to the selected fvOption model.
Definition at line 82 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().
|
inlinenoexcept |
Return const access to the source name.
Definition at line 31 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().
|
inlinenoexcept |
Return const access to the mesh database.
Definition at line 37 of file fvOptionI.H.
|
inlinenoexcept |
Return dictionary.
Definition at line 43 of file fvOptionI.H.
|
inlinenoexcept |
True if source is active.
Definition at line 49 of file fvOptionI.H.
|
inline |
Set the applied flag to true for field index fieldi.
Definition at line 63 of file fvOptionI.H.
Referenced by optionList::correct(), optionList::operator()(), and optionList::source().
Change source active flag, return previous value.
Definition at line 55 of file fvOptionI.H.
|
virtual |
Is the source active?
Reimplemented in cellSetOption.
Definition at line 119 of file fvOption.C.
Referenced by optionList::correct(), cellSetOption::isActive(), optionList::operator()(), optionList::postProcessSens(), and optionList::source().
|
virtual |
Return index of field name if found in fieldNames list.
Definition at line 125 of file fvOption.C.
Referenced by optionList::appliesToField(), optionList::correct(), optionList::operator()(), optionList::postProcessSens(), and optionList::source().
|
virtual |
Check that the source has been applied.
Definition at line 131 of file fvOption.C.
References Foam::endl(), forAll, and WarningInFunction.
Referenced by optionList::checkApplied().
|
virtual |
Reimplemented in effectivenessHeatExchangerSource, solidificationMeltingSource, buoyancyTurbSource, atmBuoyancyTurbSource, interRegionHeatTransferModel, atmLengthScaleTurbSource, atmAmbientTurbSource, multiphaseStabilizedTurbulence, atmPlantCanopyTurbSource, VoFSolidificationMeltingSource, atmPlantCanopyTSource, and multiphaseMangrovesTurbulenceModel.
Definition at line 146 of file fvOption.C.
Referenced by optionList::operator()(), and optionList::source().
Reimplemented in actuationDiskSource, rotorDiskSource, solidificationMeltingSource, directionalPressureGradientExplicitSource, acousticDampingSource, atmCoriolisUSource, meanVelocityForce, interRegionExplicitPorositySource, explicitPorositySource, radialActuationDiskSource, VoFSolidificationMeltingSource, buoyancyForce, atmPlantCanopyUSource, tabulatedAccelerationSource, and multiphaseMangrovesSource.
Definition at line 154 of file fvOption.C.
|
virtual |
Definition at line 170 of file fvOption.C.
|
virtual |
Definition at line 162 of file fvOption.C.
Definition at line 178 of file fvOption.C.
|
virtual |
Reimplemented in effectivenessHeatExchangerSource, solidificationMeltingSource, buoyancyTurbSource, jouleHeatingSource, atmBuoyancyTurbSource, interRegionHeatTransferModel, atmLengthScaleTurbSource, atmAmbientTurbSource, multiphaseStabilizedTurbulence, atmPlantCanopyTurbSource, VoFSolidificationMeltingSource, viscousDissipation, buoyancyEnergy, atmPlantCanopyTSource, multiphaseMangrovesTurbulenceModel, and radiation.
Definition at line 186 of file fvOption.C.
|
virtual |
Reimplemented in actuationDiskSource, rotorDiskSource, solidificationMeltingSource, directionalPressureGradientExplicitSource, acousticDampingSource, atmCoriolisUSource, meanVelocityForce, interRegionExplicitPorositySource, VoFSolidificationMeltingSource, explicitPorositySource, radialActuationDiskSource, buoyancyForce, atmPlantCanopyUSource, tabulatedAccelerationSource, and multiphaseMangrovesSource.
Definition at line 195 of file fvOption.C.
|
virtual |
Definition at line 213 of file fvOption.C.
|
virtual |
Definition at line 204 of file fvOption.C.
|
virtual |
Definition at line 222 of file fvOption.C.
|
virtual |
Reimplemented in buoyancyTurbSource, atmBuoyancyTurbSource, atmLengthScaleTurbSource, atmAmbientTurbSource, atmPlantCanopyTurbSource, and atmPlantCanopyTSource.
Definition at line 231 of file fvOption.C.
References Foam::constant::atomic::alpha, and rho.
|
virtual |
Reimplemented in actuationDiskSource, acousticDampingSource, atmCoriolisUSource, explicitPorositySource, and atmPlantCanopyUSource.
Definition at line 243 of file fvOption.C.
References Foam::constant::atomic::alpha, and rho.
|
virtual |
Definition at line 267 of file fvOption.C.
References Foam::constant::atomic::alpha, and rho.
|
virtual |
Definition at line 255 of file fvOption.C.
References Foam::constant::atomic::alpha, and rho.
|
virtual |
Definition at line 279 of file fvOption.C.
References Foam::constant::atomic::alpha, and rho.
|
virtual |
Reimplemented in fixedTemperatureConstraint.
Definition at line 290 of file fvOption.C.
Reimplemented in directionalPressureGradientExplicitSource, meanVelocityForce, and velocityDampingConstraint.
Definition at line 294 of file fvOption.C.
|
virtual |
Definition at line 299 of file fvOption.C.
|
virtual |
Definition at line 307 of file fvOption.C.
Definition at line 314 of file fvOption.C.
|
virtual |
Reimplemented in limitTemperature, multiphaseStabilizedTurbulence, and atmNutSource.
Definition at line 318 of file fvOption.C.
Referenced by optionList::correct().
|
virtual |
Reimplemented in directionalPressureGradientExplicitSource, meanVelocityForce, and limitVelocity.
Definition at line 322 of file fvOption.C.
|
virtual |
Definition at line 326 of file fvOption.C.
|
virtual |
Definition at line 330 of file fvOption.C.
|
virtual |
Definition at line 334 of file fvOption.C.
|
virtual |
Definition at line 339 of file fvOption.C.
Referenced by optionList::postProcessSens().
|
virtual |
Definition at line 348 of file fvOption.C.
|
virtual |
Definition at line 357 of file fvOption.C.
|
virtual |
Write the source header information.
Definition at line 33 of file fvOptionIO.C.
References option::name_, and os().
Referenced by optionList::writeData().
|
virtual |
Write the source footer information.
Definition at line 39 of file fvOptionIO.C.
References os().
Referenced by optionList::writeData().
|
virtual |
Write the source properties.
Reimplemented in directionalPressureGradientExplicitSource, and velocityDampingConstraint.
Definition at line 45 of file fvOptionIO.C.
References Foam::nl, os(), and Foam::type().
Referenced by optionList::writeData().
|
virtual |
Read source dictionary.
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 55 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().
|
protected |
Source name.
Definition at line 133 of file fvOption.H.
Referenced by velocityDampingConstraint::addDamping(), interRegionExplicitPorositySource::initialise(), option::name(), and option::writeHeader().
|
protected |
Model type.
Definition at line 136 of file fvOption.H.
|
protected |
Reference to the mesh database.
Definition at line 139 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().
|
protected |
Top level source dictionary.
Definition at line 142 of file fvOption.H.
|
protected |
Dictionary containing source coefficients.
Definition at line 145 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().
|
protected |
Field names to apply source to - populated by derived models.
Definition at line 148 of file fvOption.H.
Referenced by multiphaseStabilizedTurbulence::correct(), multiphaseMangrovesTurbulenceModel::read(), explicitPorositySource::read(), and option::resetApplied().
Applied flag list - corresponds to each fieldNames_ entry.
Definition at line 151 of file fvOption.H.
Referenced by option::resetApplied().
|
protected |
Source active flag.
Definition at line 154 of file fvOption.H.
bool log |
Switch write log to Info.
Definition at line 166 of file fvOption.H.