Finite volume options abstract base class. Provides a base set of controls, e.g.: 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 () |
Destructor. More... | |
const word & | name () const |
Return const access to the source name. More... | |
const fvMesh & | mesh () const |
Return const access to the mesh database. More... | |
const dictionary & | coeffs () const |
Return dictionary. More... | |
bool | active () const |
Return const access to the source active flag. More... | |
void | setApplied (const label fieldi) |
Set the applied flag to true for field index fieldi. More... | |
Switch & | active () |
Return access to the source active flag. 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 | 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... | |
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... | |
Switch | active_ |
Source active flag. 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... | |
Finite volume options abstract base class. Provides a base set of controls, e.g.:
type scalarExplicitSource // source type active on; // on/off switch
Definition at line 66 of file fvOption.H.
option | ( | const word & | name, |
const word & | modelType, | ||
const dictionary & | dict, | ||
const fvMesh & | mesh | ||
) |
Construct from components.
Definition at line 44 of file fvOption.C.
References Foam::decrIndent(), Foam::endl(), Foam::incrIndent(), Foam::indent(), Foam::Info, and option::New().
|
virtual |
Destructor.
Definition at line 101 of file fvOption.C.
Referenced by option::iNew::operator()().
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) | |||
) |
Return clone.
Definition at line 132 of file fvOption.H.
References option::iNew::iNew(), and NotImplemented.
|
static |
Return a reference to the selected fvOption model.
Definition at line 67 of file fvOption.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, HashTable< T, Key, Hash >::find(), Foam::indent(), Foam::Info, dictionary::lookup(), mesh, Foam::name(), Foam::nl, and fvMesh::time().
Referenced by option::iNew::operator()(), option::option(), and optionList::reset().
|
inline |
Return const access to the source name.
Definition at line 28 of file fvOptionI.H.
References option::name_.
Referenced by optionList::constrain(), optionList::correct(), optionList::operator()(), option::iNew::operator()(), optionList::readOptions(), and optionList::source().
|
inline |
Return const access to the mesh database.
Definition at line 34 of file fvOptionI.H.
References option::mesh_.
Referenced by option::iNew::operator()().
|
inline |
Return dictionary.
Definition at line 40 of file fvOptionI.H.
References option::coeffs_.
Referenced by option::iNew::operator()().
|
inline |
Return const access to the source active flag.
Definition at line 46 of file fvOptionI.H.
References option::active_.
Referenced by option::iNew::operator()().
|
inline |
Set the applied flag to true for field index fieldi.
Definition at line 52 of file fvOptionI.H.
References option::applied_.
Referenced by optionList::constrain(), optionList::correct(), optionList::operator()(), option::iNew::operator()(), and optionList::source().
|
inline |
Return access to the source active flag.
Definition at line 58 of file fvOptionI.H.
References option::active_.
|
virtual |
Is the source active?
Reimplemented in cellSetOption.
Definition at line 107 of file fvOption.C.
Referenced by optionList::constrain(), optionList::correct(), cellSetOption::isActive(), optionList::operator()(), option::iNew::operator()(), and optionList::source().
|
virtual |
Return index of field name if found in fieldNames list.
Definition at line 113 of file fvOption.C.
References Foam::findIndex().
Referenced by optionList::appliesToField(), optionList::constrain(), optionList::correct(), optionList::operator()(), option::iNew::operator()(), and optionList::source().
|
virtual |
Check that the source has been applied.
Definition at line 119 of file fvOption.C.
References option::addSup(), Foam::endl(), forAll, and WarningInFunction.
Referenced by optionList::checkApplied(), and option::iNew::operator()().
Reimplemented in solidificationMeltingSource, effectivenessHeatExchangerSource, VoFSolidificationMeltingSource, and interRegionHeatTransferModel.
Definition at line 134 of file fvOption.C.
Referenced by option::addSup(), option::checkApplied(), optionList::operator()(), option::iNew::operator()(), and optionList::source().
Reimplemented in solidificationMeltingSource, rotorDiskSource, actuationDiskSource, VoFSolidificationMeltingSource, verticalDamping, radialActuationDiskSource, interRegionExplicitPorositySource, meanVelocityForce, explicitPorositySource, tabulatedAccelerationSource, velocityRamping, and buoyancyForce.
Definition at line 142 of file fvOption.C.
References option::addSup().
|
virtual |
Definition at line 158 of file fvOption.C.
References option::addSup().
|
virtual |
Definition at line 150 of file fvOption.C.
References option::addSup().
Definition at line 166 of file fvOption.C.
References option::addSup().
|
virtual |
Reimplemented in solidificationMeltingSource, effectivenessHeatExchangerSource, VoFSolidificationMeltingSource, interRegionHeatTransferModel, radiation, and buoyancyEnergy.
Definition at line 174 of file fvOption.C.
References option::addSup().
|
virtual |
Reimplemented in solidificationMeltingSource, rotorDiskSource, VoFSolidificationMeltingSource, actuationDiskSource, verticalDamping, radialActuationDiskSource, interRegionExplicitPorositySource, meanVelocityForce, explicitPorositySource, tabulatedAccelerationSource, velocityRamping, and buoyancyForce.
Definition at line 183 of file fvOption.C.
References option::addSup().
|
virtual |
Definition at line 201 of file fvOption.C.
References option::addSup().
|
virtual |
Definition at line 192 of file fvOption.C.
References option::addSup().
|
virtual |
Definition at line 210 of file fvOption.C.
References option::addSup().
|
virtual |
Definition at line 219 of file fvOption.C.
References option::addSup().
|
virtual |
Reimplemented in verticalDamping, explicitPorositySource, and velocityRamping.
Definition at line 231 of file fvOption.C.
References option::addSup().
|
virtual |
Definition at line 255 of file fvOption.C.
References option::addSup().
|
virtual |
Definition at line 243 of file fvOption.C.
References option::addSup().
|
virtual |
Definition at line 267 of file fvOption.C.
Reimplemented in fixedTemperatureConstraint.
Definition at line 278 of file fvOption.C.
Referenced by optionList::constrain(), option::constrain(), and option::iNew::operator()().
Reimplemented in meanVelocityForce.
Definition at line 282 of file fvOption.C.
References option::constrain().
|
virtual |
Definition at line 287 of file fvOption.C.
References option::constrain().
|
virtual |
Definition at line 295 of file fvOption.C.
Definition at line 302 of file fvOption.C.
|
virtual |
Reimplemented in limitTemperature.
Definition at line 306 of file fvOption.C.
Referenced by optionList::correct(), and option::iNew::operator()().
|
virtual |
Reimplemented in meanVelocityForce, and limitVelocity.
Definition at line 310 of file fvOption.C.
|
virtual |
Definition at line 314 of file fvOption.C.
|
virtual |
Definition at line 318 of file fvOption.C.
|
virtual |
Definition at line 322 of file fvOption.C.
|
virtual |
Write the source header information.
Definition at line 30 of file fvOptionIO.C.
References token::BEGIN_BLOCK, Foam::incrIndent(), Foam::indent(), option::name_, and Foam::nl.
Referenced by option::iNew::operator()().
|
virtual |
Write the source footer information.
Definition at line 37 of file fvOptionIO.C.
References Foam::decrIndent(), token::END_BLOCK, Foam::endl(), and Foam::indent().
Referenced by option::iNew::operator()().
|
virtual |
Write the source properties.
Definition at line 43 of file fvOptionIO.C.
References option::active_, option::coeffs_, token::END_STATEMENT, Foam::indent(), Foam::nl, Foam::type(), dictionary::write(), and Ostream::writeKeyword().
Referenced by option::iNew::operator()().
|
virtual |
Read source dictionary.
Reimplemented in solidificationMeltingSource, rotorDiskSource, effectivenessHeatExchangerSource, CodedSource< Type >, VoFSolidificationMeltingSource, actuationDiskSource, SemiImplicitSource< Type >, verticalDamping, interRegionHeatTransferModel, cellSetOption, radialActuationDiskSource, meanVelocityForce, interRegionExplicitPorositySource, explicitPorositySource, velocityRamping, fixedTemperatureConstraint, tabulatedAccelerationSource, PhaseLimitStabilization< Type >, limitTemperature, buoyancyForce, limitVelocity, variableHeatTransfer, radiation, tabulatedHeatTransfer, interRegionOption, buoyancyEnergy, FixedValueConstraint< Type >, and constantHeatTransfer.
Definition at line 53 of file fvOptionIO.C.
References option::active_, option::coeffs_, option::modelType_, dictionary::optionalSubDict(), and dictionary::readIfPresent().
Referenced by option::iNew::operator()(), interRegionOption::read(), radiation::read(), tabulatedAccelerationSource::read(), cellSetOption::read(), and optionList::readOptions().
|
protected |
Source name.
Definition at line 73 of file fvOption.H.
Referenced by option::name(), and option::writeHeader().
|
protected |
|
protected |
Reference to the mesh database.
Definition at line 79 of file fvOption.H.
Referenced by cellSetOption::inTimeLimits(), and option::mesh().
|
protected |
Top level source dictionary.
Definition at line 82 of file fvOption.H.
|
protected |
Dictionary containing source coefficients.
Definition at line 85 of file fvOption.H.
Referenced by option::coeffs(), cellSetOption::read(), solidificationMeltingSource::read(), option::read(), and option::writeData().
|
protected |
Source active flag.
Definition at line 88 of file fvOption.H.
Referenced by option::active(), option::read(), and option::writeData().
|
protected |
Field names to apply source to - populated by derived models.
Definition at line 91 of file fvOption.H.
|
protected |
Applied flag list - corresponds to each fieldNames_ entry.
Definition at line 94 of file fvOption.H.
Referenced by option::setApplied().