FreeFOAM The Cross-Platform CFD Toolkit
ProcessorTopology_.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::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 SourceFiles
34  ProcessorTopology.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef ProcessorTopology_H
39 #define ProcessorTopology_H
40 
41 #include <OpenFOAM/labelList.H>
42 #include <OpenFOAM/lduSchedule.H>
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class ProcessorTopology Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 template<class Patch, class ProcPatch>
55 :
56  public labelListList
57 {
58 
59 private:
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 PtrList<Patch>&);
77 
78 public:
79 
80  // Constructors
81 
82  //- Construct from boundaryMesh
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 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #ifdef NoRepository
111 # include "ProcessorTopology_.C"
112 #endif
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************ vim: set sw=4 sts=4 et: ************************ //