src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/Rebound/Rebound.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::Rebound
  27
  28 Description
  29     Simple rebound patch interaction model
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef Rebound_H
  34 #define Rebound_H
  35
  36 #include "PatchInteractionModel.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42 /*---------------------------------------------------------------------------*\
  43                            Class Rebound Declaration
  44 \*---------------------------------------------------------------------------*/
  45
  46 template<class CloudType>
  47 class Rebound
  48 :
  49     public PatchInteractionModel<CloudType>
  50 {
  51     // Private data
  52
  53        //- Factor applied to velocity on rebound
  54        //  Normal rebound = 1
  55        scalar UFactor_;
  56
  57
  58 public:
  59
  60     //- Runtime type information
  61     TypeName("Rebound");
  62
  63
  64     // Constructors
  65
  66         //- Construct from dictionary
  67         Rebound(const dictionary& dict, CloudType& cloud);
  68
  69
  70     //- Destructor
  71     virtual ~Rebound();
  72
  73
  74     // Member Functions
  75
  76         //- Flag to indicate whether model activates patch interaction model
  77         virtual bool active() const;
  78
  79         //- Apply velocity correction
  80         //  Returns true if particle remains in same cell
  81         virtual bool correct
  82         (
  83             const polyPatch& pp,
  84             const label faceId,
  85             bool& keepParticle,
  86             vector& U
  87         ) const;
  88 };
  89
  90
  91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  92
  93 } // End namespace Foam
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 #ifdef NoRepository
  98 #   include "Rebound.C"
  99 #endif
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 #endif
 104
 105 // ************************************************************************* //