PairModel Class Reference

Templated pair interaction class. More...

Inheritance diagram for PairModel:

Public Member Functions
	TypeName ("pairModel")
	declareRunTimeSelectionTable (autoPtr, PairModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	PairModel (const dictionary &dict, CloudType &owner, const word &type)
virtual	~PairModel ()
const CloudType &	owner () const
const dictionary &	dict () const
const dictionary &	coeffDict () const
virtual bool	controlsTimestep () const =0
virtual label	nSubCycles () const =0
virtual void	evaluatePair (typename CloudType::parcelType &pA, typename CloudType::parcelType &pB) const =0

Static Public Member Functions
static autoPtr< PairModel< CloudType > >	New (const dictionary &dict, CloudType &owner)

Protected Member Functions
scalar	forceCoeff (typename CloudType::parcelType &pA, typename CloudType::parcelType &pB) const

Detailed Description

Templated pair interaction class.

Source files

• PairModel.H
• PairModel.C
• PairModelNew.C

Definition at line 49 of file PairCollision.H.

Constructor & Destructor Documentation

PairModel()

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

Definition at line 28 of file PairModel.C.

~PairModel()

~PairModel ( )

virtual

Definition at line 47 of file PairModel.C.

Member Function Documentation

forceCoeff()

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

protected

Definition at line 77 of file PairModel.C.

TypeName()

TypeName

(

"pairModel"

)

declareRunTimeSelectionTable()

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

New()

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

static

Definition at line 29 of file PairModelNew.C.

owner()

const CloudType & owner

(

)

const

Definition at line 55 of file PairModel.C.

dict()

const Foam::dictionary & dict

(

)

const

Definition at line 62 of file PairModel.C.

coeffDict()

const Foam::dictionary & coeffDict

(

)

const

Definition at line 69 of file PairModel.C.

controlsTimestep()

virtual bool controlsTimestep ( ) const

pure virtual

nSubCycles()

virtual label nSubCycles ( ) const

pure virtual

evaluatePair()

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

pure virtual

Implemented in 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