NoPair< CloudType > Class Template Reference

Placeholder for 'none' option. More...

#include <NoPair.H>

Inheritance diagram for NoPair< CloudType >:

Collaboration diagram for NoPair< CloudType >:

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

Additional Inherited Members
Static Public Member Functions inherited from PairModel< CloudType >
static autoPtr< PairModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector.
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_.

Detailed Description

template<class CloudType>
class Foam::NoPair< CloudType >

Placeholder for 'none' option.

Source files

• NoPair.H
• NoPair.C

Definition at line 46 of file NoPair.H.

Constructor & Destructor Documentation

NoPair()

template<class CloudType>

NoPair	(	const dictionary &	dict,
		CloudType &	cloud )

Construct from dictionary and cloud owner.

Definition at line 26 of file NoPair.C.

References PairModel< CloudType >::dict(), and PairModel< CloudType >::PairModel().

Here is the call graph for this function:

~NoPair()

template<class CloudType>

virtual ~NoPair ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

template<class CloudType>

TypeName

(

"none"

)

Runtime type information.

References PairModel< CloudType >::dict().

Here is the call graph for this function:

controlsTimestep()

template<class CloudType>

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()

template<class CloudType>

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()

template<class CloudType>

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

virtual

Calculate the pair interaction between parcels.

Implements PairModel< CloudType >.

Definition at line 53 of file NoPair.C.

---

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

• src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairModel/NoPair/NoPair.H
• src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairModel/NoPair/NoPair.C