PatchInteractionModel< CloudType > Class Template Referenceabstract

Templated patch interaction model class. More...

Inheritance diagram for PatchInteractionModel< CloudType >:
Collaboration diagram for PatchInteractionModel< CloudType >:

Public Types

enum  interactionType {
  itNone, itRebound, itStick, itEscape,

Public Member Functions

 TypeName ("patchInteractionModel")
 Runtime type information. More...
 declareRunTimeSelectionTable (autoPtr, PatchInteractionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table. More...
 PatchInteractionModel (CloudType &owner)
 Construct null from owner. More...
 PatchInteractionModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from components. More...
 PatchInteractionModel (const PatchInteractionModel< CloudType > &pim)
 Construct copy. More...
virtual autoPtr< PatchInteractionModel< CloudType > > clone () const =0
 Construct and return a clone. More...
virtual ~PatchInteractionModel ()=default
 Destructor. More...
const wordUName () const
 Return name of velocity field. More...
virtual bool correct (typename CloudType::parcelType &p, const polyPatch &pp, bool &keepParticle)=0
 Apply velocity correction. More...
void addToEscapedParcels (const scalar mass)
 Add to escaped parcels. More...
virtual void info (Ostream &os)
 Write patch interaction info to stream. More...

Static Public Member Functions

static autoPtr< PatchInteractionModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
static word interactionTypeToWord (const interactionType &itEnum)
 Convert interaction result to word. More...
static interactionType wordToInteractionType (const word &itWord)
 Convert word to interaction result. More...

Static Public Attributes

static wordList interactionTypeNames_

Protected Member Functions

virtual void writeFileHeader (Ostream &os)
 Output file header information. More...

Protected Attributes

const word UName_
 Name of velocity field - default = "U". More...
label escapedParcels_
 Number of parcels escaped. More...
scalar escapedMass_
 Mass of parcels escaped. More...

Detailed Description

template<class CloudType>
class Foam::PatchInteractionModel< CloudType >

Templated patch interaction model class.

Source files

Definition at line 89 of file KinematicCloud.H.

Member Enumeration Documentation

◆ interactionType


Definition at line 73 of file PatchInteractionModel.H.

Constructor & Destructor Documentation

◆ PatchInteractionModel() [1/3]

Construct null from owner.

Definition at line 132 of file PatchInteractionModel.C.

◆ PatchInteractionModel() [2/3]

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

Construct from components.

Definition at line 146 of file PatchInteractionModel.C.

◆ PatchInteractionModel() [3/3]

Construct copy.

Definition at line 169 of file PatchInteractionModel.C.

◆ ~PatchInteractionModel()

virtual ~PatchInteractionModel ( )


Member Function Documentation

◆ writeFileHeader()

void writeFileHeader ( Ostream os)

Output file header information.

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

Definition at line 46 of file PatchInteractionModel.C.

◆ TypeName()

TypeName ( "patchInteractionModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

◆ clone()

◆ New()

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


Definition at line 36 of file PatchInteractionModelNew.C.

◆ UName()

const Foam::word & UName ( ) const

Return name of velocity field.

Definition at line 184 of file PatchInteractionModel.C.

◆ interactionTypeToWord()

Foam::word interactionTypeToWord ( const interactionType itEnum)

Convert interaction result to word.

Definition at line 61 of file PatchInteractionModel.C.

◆ wordToInteractionType()

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

Convert word to interaction result.

Definition at line 101 of file PatchInteractionModel.C.

◆ correct()

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

Apply velocity correction.

Returns true if particle remains in same cell

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

◆ addToEscapedParcels()

void addToEscapedParcels ( const scalar  mass)

Add to escaped parcels.

Definition at line 192 of file PatchInteractionModel.C.

◆ info()

void info ( Ostream os)

Write patch interaction info to stream.

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

Definition at line 202 of file PatchInteractionModel.C.

Member Data Documentation

◆ interactionTypeNames_

Foam::wordList interactionTypeNames_
Initial value:
"rebound", "stick", "escape"

Definition at line 82 of file PatchInteractionModel.H.

◆ UName_

const word UName_

Name of velocity field - default = "U".

Definition at line 90 of file PatchInteractionModel.H.

◆ escapedParcels_

label escapedParcels_

Number of parcels escaped.

Definition at line 96 of file PatchInteractionModel.H.

◆ escapedMass_

scalar escapedMass_

Mass of parcels escaped.

Definition at line 99 of file PatchInteractionModel.H.

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