src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::StandardWallInteraction
  27
  28 Description
  29     Wall interaction model. Three choices:
  30     - rebound - optionally specify elasticity and resitution coefficients
  31     - stick   - particles assigined zero velocity
  32     - escape  - remove particle from the domain
  33
  34     Example usage:
  35
  36         StandardWallInteractionCoeffs
  37         {
  38             type        rebound; // stick, escape
  39             e           1;       // optional - elasticity coeff
  40             mu          0;       // optional - restitution coeff
  41         }
  42
  43 \*---------------------------------------------------------------------------*/
  44
  45 #ifndef StandardWallInteraction_H
  46 #define StandardWallInteraction_H
  47
  48 #include "PatchInteractionModel.H"
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54 /*---------------------------------------------------------------------------*\
  55                    Class StandardWallInteraction Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 template<class CloudType>
  59 class StandardWallInteraction
  60 :
  61     public PatchInteractionModel<CloudType>
  62 {
  63 protected:
  64
  65     // Protected data
  66
  67         //- Interaction type
  68         typename PatchInteractionModel<CloudType>::interactionType
  69             interactionType_;
  70
  71         //- Elasticity coefficient
  72         scalar e_;
  73
  74         //- Restitution coefficient
  75         scalar mu_;
  76
  77
  78 public:
  79
  80     //- Runtime type information
  81     TypeName("StandardWallInteraction");
  82
  83
  84     // Constructors
  85
  86         //- Construct from dictionary
  87         StandardWallInteraction(const dictionary& dict, CloudType& cloud);
  88
  89
  90     //- Destructor
  91     virtual ~StandardWallInteraction();
  92
  93
  94     // Member Functions
  95
  96         //- Flag to indicate whether model activates patch interaction model
  97         virtual bool active() const;
  98
  99         //- Apply velocity correction
 100         //  Returns true if particle remains in same cell
 101         virtual bool correct
 102         (
 103             const polyPatch& pp,
 104             const label faceId,
 105             bool& keepParticle,
 106             vector& U
 107         ) const;
 108 };
 109
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 } // End namespace Foam
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 #ifdef NoRepository
 118 #   include "StandardWallInteraction.C"
 119 #endif
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 #endif
 124
 125 // ************************************************************************* //