Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
SurfaceFilmModel< CloudType > Class Template Referenceabstract

Templated wall surface film model class. More...

Inheritance diagram for SurfaceFilmModel< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for SurfaceFilmModel< CloudType >:
Collaboration graph
[legend]

Public Member Functions

 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...
 
labelnParcelsTransferred ()
 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...
 
labelnParcelsInjected ()
 Return non-const access to the number of parcels injected from. More...
 
virtual bool transferParcel (parcelType &p, const polyPatch &pp, bool &keepParticle)=0
 Transfer parcel from cloud to surface film. More...
 
template<class TrackData >
void inject (TrackData &td)
 Inject parcels into the cloud. More...
 
virtual void info (Ostream &os)
 Write surface film info to stream. More...
 
- 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 outputTime () const
 Flag to indicate when to write a property. 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 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...
 

Static Public Member Functions

static autoPtr< SurfaceFilmModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 

Protected Types

typedef CloudType::parcelType parcelType
 Convenience typedef to the cloud's parcel type. More...
 

Protected Member Functions

virtual void cacheFilmFields (const label filmPatchI, const label primaryPatchI, const regionModels::surfaceFilmModels::surfaceFilmModel &filmModel)
 Cache the film fields in preparation for injection. 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

const dimensionedVectorg_
 Gravitational acceleration constant. More...
 
label ejectedParcelType_
 Ejected parcel type label - id assigned to identify parcel for. More...
 
scalarList massParcelPatch_
 Parcel mass / patch face. More...
 
scalarList diameterParcelPatch_
 Parcel diameter / patch face. More...
 
List< vectorUFilmPatch_
 Film velocity / patch face. More...
 
scalarList rhoFilmPatch_
 Film density / patch face. More...
 
scalarListList deltaFilmPatch_
 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...
 
- 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...
 

Additional Inherited Members

- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 

Detailed Description

template<class CloudType>
class Foam::SurfaceFilmModel< CloudType >

Templated wall surface film model class.

Source files

Definition at line 85 of file KinematicCloud.H.

Member Typedef Documentation

typedef CloudType::parcelType parcelType
protected

Convenience typedef to the cloud's parcel type.

Definition at line 71 of file SurfaceFilmModel.H.

Constructor & Destructor Documentation

Construct null from owner.

Definition at line 35 of file SurfaceFilmModel.C.

Referenced by SurfaceFilmModel< CloudType >::SurfaceFilmModel().

Here is the caller graph for this function:

SurfaceFilmModel ( const dictionary dict,
CloudType owner,
const word type 
)

Construct from components.

Definition at line 52 of file SurfaceFilmModel.C.

References SurfaceFilmModel< CloudType >::SurfaceFilmModel().

Here is the call graph for this function:

Construct copy.

Definition at line 76 of file SurfaceFilmModel.C.

~SurfaceFilmModel ( )
virtual

Destructor.

Definition at line 96 of file SurfaceFilmModel.C.

Member Function Documentation

void cacheFilmFields ( const label  filmPatchI,
const label  primaryPatchI,
const regionModels::surfaceFilmModels::surfaceFilmModel filmModel 
)
protectedvirtual
void setParcelProperties ( parcelType p,
const label  filmFaceI 
) const
protectedvirtual
TypeName ( "surfaceFilmModel"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
SurfaceFilmModel< CloudType ,
dictionary  ,
( const dictionary &dict, CloudType &owner ,
(dict, owner  
)

Declare runtime constructor selection table.

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

Construct and return a clone.

Implemented in ThermoSurfaceFilm< CloudType >, and NoSurfaceFilm< CloudType >.

Foam::autoPtr< Foam::SurfaceFilmModel< CloudType > > New ( const dictionary dict,
CloudType owner 
)
static

Selector.

Definition at line 33 of file SurfaceFilmModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), and Foam::nl.

Here is the call graph for this function:

const Foam::dimensionedVector & g ( ) const
inline

Return gravitational acceleration constant.

Definition at line 31 of file SurfaceFilmModelI.H.

Foam::label nParcelsTransferred ( ) const
inline

Return const access to the number of parcels transferred to the.

film model

Definition at line 45 of file SurfaceFilmModelI.H.

Foam::label & nParcelsTransferred ( )
inline

Return non-const access to the number of parcels transferred to.

the film model

Definition at line 38 of file SurfaceFilmModelI.H.

Foam::label nParcelsInjected ( ) const
inline

Return const access to the number of parcels injected from the.

film model

Definition at line 59 of file SurfaceFilmModelI.H.

Foam::label & nParcelsInjected ( )
inline

Return non-const access to the number of parcels injected from.

the film model

Definition at line 52 of file SurfaceFilmModelI.H.

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

Transfer parcel from cloud to surface film.

Returns true if parcel is to be transferred

Implemented in ThermoSurfaceFilm< CloudType >, and NoSurfaceFilm< CloudType >.

void inject ( TrackData &  td)
void info ( Ostream os)
virtual

Write surface film info to stream.

Reimplemented in ThermoSurfaceFilm< CloudType >, and NoSurfaceFilm< CloudType >.

Definition at line 255 of file SurfaceFilmModel.C.

References Foam::endl(), Foam::nl, SurfaceFilmModel< CloudType >::nParcelsInjected_, SurfaceFilmModel< CloudType >::nParcelsTransferred_, CloudSubModelBase< CloudType >::outputTime(), Foam::returnReduce(), and subModelBase::setModelProperty().

Referenced by ThermoSurfaceFilm< CloudType >::info().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

const dimensionedVector& g_
protected

Gravitational acceleration constant.

Definition at line 74 of file SurfaceFilmModel.H.

label ejectedParcelType_
protected

Ejected parcel type label - id assigned to identify parcel for.

post-processing. If not specified, defaults to originating cloud type

Definition at line 79 of file SurfaceFilmModel.H.

Referenced by SurfaceFilmModel< CloudType >::setParcelProperties().

scalarList massParcelPatch_
protected
scalarList diameterParcelPatch_
protected
List<vector> UFilmPatch_
protected

Film velocity / patch face.

Definition at line 91 of file SurfaceFilmModel.H.

Referenced by SurfaceFilmModel< CloudType >::cacheFilmFields(), and SurfaceFilmModel< CloudType >::setParcelProperties().

scalarList rhoFilmPatch_
protected

Film density / patch face.

Definition at line 94 of file SurfaceFilmModel.H.

Referenced by SurfaceFilmModel< CloudType >::cacheFilmFields(), and SurfaceFilmModel< CloudType >::setParcelProperties().

scalarListList deltaFilmPatch_
protected

Film height of all film patches / patch face.

Definition at line 97 of file SurfaceFilmModel.H.

Referenced by SurfaceFilmModel< CloudType >::cacheFilmFields(), and SurfaceFilmModel< CloudType >::inject().

label nParcelsTransferred_
protected

Number of parcels transferred to the film model.

Definition at line 103 of file SurfaceFilmModel.H.

Referenced by SurfaceFilmModel< CloudType >::info().

label nParcelsInjected_
protected

Number of parcels injected from the film model.

Definition at line 106 of file SurfaceFilmModel.H.

Referenced by SurfaceFilmModel< CloudType >::info(), and SurfaceFilmModel< CloudType >::inject().


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