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) 2011-2015 OpenFOAM Foundation
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 "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 Xfer<labelListList>& subParticleMap,
71  const Xfer<labelListList>& constructParticleMap,
73  )
74  :
75  particleMap_(nNewParticles, subParticleMap, constructParticleMap),
76  constructCellLabels_(constructCellLabels)
77  {}
78 
79 
80  // Member Functions
81 
82  // Access
83 
84  //- Distribution map
85  const mapDistribute& particleMap() const
86  {
87  return particleMap_;
88  }
89 
90  //- Per received particle the destination cell label
91  const labelListList& constructCellLabels() const
92  {
93  return constructCellLabels_;
94  }
95 
96 
97  // Edit
98 
99  //- Distribute list of lagrangian data
100  template<class T>
101  void distributeLagrangianData(List<T>& lst) const
102  {
103  particleMap_.distribute(lst);
104  }
105 
106  //- Correct for topo change.
107  void updateMesh(const mapPolyMesh&)
108  {
110  (
111  "mapDistributeLagrangian::updateMesh(const mapPolyMesh&)"
112  );
113  }
114 };
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************************************************************* //
static void distribute(const Pstream::commsTypes commsType, const List< labelPair > &schedule, const label constructSize, const labelListList &subMap, const labelListList &constructMap, List< T > &, const int tag=UPstream::msgType())
Distribute data. Note:schedule only used for Pstream::scheduled.
const mapDistribute & particleMap() const
Distribution map.
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Definition: mapPolyMesh.H:158
Class containing processor-to-processor mapping information.
A simple container for copying or transferring objects of type <T>.
Definition: Xfer.H:85
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
void updateMesh(const mapPolyMesh &)
Correct for topo change.
Namespace for OpenFOAM.
void distributeLagrangianData(List< T > &lst) const
Distribute list of lagrangian data.
const labelListList & constructCellLabels() const
Per received particle the destination cell label.
mapDistributeLagrangian(const label nNewParticles, const Xfer< labelListList > &subParticleMap, const Xfer< labelListList > &constructParticleMap, const Xfer< labelListList > &constructCellLabels)
Construct from components.
#define notImplemented(functionName)
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:356
Class containing mesh-to-mesh mapping information for particles.