src/OpenFOAM/meshes/ProcessorTopology/ProcessorTopology.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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 Patch, class ProcPatch>
  57 class ProcessorTopology
  58 :
  59     public labelListList
  60 {
  61
  62 private:
  63
  64     // Private data
  65
  66         //- Local map from neighbour proc to patchI. Different per processor!
  67         //  -1 or patchI for connection to procID
  68         labelList procPatchMap_;
  69
  70         //- Order in which the patches should be initialised/evaluated
  71         //  corresponding to the schedule
  72         lduSchedule patchSchedule_;
  73
  74
  75     // Private Member Functions
  76
  77         //- Return all neighbouring processors of this processor. Set
  78         //  procPatchMap_.
  79         labelList procNeighbours(const PtrList<Patch>&);
  80
  81 public:
  82
  83     // Constructors
  84
  85         //- Construct from boundaryMesh
  86         ProcessorTopology(const PtrList<Patch>& patches);
  87
  88
  89     // Member Functions
  90
  91         //- from neighbour processor to index in boundaryMesh. Local information
  92         //  (so not same over all processors)
  93         const labelList& procPatchMap() const
  94         {
  95             return procPatchMap_;
  96         }
  97
  98         //- Order in which the patches should be initialised/evaluated
  99         //  corresponding to the schedule
 100         const lduSchedule& patchSchedule() const
 101         {
 102             return patchSchedule_;
 103         }
 104 };
 105
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 } // End namespace Foam
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 #ifdef NoRepository
 114 #   include "ProcessorTopology.C"
 115 #endif
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 #endif
 120
 121 // ************************************************************************* //