Base class for particle dispersion models based on RAS turbulence. More...
Public Member Functions | |
TypeName ("dispersionRASModel") | |
Runtime type information. More... | |
DispersionRASModel (const dictionary &dict, CloudType &owner) | |
Construct from components. More... | |
DispersionRASModel (const DispersionRASModel< CloudType > &dm) | |
Construct copy. More... | |
virtual autoPtr< DispersionModel< CloudType > > | clone () const =0 |
Construct and return a clone. More... | |
virtual | ~DispersionRASModel () |
Destructor. More... | |
virtual vector | update (const scalar dt, const label celli, const vector &U, const vector &Uc, vector &UTurb, scalar &tTurb)=0 |
Update (disperse particles) More... | |
virtual void | cacheFields (const bool store) |
Cache carrier fields. More... | |
virtual void | write (Ostream &os) const |
Write. More... | |
Public Member Functions inherited from DispersionModel< CloudType > | |
TypeName ("dispersionModel") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, DispersionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner)) | |
DispersionModel (CloudType &owner) | |
Construct null from owner. More... | |
DispersionModel (const dictionary &dict, CloudType &owner, const word &type) | |
Construct from components. More... | |
DispersionModel (const DispersionModel< CloudType > &dm) | |
Construct copy. More... | |
virtual | ~DispersionModel () |
Destructor. 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) | |
Copy constructor. 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... | |
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) | |
Copy constructor. 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... | |
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... | |
void | operator= (const subModelBase &)=delete |
Disallow default bitwise assignment. More... | |
Protected Member Functions | |
tmp< volScalarField > | kModel () const |
Return the k field from the turbulence model. More... | |
tmp< volScalarField > | epsilonModel () const |
Return the epsilon field from the turbulence model. More... | |
Protected Member Functions inherited from subModelBase | |
bool | inLine () const |
Flag to indicate whether data is/was read in-line. More... | |
Protected Attributes | |
const volScalarField * | kPtr_ |
Turbulence k. More... | |
bool | ownK_ |
Take ownership of the k field. More... | |
const volScalarField * | epsilonPtr_ |
Turbulence epsilon. More... | |
bool | ownEpsilon_ |
Take ownership of the epsilon field. 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... | |
Static Public Member Functions inherited from DispersionModel< CloudType > | |
static autoPtr< DispersionModel< CloudType > > | New (const dictionary &dict, CloudType &owner) |
Selector. More... | |
Base class for particle dispersion models based on RAS turbulence.
Definition at line 47 of file DispersionRASModel.H.
DispersionRASModel | ( | const dictionary & | dict, |
CloudType & | owner | ||
) |
Construct from components.
Definition at line 85 of file DispersionRASModel.C.
DispersionRASModel | ( | const DispersionRASModel< CloudType > & | dm | ) |
Construct copy.
Definition at line 100 of file DispersionRASModel.C.
References DispersionRASModel< CloudType >::ownEpsilon_, and DispersionRASModel< CloudType >::ownK_.
|
virtual |
Destructor.
Definition at line 119 of file DispersionRASModel.C.
|
protected |
Return the k field from the turbulence model.
Definition at line 34 of file DispersionRASModel.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, objectRegistry::foundType(), momentumTransportModel::k(), objectRegistry::lookupType(), Foam::nl, and objectRegistry::sortedToc().
|
protected |
Return the epsilon field from the turbulence model.
Definition at line 59 of file DispersionRASModel.C.
References Foam::abort(), momentumTransportModel::epsilon(), Foam::FatalError, FatalErrorInFunction, objectRegistry::foundType(), objectRegistry::lookupType(), Foam::nl, and objectRegistry::sortedToc().
TypeName | ( | "dispersionRASModel" | ) |
Runtime type information.
|
pure virtual |
Construct and return a clone.
Implements DispersionModel< CloudType >.
Implemented in StochasticDispersionRAS< CloudType >, and GradientDispersionRAS< CloudType >.
|
pure virtual |
Update (disperse particles)
Implements DispersionModel< CloudType >.
Implemented in StochasticDispersionRAS< CloudType >, and GradientDispersionRAS< CloudType >.
|
virtual |
Cache carrier fields.
Reimplemented from subModelBase.
Reimplemented in GradientDispersionRAS< CloudType >.
Definition at line 128 of file DispersionRASModel.C.
References Foam::deleteDemandDrivenData(), tmp< T >::isTmp(), and tmp< T >::ptr().
Referenced by GradientDispersionRAS< CloudType >::cacheFields().
|
virtual |
Write.
Reimplemented from CloudSubModelBase< CloudType >.
Definition at line 173 of file DispersionRASModel.C.
References CloudSubModelBase< CloudType >::write(), and Foam::writeEntry().
|
protected |
Turbulence k.
Definition at line 58 of file DispersionRASModel.H.
|
mutableprotected |
Take ownership of the k field.
Definition at line 61 of file DispersionRASModel.H.
Referenced by DispersionRASModel< CloudType >::DispersionRASModel().
|
protected |
Turbulence epsilon.
Definition at line 64 of file DispersionRASModel.H.
|
mutableprotected |
Take ownership of the epsilon field.
Definition at line 67 of file DispersionRASModel.H.
Referenced by DispersionRASModel< CloudType >::DispersionRASModel().