Inheritance diagram for removeInjection:
Collaboration diagram for removeInjection:

Public Member Functions

 TypeName ("removeInjection")
 Runtime type information. More...
 
 removeInjection (surfaceFilmModel &owner, const dictionary &dict)
 Construct from surface film model. More...
 
virtual ~removeInjection ()
 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...
 
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 >
Type getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
void getModelProperty (const word &entryName, Type &value) 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...
 
scalarField mask_
 Mask per cell to indicate whether mass can be 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 removeInjection.H.

Constructor & Destructor Documentation

removeInjection ( surfaceFilmModel owner,
const dictionary dict 
)

Construct from surface film model.

Definition at line 46 of file removeInjection.C.

References polyMesh::boundaryMesh(), Foam::endl(), polyPatch::faceCells(), forAllConstIter, Foam::Info, patchIdentifier::name(), Foam::nl, patches, polyBoundaryMesh::patchSet(), and regionModel::regionMesh().

Here is the call graph for this function:

~removeInjection ( )
virtual

Destructor.

Definition at line 81 of file removeInjection.C.

Member Function Documentation

TypeName ( "removeInjection"  )

Runtime type information.

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

Correct.

Implements injectionModel.

Definition at line 88 of file removeInjection.C.

References injectionModel::correct(), delta, surfaceFilmModel::delta(), forAll, singleLayerRegion::magSf(), Foam::max(), rho, and surfaceFilmModel::rho().

Here is the call 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 72 of file removeInjection.H.

scalarField mask_
protected

Mask per cell to indicate whether mass can be removed.

Definition at line 75 of file removeInjection.H.


The documentation for this class was generated from the following files:
  • src/regionModels/surfaceFilmModels/submodels/kinematic/injectionModel/removeInjection/removeInjection.H
  • src/regionModels/surfaceFilmModels/submodels/kinematic/injectionModel/removeInjection/removeInjection.C