Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
PatchInteractionModel< CloudType > Class Template Referenceabstract
Lagrangian particle models » Submodels » Kinematic » Patch interaction

Templated patch interaction model class. More...

Inheritance diagram for PatchInteractionModel< CloudType >:
[legend]
Collaboration diagram for PatchInteractionModel< CloudType >:
[legend]

Public Types

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

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 word & UName () const
 Return name of velocity field. More...
 
const scalar & Urmax () const
 Return Urmax. More...
 
virtual bool correct (typename CloudType::parcelType &p, const polyPatch &pp, bool &keepParticle)=0
 Apply velocity correction. More...
 
virtual void addToEscapedParcels (const scalar mass)
 Add to escaped parcels. More...
 
virtual void postEvolve ()
 Post-evolve hook. 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...
 
scalar Urmax_
 Maximum relative U with patch for particle to be removed. 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

enum interactionType
Enumerator
itNone 
itRebound 
itStick 
itEscape 
itOther 

Definition at line 73 of file PatchInteractionModel.H.

Constructor & Destructor Documentation

◆ PatchInteractionModel() [1/3]

PatchInteractionModel ( CloudType &  owner)

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 147 of file PatchInteractionModel.C.

◆ PatchInteractionModel() [3/3]

PatchInteractionModel ( const PatchInteractionModel< CloudType > &  pim)

Construct copy.

Definition at line 171 of file PatchInteractionModel.C.

◆ ~PatchInteractionModel()

virtual ~PatchInteractionModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ writeFileHeader()

void writeFileHeader ( Ostream &  os)
protectedvirtual

Output file header information.

Reimplemented in RecycleInteraction< CloudType >, 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()

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

Construct and return a clone.

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

◆ New()

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

Selector.

Definition at line 36 of file PatchInteractionModelNew.C.

◆ UName()

const Foam::word & UName ( ) const

Return name of velocity field.

Definition at line 187 of file PatchInteractionModel.C.

◆ Urmax()

const Foam::scalar & Urmax ( ) const

Return Urmax.

Definition at line 194 of file PatchInteractionModel.C.

◆ interactionTypeToWord()

Foam::word interactionTypeToWord ( const interactionType &  itEnum)
static

Convert interaction result to word.

Definition at line 61 of file PatchInteractionModel.C.

◆ wordToInteractionType()

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

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 RecycleInteraction< CloudType >, StandardWallInteraction< CloudType >, MultiInteraction< CloudType >, LocalInteraction< CloudType >, Rebound< CloudType >, and NoInteraction< CloudType >.

◆ addToEscapedParcels()

void addToEscapedParcels ( const scalar  mass)
virtual

Add to escaped parcels.

Definition at line 202 of file PatchInteractionModel.C.

◆ postEvolve()

void postEvolve ( )
virtual

Post-evolve hook.

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

Definition at line 212 of file PatchInteractionModel.C.

◆ info()

void info ( Ostream &  os)
virtual

Write patch interaction info to stream.

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

Definition at line 217 of file PatchInteractionModel.C.

Member Data Documentation

◆ interactionTypeNames_

Foam::wordList interactionTypeNames_
static
Initial value:
{
"rebound", "stick", "escape"
}

Definition at line 82 of file PatchInteractionModel.H.

◆ UName_

const word UName_
protected

Name of velocity field - default = "U".

Definition at line 90 of file PatchInteractionModel.H.

◆ escapedParcels_

label escapedParcels_
protected

Number of parcels escaped.

Definition at line 96 of file PatchInteractionModel.H.

◆ escapedMass_

scalar escapedMass_
protected

Mass of parcels escaped.

Definition at line 99 of file PatchInteractionModel.H.

◆ Urmax_

scalar Urmax_
protected

Maximum relative U with patch for particle to be removed.

Definition at line 102 of file PatchInteractionModel.H.

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