Templated wall surface film model class. More...
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 dimensionedVector & | g () 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... | |
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 CloudType & | owner () const |
Return const access to the owner cloud. More... | |
virtual bool | writeTime () const |
Flag to indicate when to write a property. More... | |
CloudType & | owner () |
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 word & | modelName () const |
Return const access to the name of the sub-model. More... | |
const dictionary & | dict () const |
Return const access to the cloud dictionary. More... | |
const word & | baseName () const |
Return const access to the base name of the sub-model. More... | |
const word & | modelType () const |
Return const access to the sub-model type. More... | |
const dictionary & | coeffDict () const |
Return const access to the coefficients dictionary. More... | |
const dictionary & | properties () 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 dimensionedVector & | g_ |
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< vector > | UFilmPatch_ |
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 > | |
CloudType & | owner_ |
Reference to the cloud. More... | |
Protected Attributes inherited from subModelBase | |
const word | modelName_ |
Name of the sub-model. More... | |
dictionary & | properties_ |
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... | |
Templated wall surface film model class.
Definition at line 85 of file KinematicCloud.H.
|
protected |
Convenience typedef to the cloud's parcel type.
Definition at line 71 of file SurfaceFilmModel.H.
SurfaceFilmModel | ( | CloudType & | owner | ) |
Construct null from owner.
Definition at line 35 of file SurfaceFilmModel.C.
Referenced by SurfaceFilmModel< CloudType >::SurfaceFilmModel().
SurfaceFilmModel | ( | const dictionary & | dict, |
CloudType & | owner, | ||
const word & | type | ||
) |
Construct from components.
Definition at line 52 of file SurfaceFilmModel.C.
References SurfaceFilmModel< CloudType >::SurfaceFilmModel().
SurfaceFilmModel | ( | const SurfaceFilmModel< CloudType > & | sfm | ) |
Construct copy.
Definition at line 76 of file SurfaceFilmModel.C.
|
virtual |
Destructor.
Definition at line 96 of file SurfaceFilmModel.C.
|
protectedvirtual |
Cache the film fields in preparation for injection.
Reimplemented in ThermoSurfaceFilm< CloudType >.
Definition at line 207 of file SurfaceFilmModel.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), surfaceFilmModel::cloudDiameterTrans(), surfaceFilmModel::cloudMassTrans(), surfaceFilmModel::delta(), SurfaceFilmModel< CloudType >::deltaFilmPatch_, SurfaceFilmModel< CloudType >::diameterParcelPatch_, SurfaceFilmModel< CloudType >::massParcelPatch_, surfaceFilmModel::rho(), SurfaceFilmModel< CloudType >::rhoFilmPatch_, SurfaceFilmModel< CloudType >::setParcelProperties(), regionModel::toPrimary(), SurfaceFilmModel< CloudType >::UFilmPatch_, and surfaceFilmModel::Us().
Referenced by ThermoSurfaceFilm< CloudType >::cacheFilmFields(), and SurfaceFilmModel< CloudType >::inject().
|
protectedvirtual |
Set the individual parcel properties.
Reimplemented in ThermoSurfaceFilm< CloudType >, and NoSurfaceFilm< CloudType >.
Definition at line 234 of file SurfaceFilmModel.C.
References SurfaceFilmModel< CloudType >::diameterParcelPatch_, SurfaceFilmModel< CloudType >::ejectedParcelType_, SurfaceFilmModel< CloudType >::massParcelPatch_, Foam::constant::mathematical::pi(), Foam::pow3(), SurfaceFilmModel< CloudType >::rhoFilmPatch_, and SurfaceFilmModel< CloudType >::UFilmPatch_.
Referenced by SurfaceFilmModel< CloudType >::cacheFilmFields(), SurfaceFilmModel< CloudType >::inject(), and ThermoSurfaceFilm< CloudType >::setParcelProperties().
TypeName | ( | "surfaceFilmModel" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
SurfaceFilmModel< CloudType > | , | ||
dictionary | , | ||
(const dictionary &dict, CloudType &owner) | , | ||
(dict, owner) | |||
) |
Declare runtime constructor selection table.
|
pure virtual |
Construct and return a clone.
Implemented in ThermoSurfaceFilm< CloudType >, and NoSurfaceFilm< CloudType >.
|
static |
Selector.
Definition at line 33 of file SurfaceFilmModelNew.C.
References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), and Foam::nl.
|
inline |
Return gravitational acceleration constant.
Definition at line 31 of file SurfaceFilmModelI.H.
|
inline |
Return const access to the number of parcels transferred to the.
film model
Definition at line 45 of file SurfaceFilmModelI.H.
|
inline |
Return non-const access to the number of parcels transferred to.
the film model
Definition at line 38 of file SurfaceFilmModelI.H.
|
inline |
Return const access to the number of parcels injected from the.
film model
Definition at line 59 of file SurfaceFilmModelI.H.
|
inline |
Return non-const access to the number of parcels injected from.
the film model
Definition at line 52 of file SurfaceFilmModelI.H.
|
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 | ) |
Inject parcels into the cloud.
Definition at line 104 of file SurfaceFilmModel.C.
References subModelBase::active(), regionModel::active(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), polyMesh::boundaryMesh(), fvMesh::C(), SurfaceFilmModel< CloudType >::cacheFilmFields(), primitiveMesh::cells(), SurfaceFilmModel< CloudType >::deltaFilmPatch_, SurfaceFilmModel< CloudType >::diameterParcelPatch_, forAll, regionModel::intCoupledPatchIDs(), fvMesh::magSf(), Foam::max(), mesh, DSMCCloud< ParcelType >::mesh(), SurfaceFilmModel< CloudType >::nParcelsInjected_, CloudSubModelBase< CloudType >::owner(), Foam::pos(), regionModel::primaryPatchIDs(), SurfaceFilmModel< CloudType >::setParcelProperties(), fvMesh::Sf(), and fvMesh::time().
|
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_, Foam::returnReduce(), subModelBase::setModelProperty(), and CloudSubModelBase< CloudType >::writeTime().
Referenced by ThermoSurfaceFilm< CloudType >::info().
|
protected |
Gravitational acceleration constant.
Definition at line 74 of file SurfaceFilmModel.H.
|
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().
|
protected |
Parcel mass / patch face.
Definition at line 85 of file SurfaceFilmModel.H.
Referenced by SurfaceFilmModel< CloudType >::cacheFilmFields(), and SurfaceFilmModel< CloudType >::setParcelProperties().
|
protected |
Parcel diameter / patch face.
Definition at line 88 of file SurfaceFilmModel.H.
Referenced by SurfaceFilmModel< CloudType >::cacheFilmFields(), SurfaceFilmModel< CloudType >::inject(), and SurfaceFilmModel< CloudType >::setParcelProperties().
Film velocity / patch face.
Definition at line 91 of file SurfaceFilmModel.H.
Referenced by SurfaceFilmModel< CloudType >::cacheFilmFields(), and SurfaceFilmModel< CloudType >::setParcelProperties().
|
protected |
Film density / patch face.
Definition at line 94 of file SurfaceFilmModel.H.
Referenced by SurfaceFilmModel< CloudType >::cacheFilmFields(), and SurfaceFilmModel< CloudType >::setParcelProperties().
|
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().
|
protected |
Number of parcels transferred to the film model.
Definition at line 103 of file SurfaceFilmModel.H.
Referenced by SurfaceFilmModel< CloudType >::info().
|
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().