ExplicitSetValue< Type > Class Template Reference
Inheritance diagram for ExplicitSetValue< Type >:
Collaboration diagram for ExplicitSetValue< Type >:

Public Member Functions

 TypeName ("explicitSetValue")
 Runtime type information. More...
 
 ExplicitSetValue (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
virtual void setValue (fvMatrix< Type > &eqn, const label fieldI)
 Set value on field. More...
 
virtual void writeData (Ostream &) const
 Write the source properties. 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, const bool master=false)
 Construct from components. More...
 
autoPtr< optionclone () const
 Return clone. More...
 
virtual ~option ()
 Destructor. More...
 
const wordname () const
 Return const access to the source name. More...
 
const fvMeshmesh () const
 Return const access to the mesh database. More...
 
const dictionarycoeffs () const
 Return dictionary. More...
 
bool active () const
 Return const access to the source active flag. 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 selectionModeTypeselectionMode () const
 Return const access to the cell selection mode. More...
 
const wordcellSetName () 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 wordnbrRegionName () const
 Return const access to the neighbour region name. More...
 
const meshToMeshmeshInterp () const
 Return const access to the mapToMap pointer. More...
 
const labelListcells () const
 Return const access to the cell set. More...
 
void setApplied (const label fieldI)
 Set the applied flag to true for field index fieldI. More...
 
bool & active ()
 Return access to the source active flag. 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 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 correct (volScalarField &fld)
 Scalar. More...
 
virtual void correct (volVectorField &fld)
 Vector. More...
 
virtual void correct (volSphericalTensorField &fld)
 Spherical tensor. More...
 
virtual void correct (volSymmTensorField &fld)
 Symmetric tensor. More...
 
virtual void correct (volTensorField &fld)
 Tensor. More...
 
virtual void addSup (fvMatrix< scalar > &eqn, const label fieldI)
 Scalar. More...
 
virtual void addSup (fvMatrix< vector > &eqn, const label fieldI)
 Vector. More...
 
virtual void addSup (fvMatrix< symmTensor > &eqn, const label fieldI)
 Spherical tensor. More...
 
virtual void addSup (fvMatrix< sphericalTensor > &eqn, const label fieldI)
 Symmetric tensor. More...
 
virtual void addSup (fvMatrix< tensor > &eqn, const label fieldI)
 Tensor. More...
 
virtual void addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldI)
 Scalar. More...
 
virtual void addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldI)
 Vector. More...
 
virtual void addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldI)
 Spherical tensor. More...
 
virtual void addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldI)
 Symmetric tensor. More...
 
virtual void addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldI)
 Tensor. More...
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldI)
 Scalar. More...
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldI)
 Vector. More...
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldI)
 Spherical tensor. More...
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldI)
 Symmetric tensor. More...
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldI)
 Tensor. More...
 
virtual void setValue (fvMatrix< scalar > &eqn, const label fieldI)
 Scalar. More...
 
virtual void setValue (fvMatrix< vector > &eqn, const label fieldI)
 Vector. More...
 
virtual void setValue (fvMatrix< sphericalTensor > &eqn, const label fieldI)
 Spherical tensor. More...
 
virtual void setValue (fvMatrix< symmTensor > &eqn, const label fieldI)
 Symmetric tensor. More...
 
virtual void setValue (fvMatrix< tensor > &eqn, const label fieldI)
 Tensor. More...
 
virtual void makeRelative (surfaceScalarField &phi) const
 Make the given absolute flux relative. More...
 
virtual void makeRelative (FieldField< fvsPatchField, scalar > &phi) const
 Make the given absolute boundary flux relative. More...
 
virtual void makeRelative (const surfaceScalarField &rho, surfaceScalarField &phi) const
 Make the given absolute mass-flux relative. More...
 
virtual void makeAbsolute (surfaceScalarField &phi) const
 Make the given relative flux absolute. More...
 
virtual void makeAbsolute (const surfaceScalarField &rho, surfaceScalarField &phi) const
 Make the given relative mass-flux absolute. More...
 
virtual void writeHeader (Ostream &) const
 Write the source header information. More...
 
virtual void writeFooter (Ostream &) const
 Write the source footer information. More...
 

Protected Member Functions

void setFieldData (const dictionary &dict)
 Set the local field data. More...
 
- Protected Member Functions inherited from option
virtual bool alwaysApply () const
 Flag to bypass the apply flag list checking. More...
 
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

List< Type > injectionRate_
 Source value per field. More...
 
- Protected Attributes inherited from option
const word name_
 Source name. More...
 
const word modelType_
 Model type. More...
 
const fvMeshmesh_
 Reference to the mesh database. More...
 
dictionary dict_
 Top level source dictionary. More...
 
dictionary coeffs_
 Dictionary containing source coefficients. More...
 
bool active_
 Source active flag. More...
 
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< pointpoints_
 List of points for "points" selectionMode. More...
 
labelList cells_
 Set of cells to apply source to. More...
 
scalar V_
 Sum of cell volumes. More...
 
autoPtr< meshToMeshmeshInterpPtr_
 Mesh to mesh interpolation object. More...
 
word nbrRegionName_
 Name of the neighbour region to map. More...
 
bool master_
 Master or slave region. 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

- Public Types inherited from option
enum  selectionModeType {
  smPoints, smCellSet, smCellZone, smMapRegion,
  smAll
}
 Enumeration for selection mode types. More...
 
- Static Public Member Functions inherited from option
static autoPtr< optionNew (const word &name, const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected fvOption model. More...
 
- Static Public Attributes inherited from option
static const NamedEnum
< selectionModeType, 5 > 
selectionModeTypeNames_
 Word list of selection mode type names. More...
 

Detailed Description

template<class Type>
class Foam::fv::ExplicitSetValue< Type >

Definition at line 68 of file ExplicitSetValue.H.

Constructor & Destructor Documentation

ExplicitSetValue ( const word name,
const word modelType,
const dictionary dict,
const fvMesh mesh 
)

Construct from components.

Definition at line 55 of file ExplicitSetValue.C.

Member Function Documentation

void setFieldData ( const dictionary dict)
protected

Set the local field data.

Definition at line 34 of file ExplicitSetValue.C.

References forAllConstIter, dictionary::lookup(), List< T >::size(), and dictionary::toc().

Here is the call graph for this function:

TypeName ( "explicitSetValue"  )

Runtime type information.

void setValue ( fvMatrix< Type > &  eqn,
const label  fieldI 
)
virtual

Set value on field.

Definition at line 73 of file ExplicitSetValue.C.

References Foam::endl(), Foam::Info, and fvMatrix< Type >::setValues().

Here is the call graph for this function:

void writeData ( Ostream os) const
virtual

Write the source properties.

Reimplemented from option.

Definition at line 31 of file ExplicitSetValueIO.C.

References Foam::endl(), Foam::indent(), and Ostream::write().

Here is the call graph for this function:

bool read ( const dictionary dict)
virtual

Read source dictionary.

Reimplemented from option.

Definition at line 39 of file ExplicitSetValueIO.C.

Member Data Documentation

List<Type> injectionRate_
protected

Source value per field.

Definition at line 78 of file ExplicitSetValue.H.


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