All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ProcessorTopology.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-2019 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::ProcessorTopology
26 
27 Description
28  Determines processor-processor connection. After instantiation contains
29  on all processors the processor-processor connection table.
30 
31  *this[proci] gives the list of neighbouring processors.
32 
33  TODO: This does not currently correctly support multiple processor
34  patches connecting two processors.
35 
36 SourceFiles
37  ProcessorTopology.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef ProcessorTopology_H
42 #define ProcessorTopology_H
43 
44 #include "labelList.H"
45 #include "lduSchedule.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class ProcessorTopology Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 template<class Container, class ProcPatch>
58 :
59  public labelListList
60 {
61  // Private Data
62 
63  //- Local map from neighbour proc to patchi. Different per processor!
64  // -1 or patchi for connection to procID
65  labelList procPatchMap_;
66 
67  //- Order in which the patches should be initialised/evaluated
68  // corresponding to the schedule
69  lduSchedule patchSchedule_;
70 
71 
72  // Private Member Functions
73 
74  //- Return all neighbouring processors of this processor. Set
75  // procPatchMap_.
76  labelList procNeighbours(const label nProcs, const Container&);
77 
78 public:
79 
80  // Constructors
81 
82  //- Construct from boundaryMesh
83  ProcessorTopology(const Container& patches, const label comm);
84 
85 
86  // Member Functions
87 
88  //- From neighbour processor to index in boundaryMesh. Local information
89  // (so not same over all processors)
90  const labelList& procPatchMap() const
91  {
92  return procPatchMap_;
93  }
94 
95  //- Order in which the patches should be initialised/evaluated
96  // corresponding to the schedule
97  const lduSchedule& patchSchedule() const
98  {
99  return patchSchedule_;
100  }
101 
102  //- Calculate non-blocking (i.e. unscheduled) schedule
103  static lduSchedule nonBlockingSchedule(const Container& patches);
104 
105 };
106 
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 } // End namespace Foam
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 #ifdef NoRepository
115  #include "ProcessorTopology.C"
116 #endif
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #endif
121 
122 // ************************************************************************* //
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
const lduSchedule & patchSchedule() const
Order in which the patches should be initialised/evaluated.
patches[0]
Determines processor-processor connection. After instantiation contains on all processors the process...
ProcessorTopology(const Container &patches, const label comm)
Construct from boundaryMesh.
const labelList & procPatchMap() const
From neighbour processor to index in boundaryMesh. Local information.
static lduSchedule nonBlockingSchedule(const Container &patches)
Calculate non-blocking (i.e. unscheduled) schedule.
Namespace for OpenFOAM.