NoSurfaceFilm< CloudType > Class Template Reference

Place holder for 'none' option. More...

Inheritance diagram for NoSurfaceFilm< CloudType >:
[legend]
Collaboration diagram for NoSurfaceFilm< CloudType >:
[legend]

Public Member Functions

 TypeName ("none")
 Runtime type information. More...
 
 NoSurfaceFilm (const dictionary &, CloudType &)
 Construct from dictionary. More...
 
 NoSurfaceFilm (const NoSurfaceFilm< CloudType > &dm)
 Construct copy. More...
 
virtual autoPtr< SurfaceFilmModel< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~NoSurfaceFilm ()
 Destructor. More...
 
virtual bool active () const
 Flag to indicate whether model activates the surface film model. More...
 
virtual bool transferParcel (parcelType &p, const polyPatch &pp, bool &keepParticle)
 Transfer parcel from cloud to surface film. More...
 
virtual void setParcelProperties (parcelType &p, const label filmCelli) const
 Set parcel properties. More...
 
virtual void info (Ostream &os)
 Write surface film info to stream. More...
 
- Public Member Functions inherited from SurfaceFilmModel< CloudType >
 TypeName ("surfaceFilmModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, SurfaceFilmModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table. More...
 
 SurfaceFilmModel (CloudType &owner)
 Construct null from owner. More...
 
 SurfaceFilmModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from components. More...
 
 SurfaceFilmModel (const SurfaceFilmModel< CloudType > &sfm)
 Construct copy. More...
 
virtual autoPtr< SurfaceFilmModel< CloudType > > clone () const =0
 Construct and return a clone. More...
 
virtual ~SurfaceFilmModel ()
 Destructor. More...
 
const dimensionedVectorg () const
 Return gravitational acceleration constant. More...
 
label nParcelsTransferred () const
 Return const access to the number of parcels transferred to the. More...
 
label & nParcelsTransferred ()
 Return non-const access to the number of parcels transferred to. More...
 
label nParcelsInjected () const
 Return const access to the number of parcels injected from the. More...
 
label & nParcelsInjected ()
 Return non-const access to the number of parcels injected from. More...
 
scalar & totalMassTransferred ()
 Return non-const total mass transferred. More...
 
scalar totalMassTransferred () const
 Return consr access to mass transferred. More...
 
virtual bool transferParcel (parcelType &p, const polyPatch &pp, bool &keepParticle)=0
 Transfer parcel from cloud to surface film. More...
 
template<class TrackCloudType >
void inject (TrackCloudType &cloud)
 Inject parcels into the cloud. More...
 
virtual void info (Ostream &os)
 Write surface film info to stream. More...
 
template<class CloudTrackType >
void injectParticles (const label primaryPatchi, const labelList &injectorCellsPatch, CloudTrackType &cloud)
 
- Public Member Functions inherited from CloudSubModelBase< CloudType >
 CloudSubModelBase (CloudType &owner)
 Construct null from owner cloud. More...
 
 CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from owner cloud without name. More...
 
 CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from owner cloud with name. More...
 
 CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
 Construct as copy. More...
 
virtual ~CloudSubModelBase ()
 Destructor. More...
 
const CloudTypeowner () const
 Return const access to the owner cloud. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. More...
 
CloudTypeowner ()
 Return non-const access to the owner cloud for manipulation. More...
 
virtual void write (Ostream &os) const
 Write. More...
 
- 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 dependent sub-model fields. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. 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 Types

typedef CloudType::parcelType parcelType
 Convenience typedef for parcel type. More...
 
- Protected Types inherited from SurfaceFilmModel< CloudType >
typedef CloudType::parcelType parcelType
 Convenience typedef to the cloud's parcel type. More...
 
typedef regionModels::areaSurfaceFilmModels::liquidFilmBase areaFilm
 

Additional Inherited Members

- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 
- Static Public Member Functions inherited from SurfaceFilmModel< CloudType >
static autoPtr< SurfaceFilmModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 
- Protected Member Functions inherited from SurfaceFilmModel< CloudType >
virtual void cacheFilmFields (const label filmPatchi, const label primaryPatchi, const regionModels::surfaceFilmModels::surfaceFilmRegionModel &)
 Cache the film fields in preparation for injection. More...
 
virtual void cacheFilmFields (const label primaryPatchi, const areaFilm &)
 Cache the finite area film fields in preparation for injection. More...
 
template<class TrackCloudType >
void injectParticles (const label primaryPatchi, const labelList &injectorCellsPatch, TrackCloudType &cloud)
 Inject particles in cloud. More...
 
virtual void setParcelProperties (parcelType &p, const label filmFacei) const
 Set the individual parcel properties. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 
- Protected Attributes inherited from SurfaceFilmModel< CloudType >
const dimensionedVectorg_
 Gravitational acceleration constant. More...
 
label ejectedParcelType_
 Ejected parcel type label - id assigned to identify parcel for. More...
 
scalar injectionOffset_
 Injection offset position. More...
 
scalar minDiameter_
 Minimum diameter particle injection. More...
 
scalarField massParcelPatch_
 Parcel mass / patch face. More...
 
scalarField diameterParcelPatch_
 Parcel diameter / patch face. More...
 
Field< vectorUFilmPatch_
 Film velocity / patch face. More...
 
scalarField rhoFilmPatch_
 Film density / patch face. More...
 
Field< scalarFielddeltaFilmPatch_
 Film height of all film patches / patch face. More...
 
label nParcelsTransferred_
 Number of parcels transferred to the film model. More...
 
label nParcelsInjected_
 Number of parcels injected from the film model. More...
 
scalar totalMassTransferred_
 Total mass transferred to the film. More...
 
- Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudTypeowner_
 Reference to the cloud. 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...
 

Detailed Description

template<class CloudType>
class Foam::NoSurfaceFilm< CloudType >

Place holder for 'none' option.

Source files

Definition at line 54 of file NoSurfaceFilm.H.

Member Typedef Documentation

◆ parcelType

typedef CloudType::parcelType parcelType
protected

Convenience typedef for parcel type.

Definition at line 63 of file NoSurfaceFilm.H.

Constructor & Destructor Documentation

◆ NoSurfaceFilm() [1/2]

NoSurfaceFilm ( const dictionary ,
CloudType owner 
)

Construct from dictionary.

Definition at line 34 of file NoSurfaceFilm.C.

◆ NoSurfaceFilm() [2/2]

Construct copy.

Definition at line 45 of file NoSurfaceFilm.C.

◆ ~NoSurfaceFilm()

~NoSurfaceFilm
virtual

Destructor.

Definition at line 57 of file NoSurfaceFilm.C.

Member Function Documentation

◆ TypeName()

TypeName ( "none"  )

Runtime type information.

◆ clone()

virtual autoPtr< SurfaceFilmModel< CloudType > > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements SurfaceFilmModel< CloudType >.

Definition at line 81 of file NoSurfaceFilm.H.

◆ active()

bool active
virtual

Flag to indicate whether model activates the surface film model.

Reimplemented from subModelBase.

Definition at line 64 of file NoSurfaceFilm.C.

◆ transferParcel()

bool transferParcel ( parcelType p,
const polyPatch pp,
bool keepParticle 
)
virtual

Transfer parcel from cloud to surface film.

Returns true if parcel is to be transferred

Implements SurfaceFilmModel< CloudType >.

Definition at line 71 of file NoSurfaceFilm.C.

◆ setParcelProperties()

void setParcelProperties ( parcelType p,
const label  filmCelli 
) const
virtual

Set parcel properties.

Reimplemented from SurfaceFilmModel< CloudType >.

Definition at line 83 of file NoSurfaceFilm.C.

◆ info()

void info ( Ostream os)
virtual

Write surface film info to stream.

Reimplemented from SurfaceFilmModel< CloudType >.

Definition at line 92 of file NoSurfaceFilm.C.


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