FreeFOAM The Cross-Platform CFD Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
PhaseChangeModel< CloudType > Class Template Reference

Templated phase change model class. More...

#include <lagrangianIntermediate/PhaseChangeModel.H>

Detailed Description

template<class CloudType>
class Foam::PhaseChangeModel< CloudType >

Templated phase change model class.

Source files

Definition at line 53 of file PhaseChangeModel.H.

+ Inheritance diagram for PhaseChangeModel< CloudType >:
+ Collaboration diagram for PhaseChangeModel< CloudType >:

List of all members.

Public Types

enum  enthalpyTransferType { etLatentHeat, etEnthalpyDifference }
 Enthalpy transfer type. More...

Public Member Functions

 TypeName ("PhaseChangeModel")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, PhaseChangeModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table.
 PhaseChangeModel (CloudType &owner)
 Construct null from owner.
 PhaseChangeModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from dictionary.
virtual ~PhaseChangeModel ()
 Destructor.
const CloudType & owner () const
 Return the owner cloud object.
const dictionary & dict () const
 Return the cloud dictionary.
const dictionary & coeffDict () const
 Return the coefficient dictionary.
const enthalpyTransferType & enthalpyTransfer () const
 Return the enthalpy transfer type enumeration.
virtual bool active () const =0
 Flag to indicate whether model activates phase change model.
virtual void calculate (const scalar dt, const label cellI, const scalar Re, const scalar d, const scalar nu, const scalar T, const scalar Ts, const scalar pc, scalarField &dMassPC) const =0
 Update model.

Static Public Member Functions

static autoPtr
< PhaseChangeModel< CloudType > > 		New (const dictionary &dict, CloudType &owner)
 Selector.

Static Public Attributes

static const Foam::wordList enthalpyTransferTypeNames
 Name representations of enthalpy transfer types.

Protected Member Functions

enthalpyTransferType wordToEnthalpyTransfer (const word &etName) const
 Convert word to enthalpy transfer type.
scalar Sh () const
 Sherwood number.

Protected Attributes

const dictionary & dict_
 The cloud dictionary.
CloudType & owner_
 Reference to the owner cloud class.
const dictionary coeffDict_
 The coefficient dictionary.
enthalpyTransferType enthalpyTransfer_
 Enthalpy transfer type enumeration.

Member Enumeration Documentation

enum enthalpyTransferType

Enthalpy transfer type.

Enumerator:
etLatentHeat 
etEnthalpyDifference 

Definition at line 60 of file PhaseChangeModel.H.

Constructor & Destructor Documentation

PhaseChangeModel ( CloudType &  owner)

Construct null from owner.

Definition at line 74 of file PhaseChangeModel.C.

PhaseChangeModel ( const dictionary &  dict,
CloudType &  owner,
const word &  type 
)

Construct from dictionary.

Definition at line 87 of file PhaseChangeModel.C.

~PhaseChangeModel ( )
virtual

Destructor.

Definition at line 106 of file PhaseChangeModel.C.

Member Function Documentation

Foam::PhaseChangeModel< CloudType >::enthalpyTransferType wordToEnthalpyTransfer ( const word &  etName) const
protected

Convert word to enthalpy transfer type.

Definition at line 48 of file PhaseChangeModel.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, forAll, and Foam::nl.

scalar Sh ( ) const
protected

Sherwood number.

TypeName ( "PhaseChangeModel< CloudType >"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
PhaseChangeModel< CloudType >  ,
dictionary  ,
(const dictionary &dict, CloudType &owner)  ,
(dict, owner)   
)

Declare runtime constructor selection table.

Foam::autoPtr< Foam::PhaseChangeModel< CloudType > > New ( const dictionary &  dict,
CloudType &  owner 
)
static

Selector.

Definition at line 33 of file NewPhaseChangeModel.C.

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

const CloudType & owner ( ) const

Return the owner cloud object.

Definition at line 112 of file PhaseChangeModel.C.

const Foam::dictionary & dict ( ) const

Return the cloud dictionary.

Definition at line 119 of file PhaseChangeModel.C.

const Foam::dictionary & coeffDict ( ) const

Return the coefficient dictionary.

Definition at line 126 of file PhaseChangeModel.C.

const Foam::PhaseChangeModel< CloudType >::enthalpyTransferType & enthalpyTransfer ( ) const

Return the enthalpy transfer type enumeration.

Definition at line 134 of file PhaseChangeModel.C.

virtual bool active ( ) const
pure virtual

Flag to indicate whether model activates phase change model.

Implemented in LiquidEvaporation< CloudType >, and NoPhaseChange< CloudType >.

virtual void calculate ( const scalar  dt,
const label  cellI,
const scalar  Re,
const scalar  d,
const scalar  nu,
const scalar  T,
const scalar  Ts,
const scalar  pc,
scalarField &  dMassPC 
) const
pure virtual

Update model.

Implemented in LiquidEvaporation< CloudType >, and NoPhaseChange< CloudType >.

Member Data Documentation

const Foam::wordList enthalpyTransferTypeNames
static

Name representations of enthalpy transfer types.

Definition at line 67 of file PhaseChangeModel.H.

const dictionary& dict_
protected

The cloud dictionary.

Definition at line 75 of file PhaseChangeModel.H.

CloudType& owner_
protected

Reference to the owner cloud class.

Definition at line 78 of file PhaseChangeModel.H.

const dictionary coeffDict_
protected

The coefficient dictionary.

Definition at line 81 of file PhaseChangeModel.H.

enthalpyTransferType enthalpyTransfer_
protected

Enthalpy transfer type enumeration.

Definition at line 84 of file PhaseChangeModel.H.

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