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

Thermo parcel surface film model. More...

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

Public Types

enum  interactionType { itAbsorb, itBounce, itSplashBai }
 
- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 

Public Member Functions

interactionType interactionTypeEnum (const word &it) const
 
word interactionTypeStr (const interactionType &it) const
 
 TypeName ("thermoSurfaceFilm")
 Runtime type information. More...
 
 ThermoSurfaceFilm (const dictionary &dict, CloudType &owner)
 Construct from components. More...
 
 ThermoSurfaceFilm (const ThermoSurfaceFilm< CloudType > &sfm)
 Construct copy. More...
 
virtual autoPtr< SurfaceFilmModel< CloudType > > clone () const
 Construct and return a clone using supplied owner cloud. More...
 
virtual ~ThermoSurfaceFilm ()
 Destructor. More...
 
virtual bool transferParcel (parcelType &p, const polyPatch &pp, bool &keepParticle)
 Transfer parcel from cloud to surface film. 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 ~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...
 
template<class TrackData >
void inject (TrackData &td)
 Inject parcels into the cloud. 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 Attributes

static wordList interactionTypeNames_
 Word descriptions of interaction type names. More...
 

Protected Types

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

Protected Member Functions

vector tangentVector (const vector &v) const
 Return a vector tangential to input vector, v. More...
 
vector splashDirection (const vector &tanVec1, const vector &tanVec2, const vector &nf) const
 Return splashed parcel direction. More...
 
void absorbInteraction (regionModels::surfaceFilmModels::surfaceFilmModel &filmModel, const parcelType &p, const polyPatch &pp, const label faceI, const scalar mass, bool &keepParticle)
 Absorb parcel into film. More...
 
void bounceInteraction (parcelType &p, const polyPatch &pp, const label faceI, bool &keepParticle) const
 Bounce parcel (flip parcel normal velocity) More...
 
void drySplashInteraction (regionModels::surfaceFilmModels::surfaceFilmModel &filmModel, const parcelType &p, const polyPatch &pp, const label faceI, bool &keepParticle)
 Parcel interaction with dry surface. More...
 
void wetSplashInteraction (regionModels::surfaceFilmModels::surfaceFilmModel &filmModel, parcelType &p, const polyPatch &pp, const label faceI, bool &keepParticle)
 Parcel interaction with wetted surface. More...
 
void splashInteraction (regionModels::surfaceFilmModels::surfaceFilmModel &filmModel, const parcelType &p, const polyPatch &pp, const label faceI, const scalar mRatio, const scalar We, const scalar Wec, const scalar sigma, bool &keepParticle)
 Bai parcel splash interaction model. More...
 
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

cachedRandomrndGen_
 Reference to the cloud random number generator. More...
 
const SLGThermothermo_
 Reference to the cloud thermo package. More...
 
scalarList TFilmPatch_
 Film temperature / patch face. More...
 
scalarList CpFilmPatch_
 Film specific heat capacity / patch face. More...
 
interactionType interactionType_
 Interaction type enumeration. More...
 
scalar deltaWet_
 Film thickness beyond which patch is assumed to be wet. More...
 
label splashParcelType_
 Splash parcel type label - id assigned to identify parcel for. More...
 
label parcelsPerSplash_
 Number of new parcels resulting from splash event. More...
 
scalar Adry_
 Dry surface roughness coefficient. More...
 
scalar Awet_
 Wet surface roughness coefficient. More...
 
scalar Cf_
 Skin friction typically in the range 0.6 < Cf < 0.8. More...
 
label nParcelsSplashed_
 Counter for number of new splash parcels. 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...
 
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

- Static Public Member Functions inherited from SurfaceFilmModel< CloudType >
static autoPtr< SurfaceFilmModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 

Detailed Description

template<class CloudType>
class Foam::ThermoSurfaceFilm< CloudType >

Thermo parcel surface film model.

Responsible for:

Splash model references:

Bai and Gosman, `Mathematical modelling of wall films formed by impinging sprays', SAE 960626, 1996

Bai et al, `Modelling off gasoline spray impingement', Atom. Sprays, vol 12, pp 1-27, 2002

Source files

Definition at line 63 of file ThermoSurfaceFilm.H.

