Inheritance diagram for curvatureSeparation:

Collaboration diagram for curvatureSeparation:

[legend]

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

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

virtual	~curvatureSeparation ()
	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,(surfaceFilmModel &owner, const dictionary &dict),(owner, dict))

	injectionModel (surfaceFilmModel &owner)
	Construct null. More...

	injectionModel (const word &modelType, surfaceFilmModel &owner, 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 (scalarField &patchMasses) const
	Accumulate the total mass injected for the patches into the. More...

Public Member Functions inherited from filmSubModelBase
	filmSubModelBase (surfaceFilmModel &owner)
	Construct null. More...

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

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

virtual	~filmSubModelBase ()
	Destructor. More...

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

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

surfaceFilmModel &	owner ()
	Return the reference to the owner 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 dependant 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...

Protected Member Functions
tmp< volScalarField >	calcInvR1 (const volVectorField &U) const
	Calculate local (inverse) radius of curvature. More...

tmp< scalarField >	calcCosAngle (const surfaceScalarField &phi) const
	Calculate the cosine of the angle between gravity vector and. 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
volTensorField	gradNHat_
	Gradient of surface normals. More...

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

List< Tuple2< label, scalar > >	definedPatchRadii_
	List of radii for patches - if patch not defined, radius. More...

scalar	magG_
	Magnitude of gravity vector. More...

vector	gHat_
	Direction of gravity vector. More...

Protected Attributes inherited from filmSubModelBase
surfaceFilmModel &	owner_
	Reference to the owner 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...

Private Member Functions
	curvatureSeparation (const curvatureSeparation &)
	Disallow default bitwise copy construct. More...

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

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

Detailed Description

Definition at line 66 of file curvatureSeparation.H.

Constructor & Destructor Documentation

◆ curvatureSeparation() [1/2]

curvatureSeparation ( const curvatureSeparation & )

private

Disallow default bitwise copy construct.

◆ curvatureSeparation() [2/2]

curvatureSeparation	(	surfaceFilmModel &	owner,
		const dictionary &	dict
	)

Construct from surface film model.

Definition at line 222 of file curvatureSeparation.C.

References DynamicList::append(), polyMesh::boundaryMesh(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::findStrings(), forAll, forAllReverse, HashTable::found(), surfaceFilmModel::g(), HashSet< Key, Hash >::insert(), polyBoundaryMesh::names(), regionModel::regionMesh(), List::size(), and dimensioned::value().

Here is the call graph for this function:

◆ ~curvatureSeparation()

~curvatureSeparation ( )

virtual

Destructor.

Definition at line 273 of file curvatureSeparation.C.

Member Function Documentation

◆ operator=()

void operator= ( const curvatureSeparation & )

private

Disallow default bitwise assignment.

◆ calcInvR1()

tmp< volScalarField > calcInvR1 ( const volVectorField & U ) const

protected

Calculate local (inverse) radius of curvature.

Definition at line 60 of file curvatureSeparation.C.

References Foam::dimVelocity, Foam::e, forAll, Foam::mag(), Foam::max(), mesh, and U.

Here is the call graph for this function:

◆ calcCosAngle()

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

protected

Calculate the cosine of the angle between gravity vector and.

cell out flow direction

Definition at line 114 of file curvatureSeparation.C.

References GeometricField::correctBoundaryConditions(), Foam::dimless, fvPatch::faceCells(), forAll, GeometricField::internalField(), Foam::max(), mesh, Foam::min(), fvPatch::nf(), IOobject::NO_READ, fvsPatchField::patch(), and phi.

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 280 of file curvatureSeparation.C.

References injectionModel::correct(), GeometricField::correctBoundaryConditions(), delta, kinematicSingleLayer::delta(), Foam::dimForce, Foam::e, forAll, GeometricField::internalField(), Foam::magSqr(), mesh, IOobject::NO_READ, phi, kinematicSingleLayer::phi(), regionModel::regionMesh(), rho, kinematicSingleLayer::rho(), Foam::constant::physicoChemical::sigma, kinematicSingleLayer::sigma(), Foam::sqr(), Foam::sum(), U, and kinematicSingleLayer::U().

Here is the call graph for this function:

Field Documentation

◆ gradNHat_

volTensorField gradNHat_

protected

Gradient of surface normals.

Definition at line 86 of file curvatureSeparation.H.

◆ deltaByR1Min_

scalar deltaByR1Min_

protected

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

Definition at line 89 of file curvatureSeparation.H.

◆ definedPatchRadii_

List<Tuple2<label, scalar> > definedPatchRadii_

protected

List of radii for patches - if patch not defined, radius.

calculated based on mesh geometry

Definition at line 93 of file curvatureSeparation.H.

◆ magG_

scalar magG_

protected

Magnitude of gravity vector.

Definition at line 96 of file curvatureSeparation.H.

◆ gHat_

vector gHat_

protected

Direction of gravity vector.

Definition at line 99 of file curvatureSeparation.H.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ curvatureSeparation() [1/2]

◆ curvatureSeparation() [2/2]

◆ ~curvatureSeparation()

Member Function Documentation

◆ operator=()

◆ calcInvR1()

◆ calcCosAngle()

◆ TypeName()

◆ correct()

Field Documentation

◆ gradNHat_

◆ deltaByR1Min_

◆ definedPatchRadii_

◆ magG_

◆ gHat_