FreeFOAM The Cross-Platform CFD Toolkit
PatchInteractionModel< CloudType > Class Template Reference

Templated patch interaction model class. More...

#include <lagrangianIntermediate/PatchInteractionModel.H>


Detailed Description

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

List of all members.

Public Types

enum  interactionType { itRebound, itStick, itEscape, itOther }

Public Member Functions

 TypeName ("PatchInteractionModel")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, PatchInteractionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table.
 PatchInteractionModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from components.
virtual ~PatchInteractionModel ()
 Destructor.
const CloudType & owner () const
 Return the owner cloud object.
const dictionarydict () const
 Return the dictionary.
const dictionarycoeffDict () const
 Return the coefficients dictionary.
virtual bool active () const =0
 Flag to indicate whether model activates patch interaction model.
virtual bool correct (const polyPatch &pp, const label faceId, bool &keepParticle, bool &active, vector &U) const =0
 Apply velocity correction.

Static Public Member Functions

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

Static Public Attributes

static wordList interactionTypeNames_

Member Enumeration Documentation

Enumerator:
itRebound 
itStick 
itEscape 
itOther 

Definition at line 61 of file PatchInteractionModel.H.


Constructor & Destructor Documentation

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

Construct from components.

Definition at line 106 of file PatchInteractionModel.C.

~PatchInteractionModel ( )
virtual

Destructor.

Definition at line 121 of file PatchInteractionModel.C.


Member Function Documentation

TypeName ( "PatchInteractionModel< CloudType >"  )

Runtime type information.

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

Declare runtime constructor selection table.

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

Return the owner cloud object.

Definition at line 129 of file PatchInteractionModel.C.

const Foam::dictionary & dict ( ) const

Return the dictionary.

Definition at line 136 of file PatchInteractionModel.C.

const Foam::dictionary & coeffDict ( ) const

Return the coefficients dictionary.

Definition at line 144 of file PatchInteractionModel.C.

Foam::word interactionTypeToWord ( const interactionType itEnum)
static

Convert interaction result to word.

Definition at line 43 of file PatchInteractionModel.C.

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

Convert word to interaction result.

Definition at line 79 of file PatchInteractionModel.C.

virtual bool active ( ) const
pure virtual

Flag to indicate whether model activates patch interaction model.

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

virtual bool correct ( const polyPatch pp,
const label  faceId,
bool &  keepParticle,
bool &  active,
vector U 
) const
pure virtual

Apply velocity correction.

Returns true if particle remains in same cell

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


Member Data Documentation

Foam::wordList interactionTypeNames_
static

Definition at line 69 of file PatchInteractionModel.H.


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