injectionModel Class Reference

Base class for film injection models, handling mass transfer from the film. More...

Inheritance diagram for injectionModel:

Collaboration diagram for injectionModel:

Public Member Functions
	TypeName ("injectionModel")
	declareRunTimeSelectionTable (autoPtr, injectionModel, dictionary,(liquidFilmBase &film, const dictionary &dict),(film, dict))
	injectionModel (liquidFilmBase &film)
	injectionModel (const word &modelType, liquidFilmBase &film, const dictionary &dict)
virtual	~injectionModel ()
virtual void	correct (scalarField &availableMass, scalarField &massToInject, scalarField &diameterToInject)=0
virtual scalar	injectedMassTotal () const
virtual void	patchInjectedMassTotals (scalar &patchMasses) const
Public Member Functions inherited from filmSubModelBase
	filmSubModelBase (liquidFilmBase &film)
	filmSubModelBase (liquidFilmBase &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	filmSubModelBase (const word &modelName, liquidFilmBase &film, const dictionary &dict, const word &baseName, const word &modelType)
virtual	~filmSubModelBase ()
virtual bool	writeTime () const
const liquidFilmBase &	film () const
liquidFilmBase &	film ()
template<class FilmType >
const FilmType &	filmType () const
Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	subModelBase (const subModelBase &smb)
virtual	~subModelBase ()
const word &	modelName () const
const dictionary &	dict () const
const word &	baseName () const
const word &	modelType () const
const dictionary &	coeffDict () const
const dictionary &	properties () const
virtual bool	defaultCoeffs (const bool printMsg) const
virtual bool	active () const
virtual void	cacheFields (const bool store)
virtual fileName	localPath () const
template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const
template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)
bool	getModelDict (const word &entryName, dictionary &dict) const
template<class Type >
void	getModelProperty (const word &entryName, Type &value) const
template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
void	setModelProperty (const word &entryName, const Type &value)
virtual void	write (Ostream &os) const

Static Public Member Functions
static autoPtr< injectionModel >	New (liquidFilmBase &film, const dictionary &dict, const word &mdoelType)

Protected Member Functions
void	addToInjectedMass (const scalar dMass)
void	correct ()
Protected Member Functions inherited from subModelBase
bool	inLine () const

Additional Inherited Members
Protected Attributes inherited from filmSubModelBase
liquidFilmBase &	filmModel_
Protected Attributes inherited from subModelBase
const word	modelName_
dictionary &	properties_
const dictionary	dict_
const word	baseName_
const word	modelType_
const dictionary	coeffDict_

Detailed Description

Base class for film injection models, handling mass transfer from the film.

Source files

• injectionModel.H
• injectionModel.C
• injectionModelNew.C

Definition at line 54 of file injectionModel.H.

Constructor & Destructor Documentation

injectionModel() [1/2]

injectionModel

(

liquidFilmBase &

film

)

Definition at line 47 of file injectionModel.C.

injectionModel() [2/2]

injectionModel	(	const word &	modelType,
		liquidFilmBase &	film,
		const dictionary &	dict
	)

Definition at line 55 of file injectionModel.C.

~injectionModel()

~injectionModel ( )

virtual

Definition at line 68 of file injectionModel.C.

Member Function Documentation

addToInjectedMass()

void addToInjectedMass ( const scalar  dMass )

protected

Definition at line 39 of file injectionModel.C.

correct() [1/2]

void correct ( )

protected

Definition at line 74 of file injectionModel.C.

References Foam::returnReduce(), and filmSubModelBase::writeTime().

Referenced by injectionModelList::correct(), and curvatureSeparation::correct().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName()

TypeName

(

"injectionModel"

)

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		injectionModel	,
		dictionary	,
		(liquidFilmBase &film, const dictionary &dict)	,
		(film, dict)
	)

New()

autoPtr< injectionModel > New ( liquidFilmBase &  film, const dictionary &  dict, const word &  mdoelType  )

static

Definition at line 35 of file injectionModelNew.C.

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

Referenced by injectionModelList::injectionModelList().

Here is the call graph for this function:

Here is the caller graph for this function:

correct() [2/2]

virtual void correct ( scalarField &  availableMass, scalarField &  massToInject, scalarField &  diameterToInject  )

pure virtual

Implemented in curvatureSeparation.

injectedMassTotal()

scalar injectedMassTotal ( ) const

virtual

Definition at line 86 of file injectionModel.C.

References Foam::returnReduce().

Referenced by injectionModelList::info().

Here is the call graph for this function:

Here is the caller graph for this function:

patchInjectedMassTotals()

virtual void patchInjectedMassTotals ( scalar &  patchMasses ) const

inlinevirtual

Definition at line 149 of file injectionModel.H.

Referenced by injectionModelList::info().

Here is the caller graph for this function:

---

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

• src/regionFaModels/liquidFilm/subModels/kinematic/injectionModel/injectionModel/injectionModel.H
• src/regionFaModels/liquidFilm/subModels/kinematic/injectionModel/injectionModel/injectionModel.C
• src/regionFaModels/liquidFilm/subModels/kinematic/injectionModel/injectionModel/injectionModelNew.C