StochasticDispersionRAS< CloudType > Class Template Reference

The velocity is perturbed in random direction, with a Gaussian random number distribution with variance sigma. where sigma is defined below. More...

Inheritance diagram for StochasticDispersionRAS< CloudType >:
Collaboration diagram for StochasticDispersionRAS< CloudType >:

Public Member Functions

 TypeName ("stochasticDispersionRAS")
 Runtime type information. More...
 
 StochasticDispersionRAS (const dictionary &dict, CloudType &owner)
 Construct from components. More...
 
 StochasticDispersionRAS (StochasticDispersionRAS< CloudType > &dm)
 Construct copy. More...
 
virtual autoPtr
< DispersionModel< CloudType > > 
clone ()
 Construct and return a clone. More...
 
virtual ~StochasticDispersionRAS ()
 Destructor. More...
 
virtual vector update (const scalar dt, const label cellI, const vector &U, const vector &Uc, vector &UTurb, scalar &tTurb)
 Update (disperse particles) More...
 
- Public Member Functions inherited from DispersionRASModel< CloudType >
 TypeName ("dispersionRASModel")
 Runtime type information. More...
 
 DispersionRASModel (const dictionary &dict, CloudType &owner)
 Construct from components. More...
 
 DispersionRASModel (DispersionRASModel< CloudType > &dm)
 Construct copy. More...
 
virtual ~DispersionRASModel ()
 Destructor. 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 (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)
 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...
 
- 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...
 
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 >
Type getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
void getModelProperty (const word &entryName, Type &value) 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...
 

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...
 
- Protected Member Functions inherited from DispersionRASModel< CloudType >
tmp< volScalarFieldkModel () const
 Return the k field from the turbulence model. More...
 
tmp< volScalarFieldepsilonModel () const
 Return the epsilon field from the turbulence model. More...
 
- Protected Attributes inherited from DispersionRASModel< CloudType >
const volScalarFieldkPtr_
 Turbulence k. More...
 
bool ownK_
 Take ownership of the k field. More...
 
const volScalarFieldepsilonPtr_
 Turbulence epsilon. More...
 
bool ownEpsilon_
 Take ownership of the epsilon field. More...
 

Detailed Description

template<class CloudType>
class Foam::StochasticDispersionRAS< CloudType >

The velocity is perturbed in random direction, with a Gaussian random number distribution with variance sigma. where sigma is defined below.

Definition at line 49 of file StochasticDispersionRAS.H.

Constructor & Destructor Documentation

StochasticDispersionRAS ( const dictionary dict,
CloudType owner 
)

Construct from components.

Definition at line 32 of file StochasticDispersionRAS.C.

Construct copy.

Definition at line 43 of file StochasticDispersionRAS.C.

Destructor.

Definition at line 54 of file StochasticDispersionRAS.C.

Member Function Documentation

TypeName ( "stochasticDispersionRAS"  )

Runtime type information.

virtual autoPtr<DispersionModel<CloudType> > clone ( )
inlinevirtual

Construct and return a clone.

Reimplemented from DispersionRASModel< CloudType >.

Definition at line 68 of file StochasticDispersionRAS.H.

References StochasticDispersionRAS< CloudType >::clone().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::vector update ( const scalar  dt,
const label  cellI,
const vector U,
const vector Uc,
vector UTurb,
scalar &  tTurb 
)
virtual

Update (disperse particles)

Reimplemented from DispersionModel< CloudType >.

Definition at line 62 of file StochasticDispersionRAS.C.

References epsilon, k, Foam::log(), Foam::mag(), min, Foam::pow(), cachedRandom::sample01(), Foam::constant::physicoChemical::sigma, and Foam::sqrt().

Here is the call graph for this function:


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