Public Member Functions | Protected Attributes | List of all members
patchInjection Class Reference
Inheritance diagram for patchInjection:
Inheritance graph
[legend]
Collaboration diagram for patchInjection:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("patchInjection")
 Runtime type information. More...
 
 patchInjection (surfaceFilmModel &owner, const dictionary &dict)
 Construct from surface film model. More...
 
virtual ~patchInjection ()
 Destructor. More...
 
virtual void correct (scalarField &availableMass, scalarField &massToInject, scalarField &diameterToInject)
 Correct. More...
 
virtual void patchInjectedMassTotals (scalarField &patchMasses) const
 Accumulate the total mass injected for the patches into the. 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...
 
- 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 Attributes

scalar deltaStable_
 Stable film thickness - mass only removed if thickness execeeds. More...
 
labelList patchIDs_
 List of patch IDs at which the film is removed. More...
 
scalarField patchInjectedMasses_
 Injected mass for each patch at which the film is removed. 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...
 
- 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...
 

Detailed Description

Definition at line 53 of file patchInjection.H.

Constructor & Destructor Documentation

patchInjection ( surfaceFilmModel owner,
const dictionary dict 
)
~patchInjection ( )
virtual

Destructor.

Definition at line 97 of file patchInjection.C.

References injectionModel::correct().

Here is the call graph for this function:

Member Function Documentation

TypeName ( "patchInjection"  )

Runtime type information.

void correct ( scalarField availableMass,
scalarField massToInject,
scalarField diameterToInject 
)
virtual
void patchInjectedMassTotals ( scalarField patchMasses) const
virtual

Accumulate the total mass injected for the patches into the.

scalarField provided

Reimplemented from injectionModel.

Definition at line 171 of file patchInjection.C.

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

Referenced by patchInjection::correct().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

scalar deltaStable_
protected

Stable film thickness - mass only removed if thickness execeeds.

this threhold value

Definition at line 70 of file patchInjection.H.

Referenced by patchInjection::correct().

labelList patchIDs_
protected

List of patch IDs at which the film is removed.

Definition at line 73 of file patchInjection.H.

Referenced by patchInjection::correct(), and patchInjection::patchInjectedMassTotals().

scalarField patchInjectedMasses_
protected

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

Definition at line 76 of file patchInjection.H.

Referenced by patchInjection::correct(), and patchInjection::patchInjectedMassTotals().


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