Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
transferModel Class Referenceabstract

Base class for film transfer models, handling mass transfer between the film and the continuous phase. More...

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

Public Member Functions

 TypeName ("transferModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, transferModel, dictionary,(surfaceFilmModel &film, const dictionary &dict),(film, dict))
 
 transferModel (surfaceFilmModel &film)
 Construct for film. More...
 
 transferModel (const word &modelType, surfaceFilmModel &film, const dictionary &dict)
 Construct from type name, dictionary and surface film model. More...
 
virtual ~transferModel ()
 Destructor. More...
 
virtual void correct (scalarField &availableMass, scalarField &massToTransfer)=0
 Correct kinematic transfers. More...
 
virtual void correct (scalarField &availableMass, scalarField &massToTransfer, scalarField &energyToTransfer)
 Correct kinematic and thermodynamic transfers. More...
 
virtual scalar transferredMassTotal () const
 Return the total mass transferred. More...
 
virtual void patchTransferredMassTotals (scalarField &patchMasses) const
 Accumulate the total mass transferred for the patches into the. 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< transferModelNew (surfaceFilmModel &film, const dictionary &dict, const word &modelType)
 Return a reference to the selected injection model. More...
 

Protected Member Functions

void addToTransferredMass (const scalar dMass)
 Add to transferred mass. More...
 
void correct ()
 Correct. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 

Additional Inherited Members

- 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...
 

Detailed Description

Base class for film transfer models, handling mass transfer between the film and the continuous phase.

Source files

Definition at line 56 of file transferModel.H.

Constructor & Destructor Documentation

◆ transferModel() [1/2]

Construct for film.

Definition at line 52 of file transferModel.C.

◆ transferModel() [2/2]

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

Construct from type name, dictionary and surface film model.

Definition at line 60 of file transferModel.C.

◆ ~transferModel()

~transferModel ( )
virtual

Destructor.

Definition at line 73 of file transferModel.C.

Member Function Documentation

◆ addToTransferredMass()

void addToTransferredMass ( const scalar  dMass)
protected

Add to transferred mass.

Definition at line 44 of file transferModel.C.

◆ correct() [1/3]

void correct ( )
protected

Correct.

Definition at line 79 of file transferModel.C.

References Foam::returnReduce(), and filmSubModelBase::writeTime().

Referenced by transferModel::correct().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TypeName()

TypeName ( "transferModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

autoPtr< transferModel > New ( surfaceFilmModel film,
const dictionary dict,
const word modelType 
)
static

Return a reference to the selected injection model.

Definition at line 40 of file transferModelNew.C.

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

Referenced by transferModelList::transferModelList().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ correct() [2/3]

virtual void correct ( scalarField availableMass,
scalarField massToTransfer 
)
pure virtual

Correct kinematic transfers.

Implemented in VoFPatchTransfer.

◆ correct() [3/3]

void correct ( scalarField availableMass,
scalarField massToTransfer,
scalarField energyToTransfer 
)
virtual

Correct kinematic and thermodynamic transfers.

Reimplemented in VoFPatchTransfer.

Definition at line 91 of file transferModel.C.

References transferModel::correct(), filmSubModelBase::film(), surfaceFilmModel::hs(), and List< T >::size().

Here is the call graph for this function:

◆ transferredMassTotal()

scalar transferredMassTotal ( ) const
virtual

Return the total mass transferred.

Definition at line 103 of file transferModel.C.

References Foam::returnReduce().

Referenced by transferModelList::info().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ patchTransferredMassTotals()

virtual void patchTransferredMassTotals ( scalarField patchMasses) const
inlinevirtual

Accumulate the total mass transferred for the patches into the.

scalarField provided

Reimplemented in VoFPatchTransfer.

Definition at line 158 of file transferModel.H.

Referenced by transferModelList::info().

Here is the caller graph for this function:

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