surfaceFilmModel Class Reference

Base class for surface film models. More...

Inheritance diagram for surfaceFilmModel:

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 ()
	surfaceFilmModel (const surfaceFilmModel &)=delete
	Disallow default bitwise copy construction. More...
virtual	~surfaceFilmModel ()
	Destructor. More...
virtual scalar	CourantNumber () const =0
	Courant number evaluation. More...
virtual void	evolve ()=0
	Main driver routing to evolve the region - calls other evolves. More...
virtual tmp< volScalarField::Internal >	Srho () const =0
	Return total mass source - Eulerian phase only. More...
virtual tmp< volScalarField::Internal >	SYi (const label i) const =0
	Return mass source for specie i - Eulerian phase only. More...
virtual tmp< volVectorField::Internal >	SU () const =0
	Return momentum source - Eulerian phase only. More...
virtual tmp< volScalarField::Internal >	Sh () const =0
	Return enthalpy source - Eulerian phase only. More...
void	operator= (const surfaceFilmModel &)=delete
	Disallow default bitwise assignment. 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...

Detailed Description

Base class for surface film models.

Source files

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

Definition at line 53 of file surfaceFilmModel.H.

Constructor & Destructor Documentation

surfaceFilmModel() [1/2]

surfaceFilmModel

(

)

Definition at line 43 of file surfaceFilmModel.C.

surfaceFilmModel() [2/2]

surfaceFilmModel ( const surfaceFilmModel &  )

delete

Disallow default bitwise copy construction.

~surfaceFilmModel()

~surfaceFilmModel ( )

virtual

Destructor.

Definition at line 49 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 39 of file surfaceFilmModelNew.C.

References TimePaths::constant(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, g, Foam::Info, dictionary::lookup(), mesh, IOobject::MUST_READ, Foam::nl, IOobject::NO_WRITE, and fvMesh::time().

Here is the call graph for this function:

CourantNumber()

virtual scalar CourantNumber ( ) const

pure virtual

Courant number evaluation.

Implemented in kinematicSingleLayer, and noFilm.

evolve()

virtual void evolve ( )

pure virtual

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

Implemented in surfaceFilmRegionModel, and noFilm.

Srho()

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

pure virtual

Return total mass source - Eulerian phase only.

Implemented in kinematicSingleLayer, and noFilm.

SYi()

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

pure virtual

Return mass source for specie i - Eulerian phase only.

Implemented in kinematicSingleLayer, thermoSingleLayer, and noFilm.

SU()

virtual tmp<volVectorField::Internal> SU ( ) const

pure virtual

Return momentum source - Eulerian phase only.

Implemented in kinematicSingleLayer, and noFilm.

Sh()

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

pure virtual

Return enthalpy source - Eulerian phase only.

Implemented in kinematicSingleLayer, thermoSingleLayer, and noFilm.

operator=()

void operator= ( const surfaceFilmModel &  )

delete

Disallow default bitwise assignment.

---

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