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 (C) 2008-2011 OpenCFD Ltd.
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::Rebound
  26
  27 Description
  28     Simple rebound patch interaction model
  29
  30 \*---------------------------------------------------------------------------*/
  31
  32 #ifndef Rebound_H
  33 #define Rebound_H
  34
  35 #include "PatchInteractionModel.H"
  36
  37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  38
  39 namespace Foam
  40 {
  41 /*---------------------------------------------------------------------------*\
  42                            Class Rebound Declaration
  43 \*---------------------------------------------------------------------------*/
  44
  45 template<class CloudType>
  46 class Rebound
  47 :
  48     public PatchInteractionModel<CloudType>
  49 {
  50     // Private data
  51
  52        //- Factor applied to velocity on rebound
  53        //  Normal rebound = 1
  54        scalar UFactor_;
  55
  56
  57 public:
  58
  59     //- Runtime type information
  60     TypeName("rebound");
  61
  62
  63     // Constructors
  64
  65         //- Construct from dictionary
  66         Rebound(const dictionary& dict, CloudType& cloud);
  67
  68         //- Construct copy
  69         Rebound(const Rebound<CloudType>& pim);
  70
  71         //- Construct and return a clone
  72         virtual autoPtr<PatchInteractionModel<CloudType> > clone() const
  73         {
  74             return autoPtr<PatchInteractionModel<CloudType> >
  75             (
  76                 new Rebound<CloudType>(*this)
  77             );
  78         }
  79
  80
  81     //- Destructor
  82     virtual ~Rebound();
  83
  84
  85     // Member Functions
  86         //- Apply velocity correction
  87         //  Returns true if particle remains in same cell
  88         virtual bool correct
  89         (
  90             typename CloudType::parcelType& p,
  91             const polyPatch& pp,
  92             bool& keepParticle,
  93             const scalar trackFraction,
  94             const tetIndices& tetIs
  95         );
  96 };
  97
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 } // End namespace Foam
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #ifdef NoRepository
 106 #   include "Rebound.C"
 107 #endif
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #endif
 112
 113 // ************************************************************************* //