FreeFOAM The Cross-Platform CFD Toolkit
LocalInteraction.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2008-2010 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::LocalInteraction
26 
27 Description
28  Patch interaction specified on a patch-by-patch basis
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef LocalInteraction_H
33 #define LocalInteraction_H
34 
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 /*---------------------------------------------------------------------------*\
43  Class LocalInteraction Declaration
44 \*---------------------------------------------------------------------------*/
45 
46 template<class CloudType>
48 :
49  public PatchInteractionModel<CloudType>
50 {
51  // Private data
52 
53  //- List of participating patches
54  const List<patchInteractionData> patchData_;
55 
56  //- List of participating patch ids
57  List<label> patchIds_;
58 
59 
60  // Private member functions
61 
62  //- Returns local patchI if patch is in patchIds_ list
63  label applyToPatch(const label globalPatchI) const;
64 
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("LocalInteraction");
71 
72 
73  // Constructors
74 
75  //- Construct from dictionary
76  LocalInteraction(const dictionary& dict, CloudType& cloud);
77 
78 
79  //- Destructor
80  virtual ~LocalInteraction();
81 
82 
83  // Member Functions
84 
85  //- Flag to indicate whether model activates patch interaction model
86  virtual bool active() const;
87 
88  //- Apply velocity correction
89  // Returns true if particle remains in same cell
90  virtual bool correct
91  (
92  const polyPatch& pp,
93  const label faceId,
94  bool& keepParticle,
95  bool& active,
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 // ************************ vim: set sw=4 sts=4 et: ************************ //