surfaceFilmModel Class Reference

Base class for surface film models. More...

Inheritance diagram for surfaceFilmModel:

Collaboration diagram for surfaceFilmModel:

Public Member Functions
	TypeName ("surfaceFilmModel")
	declareRunTimeSelectionTable (autoPtr, surfaceFilmModel, mesh,(const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType),(modelType, mesh, g, regionType))
	surfaceFilmModel ()
virtual	~surfaceFilmModel ()
virtual scalar	CourantNumber () const =0
virtual tmp< volScalarField::Internal >	Srho () const =0
virtual tmp< volScalarField::Internal >	Srho (const label i) const =0
virtual tmp< volScalarField::Internal >	Sh () const =0
virtual void	evolve ()=0

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

Static Public Attributes
static const dimensionedScalar	Tref

Detailed Description

Base class for surface film models.

Source files

• surfaceFilmModel.H
• surfaceFilmModelI.H
• surfaceFilmModel.C
• surfaceFilmModelNew.C

Definition at line 51 of file surfaceFilmModel.H.

Constructor & Destructor Documentation

surfaceFilmModel()

surfaceFilmModel

(

)

Definition at line 45 of file surfaceFilmModel.C.

~surfaceFilmModel()

~surfaceFilmModel ( )

virtual

Definition at line 51 of file surfaceFilmModel.C.

Member Function Documentation

TypeName()

TypeName

(

"surfaceFilmModel"

)

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

Definition at line 35 of file surfaceFilmModelNew.C.

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

Here is the call graph for this function:

CourantNumber()

virtual scalar CourantNumber ( ) const

pure virtual

Implemented in kinematicSingleLayer, and noFilm.

Srho() [1/2]

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

pure virtual

Implemented in kinematicSingleLayer, thermoSingleLayer, and noFilm.

Srho() [2/2]

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

pure virtual

Implemented in kinematicSingleLayer, thermoSingleLayer, and noFilm.

Sh()

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

pure virtual

Implemented in kinematicSingleLayer, thermoSingleLayer, and noFilm.

evolve()

virtual void evolve ( )

pure virtual

Implemented in surfaceFilmRegionModel, and noFilm.

Member Data Documentation

Tref

const dimensionedScalar Tref

static

Definition at line 68 of file surfaceFilmModel.H.

---

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

• src/regionModels/surfaceFilmModels/surfaceFilmModel/surfaceFilmModel.H
• src/regionModels/surfaceFilmModels/surfaceFilmModel/surfaceFilmModel.C
• src/regionModels/surfaceFilmModels/surfaceFilmModel/surfaceFilmModelNew.C