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

Wall interaction model. Three choices: More...

#include <lagrangianIntermediate/StandardWallInteraction.H>


Detailed Description

template<class CloudType>
class Foam::StandardWallInteraction< CloudType >

Wall interaction model. Three choices:

- rebound - optionally specify elasticity and resitution coefficients

  • stick - particles assigined zero velocity
  • escape - remove particle from the domain

Example usage:

StandardWallInteractionCoeffs { typerebound; // stick, escape e 1; // optional - elasticity coeff mu 0; // optional - restitution coeff }

Definition at line 58 of file StandardWallInteraction.H.

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

List of all members.

Public Member Functions

 TypeName ("StandardWallInteraction")
 Runtime type information.
 StandardWallInteraction (const dictionary &dict, CloudType &cloud)
 Construct from dictionary.
virtual ~StandardWallInteraction ()
 Destructor.
virtual bool active () const
 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
 Apply velocity correction.
- Public Member Functions inherited from PatchInteractionModel< CloudType >
 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.

Protected Attributes

PatchInteractionModel
< CloudType >::interactionType 
interactionType_
 Interaction type.
scalar e_
 Elasticity coefficient.
scalar mu_
 Restitution coefficient.

Additional Inherited Members

- Public Types inherited from PatchInteractionModel< CloudType >
enum  interactionType { itRebound, itStick, itEscape, itOther }
- Static Public Member Functions inherited from PatchInteractionModel< CloudType >
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 inherited from PatchInteractionModel< CloudType >
static wordList interactionTypeNames_

Constructor & Destructor Documentation

StandardWallInteraction ( const dictionary dict,
CloudType &  cloud 
)

Construct from dictionary.

Definition at line 32 of file StandardWallInteraction.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, and FatalErrorIn.

Destructor.

Definition at line 82 of file StandardWallInteraction.C.


Member Function Documentation

TypeName ( "StandardWallInteraction< CloudType >"  )

Runtime type information.

bool active ( ) const
virtual

Flag to indicate whether model activates patch interaction model.

Implements PatchInteractionModel< CloudType >.

Definition at line 89 of file StandardWallInteraction.C.

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

Apply velocity correction.

Returns true if particle remains in same cell

Implements PatchInteractionModel< CloudType >.

Definition at line 97 of file StandardWallInteraction.C.

References Foam::abort(), Foam::endl(), polyPatch::faceAreas(), Foam::FatalError, FatalErrorIn, Foam::mag(), and polyPatch::whichFace().


Member Data Documentation

PatchInteractionModel<CloudType>::interactionType interactionType_
protected

Interaction type.

Definition at line 68 of file StandardWallInteraction.H.

scalar e_
protected

Elasticity coefficient.

Definition at line 71 of file StandardWallInteraction.H.

scalar mu_
protected

Restitution coefficient.

Definition at line 74 of file StandardWallInteraction.H.


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