Loading...
Searching...
No Matches
PairModel< CloudType > Class Template Referenceabstract

Templated pair interaction class. More...

#include <PairModel.H>

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

Public Member Functions

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

Static Public Member Functions

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

Protected Member Functions

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

Detailed Description

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

Templated pair interaction class.

Source files

Definition at line 51 of file PairModel.H.

Constructor & Destructor Documentation

◆ PairModel() [1/2]

template<class CloudType>
PairModel ( CloudType & owner)

Construct null from cloud owner.

Definition at line 27 of file PairModel.C.

References owner().

Referenced by declareRunTimeSelectionTable(), NoPair< CloudType >::NoPair(), and PairSpringSliderDashpot< CloudType >::PairSpringSliderDashpot().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PairModel() [2/2]

template<class CloudType>
PairModel ( const dictionary & dict,
CloudType & owner,
const word & type )

Construct from components.

Definition at line 40 of file PairModel.C.

References coeffDict(), dict(), and owner().

Here is the call graph for this function:

◆ ~PairModel()

template<class CloudType>
~PairModel ( )
virtual

Destructor.

Definition at line 60 of file PairModel.C.

Member Function Documentation

◆ forceCoeff()

template<class CloudType>
Foam::scalar forceCoeff ( typename CloudType::parcelType & pA,
typename CloudType::parcelType & pB ) const
protected

Return the force coefficient based on the forceRampTime_.

Definition at line 89 of file PairModel.C.

References Foam::min().

Referenced by PairSpringSliderDashpot< CloudType >::evaluatePair().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TypeName()

template<class CloudType>
TypeName ( "pairModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

References dict(), owner(), and PairModel().

Here is the call graph for this function:

◆ New()

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

Selector.

Definition at line 28 of file PairModelNew.C.

References dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and owner().

Here is the call graph for this function:

◆ owner()

template<class CloudType>
const CloudType & owner ( ) const

Return the owner cloud object.

Definition at line 68 of file PairModel.C.

Referenced by declareRunTimeSelectionTable(), PairSpringSliderDashpot< CloudType >::evaluatePair(), New(), PairSpringSliderDashpot< CloudType >::nSubCycles(), PairModel(), PairModel(), and PairSpringSliderDashpot< CloudType >::PairSpringSliderDashpot().

Here is the caller graph for this function:

◆ dict()

template<class CloudType>
const Foam::dictionary & dict ( ) const

Return the dictionary.

Definition at line 75 of file PairModel.C.

Referenced by declareRunTimeSelectionTable(), New(), NoPair< CloudType >::NoPair(), PairModel(), PairSpringSliderDashpot< CloudType >::PairSpringSliderDashpot(), NoPair< CloudType >::TypeName(), and PairSpringSliderDashpot< CloudType >::TypeName().

Here is the caller graph for this function:

◆ coeffDict()

template<class CloudType>
const Foam::dictionary & coeffDict ( ) const

Return the coefficients dictionary.

Definition at line 82 of file PairModel.C.

Referenced by PairModel(), and PairSpringSliderDashpot< CloudType >::PairSpringSliderDashpot().

Here is the caller graph for this function:

◆ controlsTimestep()

template<class CloudType>
virtual bool controlsTimestep ( ) const
pure virtual

Whether the PairModel has a timestep limit that will.

require subCycling

Implemented in NoPair< CloudType >, and PairSpringSliderDashpot< CloudType >.

◆ nSubCycles()

template<class 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 NoPair< CloudType >, and PairSpringSliderDashpot< CloudType >.

◆ evaluatePair()

template<class CloudType>
virtual void evaluatePair ( typename CloudType::parcelType & pA,
typename CloudType::parcelType & pB ) const
pure virtual

Calculate the pair interaction between parcels.

Implemented in NoPair< CloudType >, and PairSpringSliderDashpot< CloudType >.

The documentation for this class was generated from the following files:
  • src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairCollision.H
  • src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairModel/PairModel/PairModel.H
  • src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairModel/PairModel/PairModel.C
  • src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairModel/PairModel/PairModelNew.C