Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
curvatureSeparation Class Reference
Inheritance diagram for curvatureSeparation:
Inheritance graph
[legend]
Collaboration diagram for curvatureSeparation:
Collaboration graph
[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 surfaceFilmModelowner () const
 Return const access to the owner surface film model. More...
 
surfaceFilmModelowner ()
 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 wordmodelName () const
 Return const access to the name of the sub-model. More...
 
const dictionarydict () const
 Return const access to the cloud dictionary. More...
 
const wordbaseName () const
 Return const access to the base name of the sub-model. More...
 
const wordmodelType () const
 Return const access to the sub-model type. More...
 
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionaryproperties () 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< volScalarFieldcalcInvR1 (const volVectorField &U) const
 Calculate local (inverse) radius of curvature. More...
 
tmp< scalarFieldcalcCosAngle (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
surfaceFilmModelowner_
 Reference to the owner surface film model. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 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< injectionModelNew (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 ( surfaceFilmModel owner,
const dictionary dict 
)
~curvatureSeparation ( )
virtual

Destructor.

Definition at line 280 of file curvatureSeparation.C.

References injectionModel::correct().

Here is the call graph for this function:

Member Function Documentation

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

Calculate local (inverse) radius of curvature.

Definition at line 60 of file curvatureSeparation.C.

References polyMesh::boundaryMesh(), curvatureSeparation::calcCosAngle(), Foam::dimVelocity, Foam::e, forAll, Foam::mag(), Foam::max(), mesh, TimeState::outputTime(), and fvMesh::time().

Referenced by curvatureSeparation::correct().

Here is the call graph for this function:

Here is the caller graph for this function:

tmp< scalarField > calcCosAngle ( const surfaceScalarField phi) const
protected
TypeName ( "curvatureSeparation"  )

Runtime type information.

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

Member Data Documentation

volTensorField gradNHat_
protected

Gradient of surface normals.

Definition at line 86 of file curvatureSeparation.H.

scalar deltaByR1Min_
protected

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

Definition at line 89 of file curvatureSeparation.H.

Referenced by curvatureSeparation::correct().

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.

scalar magG_
protected

Magnitude of gravity vector.

Definition at line 96 of file curvatureSeparation.H.

Referenced by curvatureSeparation::correct().

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: