Public Member Functions | Static Public Member Functions | List of all members
PairModel< CloudType > Class Template Referenceabstract

Templated pair interaction class. More...

Inheritance diagram for PairModel< CloudType >:
Inheritance graph
[legend]

Public Member Functions

 TypeName ("pairModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, PairModel, dictionary,( const dictionary &dict, CloudType &owner ),(dict, owner))
 Declare runtime constructor selection table. More...
 
 PairModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from components. More...
 
virtual ~PairModel ()
 Destructor. More...
 
const CloudTypeowner () const
 Return the owner cloud object. More...
 
const dictionarydict () const
 Return the dictionary. More...
 
const dictionarycoeffDict () const
 Return the coefficients dictionary. More...
 
virtual bool controlsTimestep () const =0
 Whether the PairModel has a timestep limit that will. More...
 
virtual label nSubCycles () const =0
 For PairModels that control the timestep, calculate the. More...
 
virtual void evaluatePair (typename CloudType::parcelType &pA, typename CloudType::parcelType &pB) const =0
 Calculate the pair interaction between parcels. More...
 

Static Public Member Functions

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

Detailed Description

template<class CloudType>
class Foam::PairModel< CloudType >

Templated pair interaction class.

Source files

Definition at line 48 of file PairCollision.H.

Constructor & Destructor Documentation

PairModel ( const dictionary dict,
CloudType owner,
const word type 
)

Construct from components.

Definition at line 32 of file PairModel.C.

~PairModel ( )
virtual

Destructor.

Definition at line 47 of file PairModel.C.

Member Function Documentation

TypeName ( "pairModel"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
PairModel< CloudType ,
dictionary  ,
( const dictionary &dict, CloudType &owner ,
(dict, owner  
)

Declare runtime constructor selection table.

Foam::autoPtr< Foam::PairModel< CloudType > > New ( const dictionary dict,
CloudType owner 
)
static

Selector.

Definition at line 33 of file PairModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), and Foam::nl.

Here is the call graph for this function:

const CloudType & owner ( ) const

Return the owner cloud object.

Definition at line 55 of file PairModel.C.

const Foam::dictionary & dict ( ) const

Return the dictionary.

Definition at line 62 of file PairModel.C.

const Foam::dictionary & coeffDict ( ) const

Return the coefficients dictionary.

Definition at line 70 of file PairModel.C.

virtual bool controlsTimestep ( ) const
pure virtual

Whether the PairModel has a timestep limit that will.

require subCycling

Implemented in PairSpringSliderDashpot< CloudType >.

virtual label nSubCycles ( ) const
pure virtual

For PairModels that control the timestep, calculate the.

number of subCycles needed to satisfy the minimum allowable timestep

Implemented in PairSpringSliderDashpot< CloudType >.

virtual void evaluatePair ( typename CloudType::parcelType pA,
typename CloudType::parcelType pB 
) const
pure virtual

Calculate the pair interaction between parcels.

Implemented in PairSpringSliderDashpot< CloudType >.


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