FreeFOAM The Cross-Platform CFD Toolkit
mapDistributeLagrangian.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) 1991-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::mapDistributeLagrangian
26 
27 Description
28  Class containing mesh-to-mesh mapping information for particles
29 
30 SourceFiles
31  mapDistributeLagrangian.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef mapDistributeLagrangian_H
36 #define mapDistributeLagrangian_H
37 
38 #include <OpenFOAM/mapDistribute.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 class mapPolyMesh;
46 
47 /*---------------------------------------------------------------------------*\
48  Class mapDistributeLagrangian Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 {
53  // Private data
54 
55  //- Map to distribute particles
56  const mapDistribute particleMap_;
57 
58  //- Per element in subsetted mesh the cell label
59  const labelListList constructCellLabels_;
60 
61 
62 public:
63 
64  // Constructors
65 
66  //- Construct from components
68  (
69  const label nNewParticles,
70  const labelListList& subParticleMap,
71  const labelListList& constructParticleMap,
73  )
74  :
75  particleMap_(nNewParticles, subParticleMap, constructParticleMap),
76  constructCellLabels_(constructCellLabels)
77  {}
78 
79  //- Construct from components and steal storage
81  (
82  const label nNewParticles,
83  labelListList& subParticleMap,
84  labelListList& constructParticleMap,
85  labelListList& constructCellLabels,
86  const bool reUse
87  )
88  :
89  particleMap_
90  (
91  nNewParticles,
92  subParticleMap,
93  constructParticleMap,
94  reUse
95  ),
96  constructCellLabels_(constructCellLabels, reUse)
97  {}
98 
99 
100  // Member Functions
101 
102  // Access
103 
104  //- Distribution map
105  const mapDistribute& particleMap() const
106  {
107  return particleMap_;
108  }
109 
110  //- Per received particle the destination cell label
112  {
113  return constructCellLabels_;
114  }
115 
116 
117  // Edit
118 
119  //- distribute list of lagrangian data
120  template<class T>
122  {
123  particleMap_.distribute(lst);
124  }
125 
126  //- Correct for topo change.
127  void updateMesh(const mapPolyMesh&)
128  {
130  (
131  "mapDistributeLagrangian::updateMesh(const mapPolyMesh&)"
132  );
133  }
134 };
135 
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 } // End namespace Foam
140 
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 
143 #endif
144 
145 // ************************ vim: set sw=4 sts=4 et: ************************ //