filmSeparationModel Class Reference

A base class for filmSeparation models. More...

#include <filmSeparationModel.H>

Inheritance diagram for filmSeparationModel:

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

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

Detailed Description

A base class for filmSeparation models.

Source files

• filmSeparationModel.H
• filmSeparationModel.C
• filmSeparationModelNew.C

Definition at line 54 of file filmSeparationModel.H.

Constructor & Destructor Documentation

filmSeparationModel() [1/2]

filmSeparationModel ( const filmSeparationModel & )

delete

No copy construct.

References filmSeparationModel().

Referenced by declareRunTimeSelectionTable(), filmSeparationModel(), FriedrichModel::FriedrichModel(), operator=(), and OwenRyleyModel::OwenRyleyModel().

Here is the call graph for this function:

Here is the caller graph for this function:

filmSeparationModel() [2/2]

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

Construct from the base film model and dictionary.

Definition at line 34 of file filmSeparationModel.C.

References dict, and film().

Here is the call graph for this function:

~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)	)

References dict, film(), and filmSeparationModel().

Here is the call graph for this function:

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 25 of file filmSeparationModelNew.C.

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

Here is the call graph for this function:

operator=()

void operator= ( const filmSeparationModel & )

delete

No copy assignment.

References dict, film(), and filmSeparationModel().

Here is the call graph for this function:

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 declareRunTimeSelectionTable(), filmSeparationModel(), FriedrichModel::FriedrichModel(), New(), operator=(), OwenRyleyModel::OwenRyleyModel(), OwenRyleyModel::separatedMassRatio(), FriedrichModel::TypeName(), and OwenRyleyModel::TypeName().

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 Foam::noexcept.

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

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:

• src/regionFaModels/liquidFilm/subModels/kinematic/injectionModel/filmSeparation/filmSeparationModels/filmSeparationModel/filmSeparationModel.H
• src/regionFaModels/liquidFilm/subModels/kinematic/injectionModel/filmSeparation/filmSeparationModels/filmSeparationModel/filmSeparationModel.C
• src/regionFaModels/liquidFilm/subModels/kinematic/injectionModel/filmSeparation/filmSeparationModels/filmSeparationModel/filmSeparationModelNew.C