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

Inheritance diagram for patchEjection:

Collaboration diagram for patchEjection:

Public Member Functions
	TypeName ("patchEjection")
	Runtime type information. More...

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

	patchEjection (const patchEjection &)=delete
	Disallow default bitwise copy construction. More...

virtual	~patchEjection ()
	Destructor. More...

virtual void	correct (scalarField &availableMass, scalarField &massToEject, scalarField &diameterToEject)
	Correct. More...

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

void	operator= (const patchEjection &)=delete
	Disallow default bitwise assignment. More...

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

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

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

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

	ejectionModel (const ejectionModel &)=delete
	Disallow default bitwise copy construction. More...

virtual	~ejectionModel ()
	Destructor. More...

virtual scalar	ejectedMassTotal () const
	Return the total mass ejected. More...

void	operator= (const ejectionModel &)=delete
	Disallow default bitwise assignment. 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)
	Copy constructor. More...

virtual	~subModelBase ()
	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 void	cacheFields (const bool store)
	Cache dependent sub-model fields. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< 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...

template<class Type >
void	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=pTraits< 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...

void	operator= (const subModelBase &)=delete
	Disallow default bitwise assignment. 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	patchEjectedMasses_
	Ejected 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 ejectionModel
static autoPtr< ejectionModel >	New (surfaceFilmRegionModel &film, const dictionary &dict, const word &mdoelType)
	Return a reference to the selected ejection model. More...

Protected Member Functions inherited from ejectionModel
void	addToEjectedMass (const scalar dMass)
	Add to ejected 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 eject the mass in the film as it passes over the selected patches.

Source files

Definition at line 53 of file patchEjection.H.

Constructor & Destructor Documentation

◆ patchEjection() [1/2]

patchEjection	(	surfaceFilmRegionModel &	film,
		const dictionary &	dict
	)

Construct from surface film model.

Definition at line 46 of file patchEjection.C.

References polyMesh::boundaryMesh(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, forAllConstIter, polyMesh::globalData(), Foam::Info, IOobject::name(), Foam::nl, patchi, patchNames(), polyBoundaryMesh::patchSet(), globalMeshData::processorPatches(), regionModel::regionMesh(), PtrList< T >::setSize(), UPtrList< T >::size(), and List< T >::size().

Here is the call graph for this function:

◆ patchEjection() [2/2]

patchEjection ( const patchEjection & )

delete

Disallow default bitwise copy construction.

◆ ~patchEjection()

~patchEjection ( )

virtual

Destructor.

Definition at line 100 of file patchEjection.C.

References ejectionModel::correct().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "patchEjection" )

Runtime type information.

◆ correct()

void correct	(	scalarField &	availableMass,
		scalarField &	massToEject,
		scalarField &	diameterToEject
	)

virtual

Correct.

Implements ejectionModel.

Definition at line 107 of file patchEjection.C.

References ejectionModel::addToEjectedMass(), polyMesh::boundaryMesh(), ejectionModel::correct(), delta, surfaceFilmRegionModel::delta(), patchEjection::deltaStable_, polyPatch::faceCells(), filmSubModelBase::film(), forAll, Pstream::listCombineGather(), singleLayerRegion::magSf(), Foam::max(), patchEjection::patchEjectedMasses_, patchEjection::patchEjectedMassTotals(), patchi, patchEjection::patchIDs_, regionModel::regionMesh(), rho, surfaceFilmRegionModel::rho(), List< T >::size(), and filmSubModelBase::writeTime().

Here is the call graph for this function:

◆ patchEjectedMassTotals()

void patchEjectedMassTotals ( scalarField & patchMasses ) const

virtual

Accumulate the total mass ejected for the patches into the.

scalarField provided

Reimplemented from ejectionModel.

Definition at line 174 of file patchEjection.C.

References forAll, Pstream::listCombineGather(), patchEjection::patchEjectedMasses_, patchi, patchEjection::patchIDs_, and List< T >::size().

Referenced by patchEjection::correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const patchEjection & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ deltaStable_

scalar deltaStable_

protected

Stable film thickness - mass only removed if thickness exceeds.

this threshold value

Definition at line 61 of file patchEjection.H.

Referenced by patchEjection::correct().

◆ patchIDs_

labelList patchIDs_

protected

List of patch IDs at which the film is removed.

Definition at line 64 of file patchEjection.H.

Referenced by patchEjection::correct(), and patchEjection::patchEjectedMassTotals().

◆ patchEjectedMasses_

scalarField patchEjectedMasses_

protected

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

Definition at line 67 of file patchEjection.H.

Referenced by patchEjection::correct(), and patchEjection::patchEjectedMassTotals().

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

src/regionModels/surfaceFilmModels/submodels/kinematic/ejectionModel/patchEjection/patchEjection.H
src/regionModels/surfaceFilmModels/submodels/kinematic/ejectionModel/patchEjection/patchEjection.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ patchEjection() [1/2]

◆ patchEjection() [2/2]

◆ ~patchEjection()

Member Function Documentation

◆ TypeName()

◆ correct()

◆ patchEjectedMassTotals()

◆ operator=()

Member Data Documentation

◆ deltaStable_

◆ patchIDs_

◆ patchEjectedMasses_