Public Member Functions | List of all members
noPhaseChange Class Reference

Dummy phase change model for 'none'. More...

Inheritance diagram for noPhaseChange:
Inheritance graph
[legend]
Collaboration diagram for noPhaseChange:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("none")
 
 noPhaseChange (surfaceFilmRegionModel &film, const dictionary &dict)
 
virtual ~noPhaseChange ()
 
virtual bool active () const
 
virtual void correctModel (const scalar dt, scalarField &availableMass, scalarField &dMass, scalarField &dEnergy)
 
- Public Member Functions inherited from phaseChangeModel
 TypeName ("phaseChangeModel")
 
 declareRunTimeSelectionTable (autoPtr, phaseChangeModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict))
 
 phaseChangeModel (surfaceFilmRegionModel &film)
 
 phaseChangeModel (const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict)
 
virtual ~phaseChangeModel ()
 
virtual void correct (const scalar dt, scalarField &availableMass, volScalarField &dMass, volScalarField &dEnergy)
 
virtual void info (Ostream &os) const
 
- Public Member Functions inherited from filmSubModelBase
 filmSubModelBase (surfaceFilmRegionModel &film)
 
 filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 
 filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
 
virtual ~filmSubModelBase ()
 
virtual bool writeTime () const
 
const surfaceFilmRegionModelfilm () const
 
surfaceFilmRegionModelfilm ()
 
template<class FilmType >
const FilmType & filmType () const
 
- Public Member Functions inherited from subModelBase
 subModelBase (dictionary &properties)
 
 subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 
 subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
 
 subModelBase (const subModelBase &smb)
 
virtual ~subModelBase ()
 
const wordmodelName () const
 
const dictionarydict () const
 
const wordbaseName () const
 
const wordmodelType () const
 
const dictionarycoeffDict () const
 
const dictionaryproperties () const
 
virtual bool defaultCoeffs (const bool printMsg) const
 
virtual void cacheFields (const bool store)
 
virtual fileName localPath () const
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
void getBaseProperty (const word &entryName, Type &value) const
 
template<class Type >
void setBaseProperty (const word &entryName, const Type &value)
 
bool getModelDict (const word &entryName, dictionary &dict) const
 
template<class Type >
void getModelProperty (const word &entryName, Type &value) const
 
template<class Type >
Type getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
void setModelProperty (const word &entryName, const Type &value)
 
virtual void write (Ostream &os) const
 

Additional Inherited Members

- Static Public Member Functions inherited from phaseChangeModel
static autoPtr< phaseChangeModelNew (surfaceFilmRegionModel &film, const dictionary &dict)
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 
- Protected Attributes inherited from phaseChangeModel
scalar latestMassPC_
 
scalar totalMassPC_
 
- Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModelfilmModel_
 
- Protected Attributes inherited from subModelBase
const word modelName_
 
dictionaryproperties_
 
const dictionary dict_
 
const word baseName_
 
const word modelType_
 
const dictionary coeffDict_
 

Detailed Description

Dummy phase change model for 'none'.

Source files

Definition at line 50 of file noPhaseChange.H.

Constructor & Destructor Documentation

◆ noPhaseChange()

noPhaseChange ( surfaceFilmRegionModel film,
const dictionary dict 
)

Definition at line 41 of file noPhaseChange.C.

◆ ~noPhaseChange()

~noPhaseChange ( )
virtual

Definition at line 52 of file noPhaseChange.C.

Member Function Documentation

◆ TypeName()

TypeName ( "none"  )

◆ active()

bool active ( ) const
virtual

Reimplemented from subModelBase.

Definition at line 58 of file noPhaseChange.C.

◆ correctModel()

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

Implements phaseChangeModel.

Definition at line 65 of file noPhaseChange.C.


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