Remove and inject the mass in the film as it passes over the selected patches. More...

Inheritance diagram for patchInjection:

Collaboration diagram for patchInjection:

Public Member Functions
	patchInjection (const patchInjection &)=delete
	No copy construct. More...

void	operator= (const patchInjection &)=delete
	No copy assignment. More...

	TypeName ("patchInjection")
	Runtime type information. More...

	patchInjection (surfaceFilmRegionModel &film, const dictionary &dict)
	Construct from surface film model. More...

virtual	~patchInjection ()=default
	Destructor. More...

virtual void	correct (scalarField &availableMass, scalarField &massToInject, scalarField &diameterToInject)
	Correct. More...

virtual void	patchInjectedMassTotals (scalarField &patchMasses) const
	Accumulate the total mass injected for the patches into the. More...

Public Member Functions inherited from injectionModel
	TypeName ("injectionModel")
	Runtime type information. More...

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

	injectionModel (surfaceFilmRegionModel &film)
	Construct null. More...

	injectionModel (const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict)
	Construct from type name, dictionary and surface film model. More...

virtual	~injectionModel ()
	Destructor. More...

virtual scalar	injectedMassTotal () const
	Return the total mass injected. More...

Public Member Functions inherited from filmSubModelBase
	filmSubModelBase (surfaceFilmRegionModel &film)
	Construct null. More...

	filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from film film without name. More...

	filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from film film with name. More...

virtual	~filmSubModelBase ()
	Destructor. More...

virtual bool	writeTime () const
	Flag to indicate when to write a property. More...

const surfaceFilmRegionModel &	film () const
	Return const access to the film surface film model. More...

surfaceFilmRegionModel &	film ()
	Return the reference to the film surface film model. More...

template<class FilmType >
const FilmType &	filmType () const

Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null. More...

	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name. More...

	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name. More...

	subModelBase (const subModelBase &smb)
	Construct as copy. More...

virtual	~subModelBase ()=default
	Destructor. More...

const word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () const
	Return const access to the properties dictionary. More...

virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg. More...

virtual bool	active () const
	Return the model 'active' status - default active = true. More...

virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields. More...

virtual fileName	localPath () const
	Output directory. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the base model. More...

template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model. More...

template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model. More...

bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set. More...

template<class Type >
bool	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model. More...

template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the sub-model. More...

template<class Type >
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model. More...

virtual void	write (Ostream &os) const
	Write. More...

Protected Attributes
scalar	deltaStable_
	Stable film thickness - mass only removed if thickness exceeds. More...

labelList	patchIDs_
	List of patch IDs at which the film is removed. More...

scalarField	patchInjectedMasses_
	Injected mass for each patch at which the film is removed. More...

Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModel &	filmModel_
	Reference to the film surface film model. More...

Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	Reference to properties dictionary e.g. for restart. More...

const dictionary	dict_
	Copy of dictionary used during construction. More...

const word	baseName_
	Name of the sub-model base class. More...

const word	modelType_
	Type of the sub-model. More...

const dictionary	coeffDict_
	Coefficients dictionary. More...

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

Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info. More...

Protected Member Functions inherited from injectionModel
void	addToInjectedMass (const scalar dMass)
	Add to injected mass. More...

void	correct ()
	Correct. More...

Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line. More...

Detailed Description

Remove and inject the mass in the film as it passes over the selected patches.

Source files

Definition at line 51 of file patchInjection.H.

Constructor & Destructor Documentation

◆ patchInjection() [1/2]

patchInjection ( const patchInjection & )

delete

No copy construct.

◆ patchInjection() [2/2]

patchInjection	(	surfaceFilmRegionModel &	film,
		const dictionary &	dict
	)

Construct from surface film model.

Definition at line 42 of file patchInjection.C.

References polyMesh::boundaryMesh(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, polyMesh::globalData(), Foam::identity(), Foam::Info, Foam::nl, nPatches, patchNames(), pbm, globalMeshData::processorPatches(), regionModel::regionMesh(), UList< T >::size(), and Foam::Zero.

Here is the call graph for this function:

◆ ~patchInjection()

virtual ~patchInjection ( )

virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const patchInjection & )

delete

No copy assignment.

◆ TypeName()

TypeName ( "patchInjection" )

Runtime type information.

◆ correct()

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

virtual

Correct.

Implements injectionModel.

Definition at line 92 of file patchInjection.C.

References polyMesh::boundaryMesh(), injectionModel::correct(), delta, surfaceFilmRegionModel::delta(), forAll, Pstream::listCombineGather(), singleLayerRegion::magSf(), Foam::max(), pbm, pp(), regionModel::regionMesh(), rho, surfaceFilmRegionModel::rho(), and Foam::Zero.

Here is the call graph for this function:

◆ patchInjectedMassTotals()

void patchInjectedMassTotals ( scalarField & patchMasses ) const

virtual

Accumulate the total mass injected for the patches into the.

scalarField provided

Reimplemented from injectionModel.

Definition at line 156 of file patchInjection.C.

References forAll, Pstream::listCombineGather(), patchInjection::patchIDs_, patchInjection::patchInjectedMasses_, UList< T >::size(), and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ deltaStable_

scalar deltaStable_

protected

Stable film thickness - mass only removed if thickness exceeds.

this threshold value

Definition at line 62 of file patchInjection.H.

◆ patchIDs_

labelList patchIDs_

protected

List of patch IDs at which the film is removed.

Definition at line 67 of file patchInjection.H.

Referenced by patchInjection::patchInjectedMassTotals().

◆ patchInjectedMasses_

scalarField patchInjectedMasses_

protected

Injected mass for each patch at which the film is removed.

Definition at line 72 of file patchInjection.H.

Referenced by patchInjection::patchInjectedMassTotals().

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

src/regionModels/surfaceFilmModels/submodels/kinematic/injectionModel/patchInjection/patchInjection.H
src/regionModels/surfaceFilmModels/submodels/kinematic/injectionModel/patchInjection/patchInjection.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ patchInjection() [1/2]

◆ patchInjection() [2/2]

◆ ~patchInjection()

Member Function Documentation

◆ operator=()

◆ TypeName()

◆ correct()

◆ patchInjectedMassTotals()

Member Data Documentation

◆ deltaStable_

◆ patchIDs_

◆ patchInjectedMasses_