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

Templated pair interaction class. More...

Inheritance diagram for PairModel< CloudType >:
[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 CloudType & owner () const
 Return the owner cloud object. More...
 
const dictionary & dict () const
 Return the dictionary. More...
 
const dictionary & coeffDict () 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...
 

Protected Member Functions

scalar forceCoeff (typename CloudType::parcelType &pA, typename CloudType::parcelType &pB) const
 Return the force coefficient based on the forceRampTime_. More...
 

Detailed Description

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

Templated pair interaction class.

Source files

Definition at line 53 of file PairCollision.H.

Constructor & Destructor Documentation

◆ PairModel()

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

Construct from components.

Definition at line 35 of file PairModel.C.

◆ ~PairModel()

~PairModel ( )
virtual

Destructor.

Definition at line 54 of file PairModel.C.

Member Function Documentation

◆ forceCoeff()

Foam::scalar forceCoeff ( typename CloudType::parcelType &  pA,
typename CloudType::parcelType &  pB 
) const
protected

Return the force coefficient based on the forceRampTime_.

Definition at line 84 of file PairModel.C.

◆ TypeName()

TypeName ( "pairModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

◆ New()

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

Selector.

Definition at line 36 of file PairModelNew.C.

◆ owner()

const CloudType & owner ( ) const

Return the owner cloud object.

Definition at line 62 of file PairModel.C.

◆ dict()

const Foam::dictionary & dict ( ) const

Return the dictionary.

Definition at line 69 of file PairModel.C.

◆ coeffDict()

const Foam::dictionary & coeffDict ( ) const

Return the coefficients dictionary.

Definition at line 76 of file PairModel.C.

◆ controlsTimestep()

virtual bool controlsTimestep ( ) const
pure virtual

Whether the PairModel has a timestep limit that will.

require subCycling

Implemented in PairSpringSliderDashpot< CloudType >.

◆ nSubCycles()

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

◆ evaluatePair()

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: