Curvature film separation model. More...

Inheritance diagram for curvatureSeparation:

Collaboration diagram for curvatureSeparation:

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

	curvatureSeparation (liquidFilmBase &film, const dictionary &dict)
	Construct from surface film model. More...

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

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

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

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

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

	injectionModel (const word &modelType, liquidFilmBase &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...

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

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

	filmSubModelBase (liquidFilmBase &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, liquidFilmBase &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 liquidFilmBase &	film () const
	Return const access to the film surface film model. More...

liquidFilmBase &	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 Member Functions
tmp< areaScalarField >	calcInvR1 (const areaVectorField &U, const scalarField &calcCosAngle) const
	Calculate local (inverse) radius of curvature. More...

tmp< scalarField >	calcCosAngle (const edgeScalarField &phi) const
	Calculate the cosine of the angle between gravity vector and cell out flow direction. 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...

Protected Attributes
areaTensorField	gradNHat_
	Gradient of surface normals. More...

scalar	deltaByR1Min_
	Minimum gravity driven film thickness (non-dimensionalised delta/R1) More...

scalar	definedPatchRadii_
	Patch radius. More...

scalar	magG_
	Magnitude of gravity vector. More...

vector	gHat_
	Direction of gravity vector. More...

scalar	fThreshold_
	Threshold force for separation. More...

scalar	minInvR1_
	Minimum inv R1 for separation. More...

Protected Attributes inherited from filmSubModelBase
liquidFilmBase &	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 (liquidFilmBase &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...

Detailed Description

Curvature film separation model.

Assesses film curvature via the mesh geometry and calculates a force balance of the form:

F_sum = F_inertial + F_body + F_surface

If F_sum < 0, the film separates. Similarly, if F_sum > 0 the film will remain attached.

Reference:

    Owen, I., & Ryley, D. J. (1985).
    The flow of thin liquid films around corners.
    International journal of multiphase flow, 11(1), 51-62.

Usage

Example of the model specification:

injectionModels
(
    curvatureSeparation
);

curvatureSeparationCoeffs
{
    // Optional entries
    deltaByR1Min        <scalar>;
    definedPatchRadii   <scalar>;
    fThreshold          <scalar>;
    minInvR1            <scalar>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`deltaByR1Min`	Minimum gravity driven film thickness	scalar	no	0
`definedPatchRadii`	Patch radius i	scalar	no	0
`fThreshold`	Threshold force for separation	scalar	no	1e-8
`minInvR1`	Minimum inv R1 for separation	scalar	no	5

The inherited entries are elaborated in:

injectionModel.H

Source files

Definition at line 129 of file curvatureSeparation.H.

Constructor & Destructor Documentation

◆ curvatureSeparation()

curvatureSeparation	(	liquidFilmBase &	film,
		const dictionary &	dict
	)

Construct from surface film model.

Definition at line 146 of file curvatureSeparation.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, liquidFilmBase::g(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ ~curvatureSeparation()

virtual ~curvatureSeparation ( )

virtualdefault

Destructor.

Member Function Documentation

◆ calcInvR1()

tmp< areaScalarField > calcInvR1	(	const areaVectorField &	U,
		const scalarField &	calcCosAngle
	)		const

protected

Calculate local (inverse) radius of curvature.

Definition at line 47 of file curvatureSeparation.C.

References Foam::dimVelocity, Foam::constant::electromagnetic::e, forAll, Foam::mag(), Foam::max(), GeometricField< scalar, faPatchField, areaMesh >::New(), IOobjectOption::NO_REGISTER, and U.

Here is the call graph for this function:

◆ calcCosAngle()

tmp< scalarField > calcCosAngle ( const edgeScalarField & phi ) const

protected

Calculate the cosine of the angle between gravity vector and cell out flow direction.

Definition at line 87 of file curvatureSeparation.C.

References Foam::clamp(), Foam::ensightOutput::debug, Foam::dimless, Foam::dimVelocity, forAll, Foam::mag(), mesh, phi, Foam::pos(), GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), UList< T >::size(), U, and Foam::Zero.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "curvatureSeparation" )

Runtime type information.

◆ correct()

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

virtual

Correct.

Implements injectionModel.

Definition at line 183 of file curvatureSeparation.C.

References injectionModel::correct(), Foam::ensightOutput::debug, delta, Foam::dimForce, Foam::dimLength, Foam::dimMass, forAll, liquidFilmBase::h(), Foam::inv(), Foam::magSqr(), mesh, phi, liquidFilmBase::phi2s(), GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), regionFaModel::regionMesh(), rho, liquidFilmBase::rho(), sigma(), liquidFilmBase::sigma(), Foam::sqr(), Foam::sum(), U, Uf, liquidFilmBase::Uf(), and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ gradNHat_

areaTensorField gradNHat_

protected

Gradient of surface normals.

Definition at line 153 of file curvatureSeparation.H.

◆ deltaByR1Min_

scalar deltaByR1Min_

protected

Minimum gravity driven film thickness (non-dimensionalised delta/R1)

Definition at line 158 of file curvatureSeparation.H.

◆ definedPatchRadii_

scalar definedPatchRadii_

protected

Patch radius.

Definition at line 163 of file curvatureSeparation.H.

◆ magG_

scalar magG_

protected

Magnitude of gravity vector.

Definition at line 168 of file curvatureSeparation.H.

◆ gHat_

vector gHat_

protected

Direction of gravity vector.

Definition at line 173 of file curvatureSeparation.H.

◆ fThreshold_

scalar fThreshold_

protected

Threshold force for separation.

Definition at line 178 of file curvatureSeparation.H.

◆ minInvR1_

scalar minInvR1_

protected

Minimum inv R1 for separation.

Definition at line 183 of file curvatureSeparation.H.

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

src/regionFaModels/liquidFilm/subModels/kinematic/injectionModel/curvatureSeparation/curvatureSeparation.H
src/regionFaModels/liquidFilm/subModels/kinematic/injectionModel/curvatureSeparation/curvatureSeparation.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ curvatureSeparation()

◆ ~curvatureSeparation()

Member Function Documentation

◆ calcInvR1()

◆ calcCosAngle()

◆ TypeName()

◆ correct()

Member Data Documentation

◆ gradNHat_

◆ deltaByR1Min_

◆ definedPatchRadii_

◆ magG_

◆ gHat_

◆ fThreshold_

◆ minInvR1_