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

Base class for particle dispersion models based on RAS turbulence. More...

Inheritance diagram for DispersionRASModel< CloudType >:
[legend]
Collaboration diagram for DispersionRASModel< CloudType >:
[legend]

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...
 

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 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...
 

Additional Inherited Members

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

Detailed Description

template<class CloudType>
class Foam::DispersionRASModel< CloudType >

Base class for particle dispersion models based on RAS turbulence.

Definition at line 49 of file DispersionRASModel.H.

Constructor & Destructor Documentation

◆ DispersionRASModel() [1/2]

DispersionRASModel ( const dictionary &  dict,
CloudType &  owner 
)

Construct from components.

Definition at line 94 of file DispersionRASModel.C.

◆ DispersionRASModel() [2/2]

DispersionRASModel ( const DispersionRASModel< CloudType > &  dm)

Construct copy.

Definition at line 109 of file DispersionRASModel.C.

References DispersionRASModel< CloudType >::ownEpsilon_, and DispersionRASModel< CloudType >::ownK_.

◆ ~DispersionRASModel()

~DispersionRASModel ( )
virtual

Destructor.

Definition at line 127 of file DispersionRASModel.C.

Member Function Documentation

◆ kModel()

Foam::tmp< Foam::volScalarField > kModel ( ) const
protected

Return the k field from the turbulence model.

Definition at line 36 of file DispersionRASModel.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, objectRegistry::findObject(), Foam::constant::atomic::group, Foam::nl, HashTable< T, Key, Hash >::sortedToc(), turb, and U.

Here is the call graph for this function:

◆ epsilonModel()

Foam::tmp< Foam::volScalarField > epsilonModel ( ) const
protected

Return the epsilon field from the turbulence model.

Definition at line 64 of file DispersionRASModel.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, objectRegistry::findObject(), Foam::constant::atomic::group, Foam::nl, HashTable< T, Key, Hash >::sortedToc(), turb, and U.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "dispersionRASModel"  )

Runtime type information.

◆ clone()

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

Construct and return a clone.

Implements DispersionModel< CloudType >.

Implemented in GradientDispersionRAS< CloudType >, and StochasticDispersionRAS< CloudType >.

◆ update()

virtual vector update ( const scalar  dt,
const label  celli,
const vector &  U,
const vector &  Uc,
vector &  UTurb,
scalar &  tTurb 
)
pure virtual

Update (disperse particles)

Implements DispersionModel< CloudType >.

Implemented in GradientDispersionRAS< CloudType >, and StochasticDispersionRAS< CloudType >.

◆ cacheFields()

void cacheFields ( const bool  store)
virtual

Cache carrier fields.

Reimplemented in GradientDispersionRAS< CloudType >.

Definition at line 136 of file DispersionRASModel.C.

References Foam::deleteDemandDrivenData(), tmp< T >::isTmp(), and tmp< T >::ptr().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 181 of file DispersionRASModel.C.

References os(), and Foam::vtk::write().

Here is the call graph for this function:

Member Data Documentation

◆ kPtr_

const volScalarField* kPtr_
protected

Turbulence k.

Definition at line 60 of file DispersionRASModel.H.

◆ ownK_

bool ownK_
mutableprotected

Take ownership of the k field.

Definition at line 63 of file DispersionRASModel.H.

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

◆ epsilonPtr_

const volScalarField* epsilonPtr_
protected

Turbulence epsilon.

Definition at line 66 of file DispersionRASModel.H.

◆ ownEpsilon_

bool ownEpsilon_
mutableprotected

Take ownership of the epsilon field.

Definition at line 69 of file DispersionRASModel.H.

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

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