Transfer mass between the film and the VoF in the continuous phase. More...

Inheritance diagram for VoFPatchTransfer:

Collaboration diagram for VoFPatchTransfer:

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

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

virtual	~VoFPatchTransfer ()
	Destructor. More...

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

virtual void	correct (scalarField &availableMass, scalarField &massToTransfer, scalarField &energyToTransfer)
	Correct kinematic and thermodynamic transfers. More...

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

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

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

	transferModel (surfaceFilmRegionModel &film)
	Construct for film. More...

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

virtual	~transferModel ()
	Destructor. More...

virtual void	correct (scalarField &availableMass, scalarField &massToTransfer)=0
	Correct kinematic transfers. More...

virtual void	correct (scalarField &availableMass, scalarField &massToTransfer, scalarField &energyToTransfer)
	Correct kinematic and thermodynamic transfers. More...

virtual scalar	transferredMassTotal () const
	Return the total mass transferred. More...

virtual void	patchTransferredMassTotals (scalarField &patchMasses) const
	Accumulate the total mass transferred for the patches into the. 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 ()
	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 bool	writeTime () const
	Flag to indicate when to write a property. 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	deltaFactorToVoF_
	Factor of the cell height above which the film is transferred. More...

scalar	deltaFactorToFilm_
	Factor of the cell height below which the VoF may be transferred. More...

scalar	alphaToVoF_
	VoF limit above which all of the film is transferred to the VoF. More...

scalar	alphaToFilm_
	VoF limit below which the VoF may be transferred to the film. More...

scalar	transferRateCoeff_
	Transfer rate coefficient. More...

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

scalarField	patchTransferredMasses_
	Transferred 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 transferModel
static autoPtr< transferModel >	New (surfaceFilmRegionModel &film, const dictionary &dict, const word &modelType)
	Return a reference to the selected injection model. More...

Protected Member Functions inherited from transferModel
void	addToTransferredMass (const scalar dMass)
	Add to transferred 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

Transfer mass between the film and the VoF in the continuous phase.

Source files

Definition at line 54 of file VoFPatchTransfer.H.

Constructor & Destructor Documentation

◆ VoFPatchTransfer()

VoFPatchTransfer	(	surfaceFilmRegionModel &	film,
		const dictionary &	dict
	)

Construct from surface film model.

◆ ~VoFPatchTransfer()

virtual ~VoFPatchTransfer ( )

virtual

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "VoFPatchTransfer" )

Runtime type information.

◆ correct() [1/2]

virtual void correct	(	scalarField &	availableMass,
		scalarField &	massToTransfer
	)

virtual

Correct.

Implements transferModel.

◆ correct() [2/2]

virtual void correct	(	scalarField &	availableMass,
		scalarField &	massToTransfer,
		scalarField &	energyToTransfer
	)

virtual

Correct kinematic and thermodynamic transfers.

Reimplemented from transferModel.

◆ patchTransferredMassTotals()

virtual void patchTransferredMassTotals ( scalarField & patchMasses ) const

virtual

Accumulate the total mass injected for the patches into the.

scalarField provided

Reimplemented from transferModel.

Member Data Documentation

◆ deltaFactorToVoF_

scalar deltaFactorToVoF_

protected

Factor of the cell height above which the film is transferred.

to the VoF

Definition at line 71 of file VoFPatchTransfer.H.

◆ deltaFactorToFilm_

scalar deltaFactorToFilm_

protected

Factor of the cell height below which the VoF may be transferred.

to the film

Definition at line 75 of file VoFPatchTransfer.H.

◆ alphaToVoF_

scalar alphaToVoF_

protected

VoF limit above which all of the film is transferred to the VoF.

Definition at line 78 of file VoFPatchTransfer.H.

◆ alphaToFilm_

scalar alphaToFilm_

protected

VoF limit below which the VoF may be transferred to the film.

Definition at line 81 of file VoFPatchTransfer.H.

◆ transferRateCoeff_

scalar transferRateCoeff_

protected

Transfer rate coefficient.

Definition at line 84 of file VoFPatchTransfer.H.

◆ patchIDs_

labelList patchIDs_

protected

List of patch IDs at which the film is removed.

Definition at line 87 of file VoFPatchTransfer.H.

◆ patchTransferredMasses_

scalarField patchTransferredMasses_

protected

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

Definition at line 90 of file VoFPatchTransfer.H.

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

applications/solvers/multiphase/compressibleInterFoam/compressibleInterFilmFoam/VoFPatchTransfer/VoFPatchTransfer.H

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VoFPatchTransfer()

◆ ~VoFPatchTransfer()

Member Function Documentation

◆ TypeName()

◆ correct() [1/2]

◆ correct() [2/2]

◆ patchTransferredMassTotals()

Member Data Documentation

◆ deltaFactorToVoF_

◆ deltaFactorToFilm_

◆ alphaToVoF_

◆ alphaToFilm_

◆ transferRateCoeff_

◆ patchIDs_

◆ patchTransferredMasses_