Member Typedef Documentation

typedef CloudType::parcelType parcelType
protected

Convenience typedef to the cloud's parcel type.

Definition at line 97 of file ThermoSurfaceFilm.H.

Member Enumeration Documentation

Enumerator
itAbsorb 
itBounce 
itSplashBai 

Definition at line 72 of file ThermoSurfaceFilm.H.

Constructor & Destructor Documentation

ThermoSurfaceFilm ( const dictionary dict,
CloudType owner 
)

Construct from components.

Definition at line 490 of file ThermoSurfaceFilm.C.

References Foam::endl(), and Foam::Info.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Construct copy.

Definition at line 534 of file ThermoSurfaceFilm.C.

~ThermoSurfaceFilm ( )
virtual

Destructor.

Definition at line 557 of file ThermoSurfaceFilm.C.

References ThermoSurfaceFilm< CloudType >::transferParcel().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

Foam::ThermoSurfaceFilm< CloudType >::interactionType interactionTypeEnum ( const word it) const

Definition at line 49 of file ThermoSurfaceFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, forAll, and ThermoSurfaceFilm< CloudType >::interactionTypeStr().

Here is the call graph for this function:

Foam::word interactionTypeStr ( const interactionType it) const

Definition at line 76 of file ThermoSurfaceFilm.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, and ThermoSurfaceFilm< CloudType >::tangentVector().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::vector tangentVector ( const vector v) const
protected

Return a vector tangential to input vector, v.

Definition at line 98 of file ThermoSurfaceFilm.C.

References Foam::mag(), ThermoSurfaceFilm< CloudType >::splashDirection(), and Vector< Cmpt >::zero.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::vector splashDirection ( const vector tanVec1,
const vector tanVec2,
const vector nf 
) const
protected

Return splashed parcel direction.

Definition at line 118 of file ThermoSurfaceFilm.C.

References ThermoSurfaceFilm< CloudType >::absorbInteraction(), Foam::constant::atomic::alpha, Foam::cos(), Foam::mag(), Foam::constant::mathematical::pi(), Foam::sin(), and Foam::constant::mathematical::twoPi().

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

Here is the call graph for this function:

Here is the caller graph for this function:

void absorbInteraction ( regionModels::surfaceFilmModels::surfaceFilmModel filmModel,
const parcelType p,
const polyPatch pp,
const label  faceI,
const scalar  mass,
bool &  keepParticle 
)
protected

Absorb parcel into film.

Definition at line 143 of file ThermoSurfaceFilm.C.

References surfaceFilmModel::addSources(), ThermoSurfaceFilm< CloudType >::bounceInteraction(), Foam::endl(), PrimitivePatch< Face, FaceList, PointField, PointType >::faceNormals(), patchIdentifier::index(), Foam::Info, Foam::mag(), and Urel.

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

Here is the call graph for this function:

Here is the caller graph for this function:

void bounceInteraction ( parcelType p,
const polyPatch pp,
const label  faceI,
bool &  keepParticle 
) const
protected

Bounce parcel (flip parcel normal velocity)

Definition at line 190 of file ThermoSurfaceFilm.C.

References ThermoSurfaceFilm< CloudType >::drySplashInteraction(), Foam::endl(), PrimitivePatch< Face, FaceList, PointField, PointType >::faceNormals(), patchIdentifier::index(), Foam::Info, and Urel.

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

Here is the call graph for this function:

Here is the caller graph for this function:

void drySplashInteraction ( regionModels::surfaceFilmModels::surfaceFilmModel filmModel,
const parcelType p,
const polyPatch pp,
const label  faceI,
bool &  keepParticle 
)
protected
void wetSplashInteraction ( regionModels::surfaceFilmModels::surfaceFilmModel filmModel,
parcelType p,
const polyPatch pp,
const label  faceI,
bool &  keepParticle 
)
protected
void splashInteraction ( regionModels::surfaceFilmModels::surfaceFilmModel filmModel,
const parcelType p,
const polyPatch pp,
const label  faceI,
const scalar  mRatio,
const scalar  We,
const scalar  Wec,
const scalar  sigma,
bool &  keepParticle 
)
protected
void cacheFilmFields ( const label  filmPatchI,
const label  primaryPatchI,
const regionModels::surfaceFilmModels::surfaceFilmModel filmModel 
)
protectedvirtual

