Cell-set options abtract base class. Provides a base set of controls, e.g.: More...
Public Types | |
enum | selectionModeType { smPoints, smCellSet, smCellZone, smAll } |
Enumeration for selection mode types. More... | |
Public Member Functions | |
TypeName ("cellSetOption") | |
Runtime type information. More... | |
cellSetOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh) | |
Construct from components. More... | |
virtual | ~cellSetOption () |
Destructor. More... | |
scalar | timeStart () const |
Return const access to the time start. More... | |
scalar | duration () const |
Return const access to the duration. More... | |
bool | inTimeLimits (const scalar time) const |
Return true if within time limits. More... | |
const selectionModeType & | selectionMode () const |
Return const access to the cell selection mode. More... | |
const word & | cellSetName () const |
Return const access to the name of cell set for "cellSet". More... | |
scalar | V () const |
Return const access to the total cell volume. More... | |
const labelList & | cells () const |
Return const access to the cell set. More... | |
scalar & | timeStart () |
Return access to the time start. More... | |
scalar & | duration () |
Return access to the duration. More... | |
virtual bool | isActive () |
Is the source active? More... | |
virtual bool | read (const dictionary &dict) |
Read source dictionary. More... | |
Public Member Functions inherited from option | |
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 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... | |
Static Public Attributes | |
static const NamedEnum< selectionModeType, 4 > | selectionModeTypeNames_ |
Word list of selection mode type names. More... | |
Protected Member Functions | |
void | setSelection (const dictionary &dict) |
Set the cellSet or points selection. More... | |
void | setCellSet () |
Set the cell set based on the user input selection mode. More... | |
Protected Attributes | |
scalar | timeStart_ |
Time start. More... | |
scalar | duration_ |
Duration. More... | |
selectionModeType | selectionMode_ |
Cell selection mode. More... | |
word | cellSetName_ |
Name of cell set for "cellSet" and "cellZone" selectionMode. More... | |
List< point > | points_ |
List of points for "points" selectionMode. More... | |
labelList | cells_ |
Set of cells to apply source to. More... | |
scalar | V_ |
Sum of cell volumes. More... | |
Protected Attributes inherited from option | |
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... | |
Additional Inherited Members | |
Static Public Member Functions inherited from option | |
static autoPtr< option > | New (const word &name, const dictionary &dict, const fvMesh &mesh) |
Return a reference to the selected fvOption model. More... | |
Cell-set options abtract base class. Provides a base set of controls, e.g.:
type scalarExplicitSource // Source type active on; // on/off switch timeStart 0.0; // Start time duration 1000.0; // Duration selectionMode cellSet; // cellSet, points, cellZone . . .
Definition at line 69 of file cellSetOption.H.
enum selectionModeType |
Enumeration for selection mode types.
Enumerator | |
---|---|
smPoints | |
smCellSet | |
smCellZone | |
smAll |
Definition at line 78 of file cellSetOption.H.
cellSetOption | ( | const word & | name, |
const word & | modelType, | ||
const dictionary & | dict, | ||
const fvMesh & | mesh | ||
) |
Construct from components.
Definition at line 185 of file cellSetOption.C.
References Foam::decrIndent(), Foam::incrIndent(), Foam::Info, and Foam::read().
Referenced by cellSetOption::setCellSet().
|
virtual |
Destructor.
Definition at line 212 of file cellSetOption.C.
|
protected |
Set the cellSet or points selection.
Definition at line 57 of file cellSetOption.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and dictionary::lookup().
|
protected |
Set the cell set based on the user input selection mode.
Definition at line 92 of file cellSetOption.C.
References cellSetOption::cellSetOption(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::identity(), Foam::indent(), Foam::Info, HashSet< Key, Hash >::insert(), Foam::reduce(), Foam::returnReduce(), HashTable< T, Key, Hash >::toc(), and WarningInFunction.
TypeName | ( | "cellSetOption" | ) |
Runtime type information.
|
inline |
Return const access to the time start.
Definition at line 28 of file cellSetOptionI.H.
References cellSetOption::timeStart_.
|
inline |
Return const access to the duration.
Definition at line 34 of file cellSetOptionI.H.
References cellSetOption::duration_.
|
inline |
Return true if within time limits.
Definition at line 40 of file cellSetOptionI.H.
References cellSetOption::duration_, option::mesh_, fvMesh::time(), cellSetOption::timeStart_, and dimensioned< Type >::value().
|
inline |
Return const access to the cell selection mode.
Definition at line 55 of file cellSetOptionI.H.
References cellSetOption::selectionMode_.
|
inline |
Return const access to the name of cell set for "cellSet".
selectionMode
Definition at line 61 of file cellSetOptionI.H.
References cellSetOption::cellSetName_.
|
inline |
Return const access to the total cell volume.
Definition at line 67 of file cellSetOptionI.H.
References cellSetOption::V_.
|
inline |
Return const access to the cell set.
Definition at line 73 of file cellSetOptionI.H.
References cellSetOption::cells_.
|
inline |
Return access to the time start.
Definition at line 79 of file cellSetOptionI.H.
References cellSetOption::timeStart_.
|
inline |
Return access to the duration.
Definition at line 85 of file cellSetOptionI.H.
References cellSetOption::duration_.
|
virtual |
Is the source active?
Reimplemented from option.
Definition at line 218 of file cellSetOption.C.
References option::isActive().
|
virtual |
Read source dictionary.
Reimplemented from option.
Reimplemented in solidificationMeltingSource, rotorDiskSource, effectivenessHeatExchangerSource, CodedSource< Type >, VoFSolidificationMeltingSource, actuationDiskSource, SemiImplicitSource< Type >, verticalDamping, radialActuationDiskSource, meanVelocityForce, explicitPorositySource, velocityRamping, fixedTemperatureConstraint, limitTemperature, limitVelocity, and FixedValueConstraint< Type >.
Definition at line 30 of file cellSetOptionIO.C.
References option::coeffs_, cellSetOption::duration_, dictionary::lookup(), option::read(), dictionary::readIfPresent(), and cellSetOption::timeStart_.
Referenced by limitVelocity::read(), limitTemperature::read(), fixedTemperatureConstraint::read(), velocityRamping::read(), explicitPorositySource::read(), verticalDamping::read(), actuationDiskSource::read(), effectivenessHeatExchangerSource::read(), and solidificationMeltingSource::read().
|
static |
Word list of selection mode type names.
Definition at line 88 of file cellSetOption.H.
Referenced by NamedEnum< directionType, 3 >::names().
|
protected |
Time start.
Definition at line 96 of file cellSetOption.H.
Referenced by cellSetOption::inTimeLimits(), cellSetOption::read(), and cellSetOption::timeStart().
|
protected |
Duration.
Definition at line 99 of file cellSetOption.H.
Referenced by cellSetOption::duration(), cellSetOption::inTimeLimits(), and cellSetOption::read().
|
protected |
Cell selection mode.
Definition at line 102 of file cellSetOption.H.
Referenced by cellSetOption::selectionMode().
|
protected |
Name of cell set for "cellSet" and "cellZone" selectionMode.
Definition at line 105 of file cellSetOption.H.
Referenced by cellSetOption::cellSetName().
List of points for "points" selectionMode.
Definition at line 108 of file cellSetOption.H.
|
protected |
Set of cells to apply source to.
Definition at line 111 of file cellSetOption.H.
Referenced by cellSetOption::cells().
|
protected |
Sum of cell volumes.
Definition at line 114 of file cellSetOption.H.
Referenced by cellSetOption::V().