PatchInteractionModel Class Reference

Templated patch interaction model class. More...

Inheritance diagram for PatchInteractionModel:

Collaboration diagram for PatchInteractionModel:

Public Types
enum	interactionType {   itNone, itRebound, itStick, itEscape,   itOther }

Public Member Functions
	TypeName ("patchInteractionModel")
	declareRunTimeSelectionTable (autoPtr, PatchInteractionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	PatchInteractionModel (CloudType &owner)
	PatchInteractionModel (const dictionary &dict, CloudType &owner, const word &type)
	PatchInteractionModel (const PatchInteractionModel< CloudType > &pim)
virtual autoPtr< PatchInteractionModel< CloudType > >	clone () const =0
virtual	~PatchInteractionModel ()=default
const word &	UName () const
const scalar &	Urmax () const
virtual bool	correct (typename CloudType::parcelType &p, const polyPatch &pp, bool &keepParticle)=0
virtual void	addToEscapedParcels (const scalar mass)
virtual void	postEvolve ()
virtual void	info (Ostream &os)

Static Public Member Functions
static autoPtr< PatchInteractionModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
static word	interactionTypeToWord (const interactionType &itEnum)
static interactionType	wordToInteractionType (const word &itWord)

Static Public Attributes
static wordList	interactionTypeNames_

Protected Member Functions
virtual void	writeFileHeader (Ostream &os)

Protected Attributes
const word	UName_
label	escapedParcels_
scalar	escapedMass_
scalar	Urmax_

Detailed Description

Templated patch interaction model class.

Source files

• PatchInteractionModel.H
• PatchInteractionModel.C
• PatchInteractionModelNew.C

Definition at line 85 of file KinematicCloud.H.

Member Enumeration Documentation

interactionType

enum interactionType

Enumerator
itNone
itRebound
itStick
itEscape
itOther

Definition at line 69 of file PatchInteractionModel.H.

Constructor & Destructor Documentation

PatchInteractionModel() [1/3]

PatchInteractionModel

(

CloudType &

owner

)

Definition at line 125 of file PatchInteractionModel.C.

PatchInteractionModel() [2/3]

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

Definition at line 140 of file PatchInteractionModel.C.

PatchInteractionModel() [3/3]

PatchInteractionModel

(

const PatchInteractionModel< CloudType > &

pim

)

Definition at line 164 of file PatchInteractionModel.C.

~PatchInteractionModel()

virtual ~PatchInteractionModel ( )

virtualdefault

Member Function Documentation

writeFileHeader()

void writeFileHeader ( Ostream &  os )

protectedvirtual

Reimplemented in RecycleInteraction< CloudType >, StandardWallInteraction< CloudType >, and LocalInteraction< CloudType >.

Definition at line 39 of file PatchInteractionModel.C.

TypeName()

TypeName

(

"patchInteractionModel"

)

declareRunTimeSelectionTable()

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

clone()

virtual autoPtr<PatchInteractionModel<CloudType> > clone ( ) const

pure virtual

New()

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

static

Definition at line 29 of file PatchInteractionModelNew.C.

UName()

const Foam::word & UName

(

)

const

Definition at line 180 of file PatchInteractionModel.C.

Urmax()

const Foam::scalar & Urmax

(

)

const

Definition at line 187 of file PatchInteractionModel.C.

interactionTypeToWord()

Foam::word interactionTypeToWord ( const interactionType &  itEnum )

static

Definition at line 54 of file PatchInteractionModel.C.

wordToInteractionType()

Foam::PatchInteractionModel< CloudType >::interactionType wordToInteractionType ( const word &  itWord )

static

Definition at line 94 of file PatchInteractionModel.C.

correct()

virtual bool correct ( typename CloudType::parcelType &  p, const polyPatch &  pp, bool &  keepParticle  )

pure virtual

Implemented in RecycleInteraction< CloudType >, StandardWallInteraction< CloudType >, MultiInteraction< CloudType >, LocalInteraction< CloudType >, Rebound< CloudType >, and NoInteraction< CloudType >.

addToEscapedParcels()

void addToEscapedParcels ( const scalar  mass )

virtual

Definition at line 195 of file PatchInteractionModel.C.

postEvolve()

void postEvolve ( )

virtual

Reimplemented in RecycleInteraction< CloudType >, and MultiInteraction< CloudType >.

Definition at line 205 of file PatchInteractionModel.C.

info()

void info ( Ostream &  os )

virtual

Reimplemented in RecycleInteraction< CloudType >, StandardWallInteraction< CloudType >, MultiInteraction< CloudType >, and LocalInteraction< CloudType >.

Definition at line 210 of file PatchInteractionModel.C.

Member Data Documentation

interactionTypeNames_

Foam::wordList interactionTypeNames_

static

Initial value:

{
    "rebound", "stick", "escape"
}

Definition at line 78 of file PatchInteractionModel.H.

UName_

const word UName_

protected

Definition at line 86 of file PatchInteractionModel.H.

escapedParcels_

label escapedParcels_

protected

Definition at line 92 of file PatchInteractionModel.H.

escapedMass_

scalar escapedMass_

protected

Definition at line 95 of file PatchInteractionModel.H.

Urmax_

scalar Urmax_

protected

Definition at line 98 of file PatchInteractionModel.H.

---

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

• src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.H
• src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/PatchInteractionModel/PatchInteractionModel.H
• src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/PatchInteractionModel/PatchInteractionModel.C
• src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/PatchInteractionModel/PatchInteractionModelNew.C