Cache the film fields in preparation for injection.

Reimplemented from SurfaceFilmModel< CloudType >.

Definition at line 644 of file ThermoSurfaceFilm.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), SurfaceFilmModel< CloudType >::cacheFilmFields(), surfaceFilmModel::Cp(), ThermoSurfaceFilm< CloudType >::setParcelProperties(), regionModel::toPrimary(), and surfaceFilmModel::Ts().

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

Here is the call graph for this function:

Here is the caller graph for this function:

void setParcelProperties ( parcelType p,
const label  filmFaceI 
) const
protectedvirtual

Set the individual parcel properties.

Reimplemented from SurfaceFilmModel< CloudType >.

Definition at line 667 of file ThermoSurfaceFilm.C.

References SurfaceFilmModel< CloudType >::setParcelProperties().

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

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName ( "thermoSurfaceFilm"  )

Runtime type information.

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

Construct and return a clone using supplied owner cloud.

Implements SurfaceFilmModel< CloudType >.

Definition at line 256 of file ThermoSurfaceFilm.H.

References ThermoSurfaceFilm< CloudType >::info(), p, ThermoSurfaceFilm< CloudType >::transferParcel(), and ThermoSurfaceFilm< CloudType >::~ThermoSurfaceFilm().

Here is the call graph for this function:

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 565 of file ThermoSurfaceFilm.C.

References Foam::abort(), ThermoSurfaceFilm< CloudType >::cacheFilmFields(), Foam::FatalError, FatalErrorIn, patchIdentifier::index(), regionModel::isRegionPatch(), and polyPatch::whichFace().

Referenced by ThermoSurfaceFilm< CloudType >::clone(), and ThermoSurfaceFilm< CloudType >::~ThermoSurfaceFilm().

Here is the call graph for this function:

Here is the caller graph for this function:

void info ( Ostream os)
virtual

Write surface film info to stream.

Reimplemented from SurfaceFilmModel< CloudType >.

Definition at line 681 of file ThermoSurfaceFilm.C.

References Foam::endl(), SurfaceFilmModel< CloudType >::info(), and Foam::returnReduce().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Foam::wordList interactionTypeNames_
static

Word descriptions of interaction type names.

Definition at line 80 of file ThermoSurfaceFilm.H.

cachedRandom& rndGen_
protected

Reference to the cloud random number generator.

Definition at line 100 of file ThermoSurfaceFilm.H.

const SLGThermo& thermo_
protected

Reference to the cloud thermo package.

Definition at line 103 of file ThermoSurfaceFilm.H.

scalarList TFilmPatch_
protected

Film temperature / patch face.

Definition at line 109 of file ThermoSurfaceFilm.H.

scalarList CpFilmPatch_
protected

Film specific heat capacity / patch face.

Definition at line 112 of file ThermoSurfaceFilm.H.

interactionType interactionType_
protected

Interaction type enumeration.

Definition at line 118 of file ThermoSurfaceFilm.H.

scalar deltaWet_
protected

Film thickness beyond which patch is assumed to be wet.

Definition at line 121 of file ThermoSurfaceFilm.H.

label splashParcelType_
protected

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

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

Definition at line 126 of file ThermoSurfaceFilm.H.

label parcelsPerSplash_
protected

Number of new parcels resulting from splash event.

Definition at line 129 of file ThermoSurfaceFilm.H.

scalar Adry_
protected

Dry surface roughness coefficient.

= 2630 for dry interaction (ref. Bai)

Definition at line 137 of file ThermoSurfaceFilm.H.

scalar Awet_
protected

Wet surface roughness coefficient.

= 1320 for wet interaction (ref. Bai)

Definition at line 141 of file ThermoSurfaceFilm.H.

scalar Cf_
protected

Skin friction typically in the range 0.6 < Cf < 0.8.

Definition at line 145 of file ThermoSurfaceFilm.H.

label nParcelsSplashed_
protected

Counter for number of new splash parcels.

Definition at line 148 of file ThermoSurfaceFilm.H.


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