FreeFOAM The Cross-Platform CFD Toolkit
DispersionModel< CloudType > Class Template Reference

#include <lagrangianIntermediate/DispersionModel.H>


Detailed Description

template<class CloudType>
class Foam::DispersionModel< CloudType >

Definition at line 48 of file DispersionModel.H.

+ Inheritance diagram for DispersionModel< CloudType >:

List of all members.

Public Member Functions

 TypeName ("DispersionModel")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, DispersionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 DispersionModel (CloudType &owner)
 Construct null from owner.
 DispersionModel (const dictionary &dict, CloudType &owner)
 Construct from components.
virtual ~DispersionModel ()
 Destructor.
const CloudType & owner () const
 Return the owner cloud object.
CloudType & owner ()
 Return the owner cloud object.
const dictionarydict () const
 Return the dictionary.
virtual bool active () const =0
 Flag to indicate whether model activates injection model.
virtual void cacheFields (const bool store)=0
 Cache carrier fields.
virtual vector update (const scalar dt, const label celli, const vector &U, const vector &Uc, vector &UTurb, scalar &tTurb)=0
 Update (disperse particles)

Static Public Member Functions

static autoPtr
< DispersionModel< CloudType > > 
New (const dictionary &dict, CloudType &owner)
 Selector.

Constructor & Destructor Documentation

DispersionModel ( CloudType &  owner)

Construct null from owner.

Definition at line 31 of file DispersionModel.C.

DispersionModel ( const dictionary dict,
CloudType &  owner 
)

Construct from components.

Definition at line 40 of file DispersionModel.C.

~DispersionModel ( )
virtual

Destructor.

Definition at line 53 of file DispersionModel.C.


Member Function Documentation

TypeName ( "DispersionModel< CloudType >"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
DispersionModel< CloudType >  ,
dictionary  ,
(const dictionary &dict, CloudType &owner ,
(dict, owner  
)
Foam::autoPtr< Foam::DispersionModel< CloudType > > New ( const dictionary dict,
CloudType &  owner 
)
static
const CloudType & owner ( ) const

Return the owner cloud object.

Definition at line 60 of file DispersionModel.C.

CloudType & owner ( )

Return the owner cloud object.

Definition at line 67 of file DispersionModel.C.

const Foam::dictionary & dict ( ) const

Return the dictionary.

Definition at line 74 of file DispersionModel.C.

virtual bool active ( ) const
pure virtual

Flag to indicate whether model activates injection model.

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

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

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