src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/LocalInteraction/LocalInteraction.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::LocalInteraction
  27
  28 Description
  29     Patch interaction specified on a patch-by-patch basis
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef LocalInteraction_H
  34 #define LocalInteraction_H
  35
  36 #include "PatchInteractionModel.H"
  37 #include "patchInteractionData.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43 /*---------------------------------------------------------------------------*\
  44                       Class LocalInteraction Declaration
  45 \*---------------------------------------------------------------------------*/
  46
  47 template<class CloudType>
  48 class LocalInteraction
  49 :
  50     public PatchInteractionModel<CloudType>
  51 {
  52     // Private data
  53
  54         //- List of participating patches
  55         const List<patchInteractionData> patchData_;
  56
  57         //- List of participating patch ids
  58         List<label> patchIds_;
  59
  60
  61     // Private member functions
  62
  63         //- Returns local patchI if patch is in patchIds_ list
  64         label applyToPatch(const label globalPatchI) const;
  65
  66
  67
  68 public:
  69
  70     //- Runtime type information
  71     TypeName("LocalInteraction");
  72
  73
  74     // Constructors
  75
  76         //- Construct from dictionary
  77         LocalInteraction(const dictionary& dict, CloudType& cloud);
  78
  79
  80     //- Destructor
  81     virtual ~LocalInteraction();
  82
  83
  84     // Member Functions
  85
  86         //- Flag to indicate whether model activates patch interaction model
  87         virtual bool active() const;
  88
  89         //- Apply velocity correction
  90         //  Returns true if particle remains in same cell
  91         virtual bool correct
  92         (
  93             const polyPatch& pp,
  94             const label faceId,
  95             bool& keepParticle,
  96             vector& U
  97         ) const;
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #ifdef NoRepository
 108 #   include "LocalInteraction.C"
 109 #endif
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 #endif
 114
 115 // ************************************************************************* //