Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
phaseChangeModel Class Referenceabstract
Inheritance diagram for phaseChangeModel:
Inheritance graph
[legend]
Collaboration diagram for phaseChangeModel:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("phaseChangeModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, phaseChangeModel, dictionary,(surfaceFilmModel &film, const dictionary &dict),(film, dict))
 
 phaseChangeModel (surfaceFilmModel &film)
 Construct null. More...
 
 phaseChangeModel (const word &modelType, surfaceFilmModel &film, const dictionary &dict)
 Construct from type name, dictionary and surface film model. More...
 
virtual ~phaseChangeModel ()
 Destructor. More...
 
virtual void correct (const scalar dt, scalarField &availableMass, volScalarField &dMass, volScalarField &dEnergy)
 Correct. More...
 
virtual void correctModel (const scalar dt, scalarField &availableMass, scalarField &dMass, scalarField &dEnergy)=0
 Correct. More...
 
virtual void info (Ostream &os) const
 Provide some feedback. More...
 
- Public Member Functions inherited from filmSubModelBase
 filmSubModelBase (surfaceFilmModel &film)
 Construct null. More...
 
 filmSubModelBase (surfaceFilmModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from film film wihout name. More...
 
 filmSubModelBase (const word &modelName, surfaceFilmModel &film, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from film film with name. More...
 
virtual ~filmSubModelBase ()
 Destructor. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
const surfaceFilmModelfilm () const
 Return const access to the film surface film model. More...
 
surfaceFilmModelfilm ()
 Return the reference to the film surface film model. More...
 
template<class FilmType >
const FilmType & filmType () const
 
- Public Member Functions inherited from subModelBase
 subModelBase (dictionary &properties)
 Construct null. More...
 
 subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from components without name. More...
 
 subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from components with name. More...
 
 subModelBase (const subModelBase &smb)
 Construct as copy. More...
 
virtual ~subModelBase ()
 Destructor. More...
 
const wordmodelName () const
 Return const access to the name of the sub-model. More...
 
const dictionarydict () const
 Return const access to the cloud dictionary. More...
 
const wordbaseName () const
 Return const access to the base name of the sub-model. More...
 
const wordmodelType () const
 Return const access to the sub-model type. More...
 
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionaryproperties () const
 Return const access to the properties dictionary. More...
 
virtual bool defaultCoeffs (const bool printMsg) const
 Returns true if defaultCoeffs is true and outputs on printMsg. More...
 
virtual bool active () const
 Return the model 'active' status - default active = true. More...
 
virtual void cacheFields (const bool store)
 Cache dependant sub-model fields. More...
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
 Retrieve generic property from the base model. More...
 
template<class Type >
void getBaseProperty (const word &entryName, Type &value) const
 Retrieve generic property from the base model. More...
 
template<class Type >
void setBaseProperty (const word &entryName, const Type &value)
 Add generic property to the base model. More...
 
template<class Type >
void getModelProperty (const word &entryName, Type &value) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
Type getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
void setModelProperty (const word &entryName, const Type &value)
 Add generic property to the sub-model. More...
 
virtual void write (Ostream &os) const
 Write. More...
 

Static Public Member Functions

static autoPtr< phaseChangeModelNew (surfaceFilmModel &film, const dictionary &dict)
 Return a reference to the selected phase change model. More...
 

Protected Attributes

scalar latestMassPC_
 Latest mass transfer due to phase change. More...
 
scalar totalMassPC_
 Total mass transfer due to phase change. More...
 
- Protected Attributes inherited from filmSubModelBase
surfaceFilmModelfilmModel_
 Reference to the film surface film model. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 Reference to properties dictionary e.g. for restart. More...
 
const dictionary dict_
 Copy of dictionary used during construction. More...
 
const word baseName_
 Name of the sub-model base class. More...
 
const word modelType_
 Type of the sub-model. More...
 
const dictionary coeffDict_
 Coefficients dictionary. More...
 

Additional Inherited Members

- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 

Detailed Description

Definition at line 55 of file phaseChangeModel.H.

Constructor & Destructor Documentation

◆ phaseChangeModel() [1/2]

Construct null.

Definition at line 45 of file phaseChangeModel.C.

◆ phaseChangeModel() [2/2]

phaseChangeModel ( const word modelType,
surfaceFilmModel film,
const dictionary dict 
)

Construct from type name, dictionary and surface film model.

Definition at line 56 of file phaseChangeModel.C.

◆ ~phaseChangeModel()

~phaseChangeModel ( )
virtual

Destructor.

Definition at line 70 of file phaseChangeModel.C.

References phaseChangeModel::correct().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "phaseChangeModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
phaseChangeModel  ,
dictionary  ,
(surfaceFilmModel &film, const dictionary &dict ,
(film, dict  
)

◆ New()

autoPtr< phaseChangeModel > New ( surfaceFilmModel film,
const dictionary dict 
)
static

Return a reference to the selected phase change model.

Definition at line 40 of file phaseChangeModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), and Foam::nl.

Here is the call graph for this function:

◆ correct()

void correct ( const scalar  dt,
scalarField availableMass,
volScalarField dMass,
volScalarField dEnergy 
)
virtual

◆ correctModel()

virtual void correctModel ( const scalar  dt,
scalarField availableMass,
scalarField dMass,
scalarField dEnergy 
)
pure virtual

Correct.

Implemented in standardPhaseChange, solidification, and noPhaseChange.

Referenced by phaseChangeModel::correct().

Here is the caller graph for this function:

◆ info()

void info ( Ostream os) const
virtual

Member Data Documentation

◆ latestMassPC_

scalar latestMassPC_
protected

Latest mass transfer due to phase change.

Definition at line 75 of file phaseChangeModel.H.

Referenced by phaseChangeModel::correct(), and phaseChangeModel::info().

◆ totalMassPC_

scalar totalMassPC_
protected

Total mass transfer due to phase change.

Definition at line 78 of file phaseChangeModel.H.

Referenced by phaseChangeModel::correct(), and phaseChangeModel::info().


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