Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
surfaceFilmModel Class Referenceabstract

Base class for surface film models. More...

Inheritance diagram for surfaceFilmModel:
[legend]
Collaboration diagram for surfaceFilmModel:
[legend]

Public Member Functions

 TypeName ("surfaceFilmModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, surfaceFilmModel, mesh,(const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType),(modelType, mesh, g, regionType))
 
 surfaceFilmModel ()
 Constructor. More...
 
virtual ~surfaceFilmModel ()
 Destructor. More...
 
virtual scalar CourantNumber () const =0
 Courant number evaluation. More...
 
virtual tmp< volScalarField::Internal > Srho () const =0
 Return total mass source - Eulerian phase only. More...
 
virtual tmp< volScalarField::Internal > Srho (const label i) const =0
 Return mass source for specie i - Eulerian phase only. More...
 
virtual tmp< volScalarField::Internal > Sh () const =0
 Return enthalpy source - Eulerian phase only. More...
 
virtual void evolve ()=0
 Main driver routing to evolve the region - calls other evolves. More...
 

Static Public Member Functions

static autoPtr< surfaceFilmModel > New (const fvMesh &mesh, const dimensionedVector &g, const word &regionType="surfaceFilm")
 Return a reference to the selected surface film model. More...
 

Static Public Attributes

static const dimensionedScalar Tref
 Reference temperature for enthalpy. More...
 

Detailed Description

Base class for surface film models.

Source files

Definition at line 55 of file surfaceFilmModel.H.

Constructor & Destructor Documentation

◆ surfaceFilmModel()

surfaceFilmModel ( )

Constructor.

Definition at line 52 of file surfaceFilmModel.C.

◆ ~surfaceFilmModel()

~surfaceFilmModel ( )
virtual

Destructor.

Definition at line 58 of file surfaceFilmModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceFilmModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
surfaceFilmModel  ,
mesh  ,
(const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType)  ,
(modelType, mesh, g, regionType)   
)

◆ New()

autoPtr< surfaceFilmModel > New ( const fvMesh &  mesh,
const dimensionedVector &  g,
const word &  regionType = "surfaceFilm" 
)
static

Return a reference to the selected surface film model.

Definition at line 42 of file surfaceFilmModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, g, Foam::Info, mesh, IOobject::MUST_READ, and IOobject::NO_WRITE.

Here is the call graph for this function:

◆ CourantNumber()

virtual scalar CourantNumber ( ) const
pure virtual

Courant number evaluation.

Implemented in kinematicSingleLayer, and noFilm.

◆ Srho() [1/2]

virtual tmp<volScalarField::Internal> Srho ( ) const
pure virtual

Return total mass source - Eulerian phase only.

Implemented in kinematicSingleLayer, thermoSingleLayer, and noFilm.

◆ Srho() [2/2]

virtual tmp<volScalarField::Internal> Srho ( const label  i) const
pure virtual

Return mass source for specie i - Eulerian phase only.

Implemented in kinematicSingleLayer, thermoSingleLayer, and noFilm.

◆ Sh()

virtual tmp<volScalarField::Internal> Sh ( ) const
pure virtual

Return enthalpy source - Eulerian phase only.

Implemented in kinematicSingleLayer, thermoSingleLayer, and noFilm.

◆ evolve()

virtual void evolve ( )
pure virtual

Main driver routing to evolve the region - calls other evolves.

Implemented in surfaceFilmRegionModel, and noFilm.

Member Data Documentation

◆ Tref

const dimensionedScalar Tref
static

Reference temperature for enthalpy.

Definition at line 72 of file surfaceFilmModel.H.

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