Public Member Functions | List of all members
NoPair< CloudType > Class Template Reference

Placeholder for 'none' option. More...

Inheritance diagram for NoPair< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for NoPair< CloudType >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("none")
 Runtime type information. More...
 
 NoPair (const dictionary &dict, CloudType &cloud)
 Construct from dictionary and cloud owner. More...
 
virtual ~NoPair ()=default
 Destructor. More...
 
virtual bool controlsTimestep () const
 Whether the PairModel has a timestep limit that will require subCycling. More...
 
virtual label nSubCycles () const
 For PairModels that control the timestep, calculate the number of subCycles needed to satisfy the minimum allowable timestep. More...
 
virtual void evaluatePair (typename CloudType::parcelType &pA, typename CloudType::parcelType &pB) const
 Calculate the pair interaction between parcels. More...
 
- Public Member Functions inherited from PairModel< CloudType >
 TypeName ("pairModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, PairModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table. More...
 
 PairModel (CloudType &owner)
 Construct null from cloud owner. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from PairModel< CloudType >
static autoPtr< PairModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 
- Protected Member Functions inherited from PairModel< CloudType >
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::NoPair< CloudType >

Placeholder for 'none' option.

Source files

Definition at line 46 of file NoPair.H.

Constructor & Destructor Documentation

◆ NoPair()

NoPair ( const dictionary &  dict,
CloudType &  cloud 
)

Construct from dictionary and cloud owner.

Definition at line 27 of file NoPair.C.

◆ ~NoPair()

virtual ~NoPair ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "none"  )

Runtime type information.

◆ controlsTimestep()

bool controlsTimestep ( ) const
virtual

Whether the PairModel has a timestep limit that will require subCycling.

Implements PairModel< CloudType >.

Definition at line 39 of file NoPair.C.

◆ nSubCycles()

Foam::label nSubCycles ( ) const
virtual

For PairModels that control the timestep, calculate the number of subCycles needed to satisfy the minimum allowable timestep.

Implements PairModel< CloudType >.

Definition at line 46 of file NoPair.C.

◆ evaluatePair()

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

Calculate the pair interaction between parcels.

Implements PairModel< CloudType >.

Definition at line 54 of file NoPair.C.

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