Public Member Functions | Static Public Member Functions | List of all members
filmSeparationModel Class Referenceabstract

A base class for filmSeparation models. More...

Inheritance diagram for filmSeparationModel:
Inheritance graph
[legend]

Public Member Functions

 TypeName ("filmSeparationModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, filmSeparationModel, dictionary,(const regionModels::areaSurfaceFilmModels::liquidFilmBase &film, const dictionary &dict),(film, dict))
 
 filmSeparationModel (const filmSeparationModel &)=delete
 No copy construct. More...
 
void operator= (const filmSeparationModel &)=delete
 No copy assignment. More...
 
 filmSeparationModel (const regionModels::areaSurfaceFilmModels::liquidFilmBase &film, const dictionary &dict)
 Construct from the base film model and dictionary. More...
 
virtual ~filmSeparationModel ()=default
 Destructor. More...
 
const regionModels::areaSurfaceFilmModels::liquidFilmBase & film () const
 Return const access to the film properties. More...
 
const faMesh & mesh () const noexcept
 Return const access to the finite-area mesh. More...
 
virtual tmp< scalarField > separatedMassRatio () const =0
 Calculate the mass ratio of film separation. More...
 

Static Public Member Functions

static autoPtr< filmSeparationModel > New (const regionModels::areaSurfaceFilmModels::liquidFilmBase &film, const dictionary &dict)
 Return a reference to the selected filmSeparation model. More...
 

Detailed Description

A base class for filmSeparation models.

Source files

Definition at line 54 of file filmSeparationModel.H.

Constructor & Destructor Documentation

◆ filmSeparationModel() [1/2]

filmSeparationModel ( const filmSeparationModel &  )
delete

No copy construct.

◆ filmSeparationModel() [2/2]

filmSeparationModel ( const regionModels::areaSurfaceFilmModels::liquidFilmBase &  film,
const dictionary &  dict 
)

Construct from the base film model and dictionary.

Definition at line 35 of file filmSeparationModel.C.

◆ ~filmSeparationModel()

virtual ~filmSeparationModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "filmSeparationModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
filmSeparationModel  ,
dictionary  ,
(const regionModels::areaSurfaceFilmModels::liquidFilmBase &film, const dictionary &dict)  ,
(film, dict)   
)

◆ New()

Foam::autoPtr< Foam::filmSeparationModel > New ( const regionModels::areaSurfaceFilmModels::liquidFilmBase &  film,
const dictionary &  dict 
)
static

Return a reference to the selected filmSeparation model.

Definition at line 26 of file filmSeparationModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::getWord(), Foam::Info, and Foam::nl.

Here is the call graph for this function:

◆ operator=()

void operator= ( const filmSeparationModel &  )
delete

No copy assignment.

◆ film()

const regionModels::areaSurfaceFilmModels::liquidFilmBase& film ( ) const
inline

Return const access to the film properties.

Definition at line 137 of file filmSeparationModel.H.

Referenced by OwenRyleyModel::separatedMassRatio().

Here is the caller graph for this function:

◆ mesh()

const faMesh& mesh ( ) const
inlinenoexcept

Return const access to the finite-area mesh.

Definition at line 145 of file filmSeparationModel.H.

References regionFaModel::regionMesh().

Referenced by OwenRyleyModel::separatedMassRatio(), and FriedrichModel::separatedMassRatio().

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

◆ separatedMassRatio()

virtual tmp<scalarField> separatedMassRatio ( ) const
pure virtual

Calculate the mass ratio of film separation.

Implemented in FriedrichModel, and OwenRyleyModel.

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