lagrangianDistributionMap.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2022 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::lagrangianDistributionMap
26 
27 Description
28  Class containing mesh-to-mesh mapping information for particles
29 
30 SourceFiles
31  lagrangianDistributionMap.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef lagrangianDistributionMap_H
36 #define lagrangianDistributionMap_H
37 
38 #include "distributionMap.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class lagrangianDistributionMap Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 {
51  // Private Data
52 
53  //- Map to distribute particles
54  const distributionMap particleMap_;
55 
56  //- Per element in subsetted mesh the cell label
57  const labelListList constructCellLabels_;
58 
59 
60 public:
61 
62  // Constructors
63 
64  //- Construct from components
66  (
67  const label nNewParticles,
68  labelListList&& subParticleMap,
69  labelListList&& constructParticleMap,
71  )
72  :
73  particleMap_(nNewParticles, subParticleMap, constructParticleMap),
74  constructCellLabels_(constructCellLabels)
75  {}
76 
77 
78  // Member Functions
79 
80  // Access
81 
82  //- Distribution map
83  const distributionMap& particleMap() const
84  {
85  return particleMap_;
86  }
87 
88  //- Per received particle the destination cell label
89  const labelListList& constructCellLabels() const
90  {
91  return constructCellLabels_;
92  }
93 
94 
95  // Edit
96 
97  //- Distribute list of lagrangian data
98  template<class T>
99  void distributeLagrangianData(List<T>& lst) const
100  {
101  particleMap_.distribute(lst);
102  }
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
const distributionMap & particleMap() const
Distribution map.
Class containing mesh-to-mesh mapping information for particles.
void distribute(List< T > &fld, const bool dummyTransform=true, const int tag=UPstream::msgType()) const
Distribute data using default commsType.
const labelListList & constructCellLabels() const
Per received particle the destination cell label.
Class containing processor-to-processor mapping information.
void distributeLagrangianData(List< T > &lst) const
Distribute list of lagrangian data.
lagrangianDistributionMap(const label nNewParticles, labelListList &&subParticleMap, labelListList &&constructParticleMap, labelListList &&constructCellLabels)
Construct from components.
Namespace for OpenFOAM.