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

#include <injectionModel.H>

Inheritance diagram for injectionModel:

[legend]

Collaboration diagram for injectionModel:

Public Member Functions
	TypeName ("injectionModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, injectionModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict))
	injectionModel (surfaceFilmRegionModel &film)
	Construct null.
	injectionModel (const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict)
	Construct from type name, dictionary and surface film model.
virtual	~injectionModel ()
	Destructor.
virtual void	correct (scalarField &availableMass, scalarField &massToInject, scalarField &diameterToInject)=0
	Correct.
virtual scalar	injectedMassTotal () const
	Return the total mass injected.
virtual void	patchInjectedMassTotals (scalarField &patchMasses) const
	Accumulate the total mass injected for the patches into the.
Public Member Functions inherited from filmSubModelBase
	filmSubModelBase (surfaceFilmRegionModel &film)
	Construct null.
	filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from film film without name.
	filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from film film with name.
virtual	~filmSubModelBase ()
	Destructor.
virtual bool	writeTime () const
	Flag to indicate when to write a property.
const surfaceFilmRegionModel &	film () const
	Return const access to the film surface film model.
surfaceFilmRegionModel &	film ()
	Return the reference to the film surface film model.
template<class FilmType>
const FilmType &	filmType () const
Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null.
	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name.
	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name.
	subModelBase (const subModelBase &smb)
	Construct as copy.
virtual	~subModelBase ()=default
	Destructor.
const word &	modelName () const
	Return const access to the name of the sub-model.
const dictionary &	dict () const
	Return const access to the cloud dictionary.
const word &	baseName () const
	Return const access to the base name of the sub-model.
const word &	modelType () const
	Return const access to the sub-model type.
const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary.
const dictionary &	properties () const
	Return const access to the properties dictionary.
virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg.
virtual bool	active () const
	Return the model 'active' status - default active = true.
virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields.
virtual fileName	localPath () const
	Output directory.
template<class Type>
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the base model.
template<class Type>
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model.
template<class Type>
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model.
bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set.
template<class Type>
bool	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model.
template<class Type>
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the sub-model.
template<class Type>
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model.
virtual void	write (Ostream &os) const
	Write.

Static Public Member Functions
static autoPtr< injectionModel >	New (surfaceFilmRegionModel &film, const dictionary &dict, const word &mdoelType)
	Return a reference to the selected injection model.

Protected Member Functions
void	addToInjectedMass (const scalar dMass)
	Add to injected mass.
void	correct ()
	Correct.
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line.

Additional Inherited Members
Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info.
Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModel &	filmModel_
	Reference to the film surface film model.
Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model.
dictionary &	properties_
	Reference to properties dictionary e.g. for restart.
const dictionary	dict_
	Copy of dictionary used during construction.
const word	baseName_
	Name of the sub-model base class.
const word	modelType_
	Type of the sub-model.
const dictionary	coeffDict_
	Coefficients dictionary.

Detailed Description

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

Source files

Definition at line 54 of file injectionModel.H.

Constructor & Destructor Documentation

◆ injectionModel() [1/2]

injectionModel ( surfaceFilmRegionModel & film )

Construct null.

Definition at line 47 of file injectionModel.C.

References filmSubModelBase::film(), and filmSubModelBase::filmSubModelBase().

Here is the call graph for this function:

◆ injectionModel() [2/2]

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

Construct from type name, dictionary and surface film model.

Definition at line 54 of file injectionModel.C.

References subModelBase::dict(), filmSubModelBase::film(), filmSubModelBase::filmSubModelBase(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, and subModelBase::modelType().

Here is the call graph for this function:

◆ ~injectionModel()

~injectionModel ( )

virtual

Destructor.

Definition at line 68 of file injectionModel.C.

Member Function Documentation

◆ addToInjectedMass()

void addToInjectedMass ( const scalar dMass )

protected

Add to injected mass.

Definition at line 39 of file injectionModel.C.

Referenced by BrunDrippingInjection::correct(), curvatureSeparation::correct(), drippingInjection::correct(), and patchInjection::correct().

Here is the caller graph for this function:

◆ correct() [1/2]

void correct ( )

protected

Correct.

Definition at line 74 of file injectionModel.C.

References subModelBase::getModelProperty(), Foam::returnReduce(), subModelBase::setModelProperty(), and filmSubModelBase::writeTime().

Referenced by BrunDrippingInjection::correct(), curvatureSeparation::correct(), drippingInjection::correct(), injectionModelList::correct(), and patchInjection::correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "injectionModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

References subModelBase::dict(), filmSubModelBase::film(), and subModelBase::modelType().

Here is the call graph for this function:

◆ New()

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

static

Return a reference to the selected injection model.

Definition at line 35 of file injectionModelNew.C.

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

Referenced by drippingInjection::drippingInjection(), and 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

Correct.

Implemented in BrunDrippingInjection, curvatureSeparation, drippingInjection, and patchInjection.

◆ injectedMassTotal()

scalar injectedMassTotal ( ) const

virtual

Return the total mass injected.

Definition at line 86 of file injectionModel.C.

References subModelBase::getModelProperty(), and 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 ( scalarField & patchMasses ) const

inlinevirtual

Accumulate the total mass injected for the patches into the.

scalarField provided

Reimplemented in patchInjection.

Definition at line 176 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/regionModels/surfaceFilmModels/submodels/kinematic/injectionModel/injectionModel/injectionModel.H
src/regionModels/surfaceFilmModels/submodels/kinematic/injectionModel/injectionModel/injectionModel.C
src/regionModels/surfaceFilmModels/submodels/kinematic/injectionModel/injectionModel/injectionModelNew.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ injectionModel() [1/2]

◆ injectionModel() [2/2]

◆ ~injectionModel()

Member Function Documentation

◆ addToInjectedMass()

◆ correct() [1/2]

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ correct() [2/2]

◆ injectedMassTotal()

◆ patchInjectedMassTotals()