src/mesh/cfMesh/utilities/meshes/polyMeshGenAddressing/polyMeshGenAddressing.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | cfMesh: A library for mesh generation
   4    \\    /   O peration     |
   5     \\  /    A nd           | Author: Franjo Juretic (franjo.juretic@c-fields.com)
   6      \\/     M anipulation  | Copyright (C) Creative Fields, Ltd.
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of cfMesh.
  10
  11     cfMesh is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     cfMesh 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 cfMesh.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     polyMeshGenAddressing
  26
  27 Description
  28     Cell-face mesh analysis engine
  29
  30 SourceFiles
  31     polyMeshGenAddressing.C
  32     polyMeshGenAddressingClear.C
  33     polyMeshGenAddressingCellCells.C
  34     polyMeshGenAddressingEdgeCells.C
  35     polyMeshGenAddressingPointCells.C
  36     polyMeshGenAddressingCells.C
  37     polyMeshGenAddressingEdgeFaces.C
  38     polyMeshGenAddressingPointFaces.C
  39     polyMeshGenAddressingCellEdges.C
  40     polyMeshGenAddressingPointEdges.C
  41     polyMeshGenAddressingPointPoints.C
  42     polyMeshGenAddressingEdges.C
  43     polyMeshGenAddressingCellCentresAndVols.C
  44     polyMeshGenAddressingFaceCentresAndAreas.C
  45     polyMeshGenAddressingUpdateGeometry.C
  46     polyMeshGenAddressingParallelAddressing.C
  47
  48 \*---------------------------------------------------------------------------*/
  49
  50 #ifndef polyMeshGenAddressing_H
  51 #define polyMeshGenAddressing_H
  52
  53 #include "edgeList.H"
  54 #include "polyMeshGenCells.H"
  55 #include "boolList.H"
  56 #include "HashSet.H"
  57 #include "DynList.H"
  58 #include "Map.H"
  59 #include "VRWGraph.H"
  60
  61 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  62
  63 namespace Foam
  64 {
  65
  66 /*---------------------------------------------------------------------------*\
  67                     Class polyMeshGenAddressing Declaration
  68 \*---------------------------------------------------------------------------*/
  69
  70 class polyMeshGenAddressing
  71 {
  72     // Mesh data
  73
  74         //- reference to the mesh
  75         const polyMeshGenCells& mesh_;
  76
  77     // Shapes
  78
  79         //- Edges
  80         mutable edgeList* edgesPtr_;
  81
  82
  83     // Connectivity
  84
  85         //- Cell-cells
  86         mutable VRWGraph* ccPtr_;
  87
  88         //- Edge-cells
  89         mutable VRWGraph* ecPtr_;
  90
  91         //- Point-cells
  92         mutable VRWGraph* pcPtr_;
  93
  94         //- Edge-faces
  95         mutable VRWGraph* efPtr_;
  96
  97         //- Point-faces
  98         mutable VRWGraph* pfPtr_;
  99
 100         //- Cell-edges
 101         mutable VRWGraph* cePtr_;
 102
 103         //- Face-edges
 104         mutable VRWGraph* fePtr_;
 105
 106         //- Point-edges
 107         mutable VRWGraph* pePtr_;
 108
 109         //- Point-points
 110         mutable VRWGraph* ppPtr_;
 111
 112         //- Cell-points
 113         mutable VRWGraph* cpPtr_;
 114
 115
 116     // Geometric data
 117
 118         //- Cell centres
 119         mutable vectorField* cellCentresPtr_;
 120
 121         //- Face centres
 122         mutable vectorField* faceCentresPtr_;
 123
 124         //- Cell volumes
 125         mutable scalarField* cellVolumesPtr_;
 126
 127         //- Face areas
 128         mutable vectorField* faceAreasPtr_;
 129
 130     // Parallel demand driven data
 131
 132         //- global point labels
 133         mutable labelLongList* globalPointLabelPtr_;
 134
 135         //- global face labels
 136         mutable labelLongList* globalFaceLabelPtr_;
 137
 138         //- global cell labels
 139         mutable labelLongList* globalCellLabelPtr_;
 140
 141         //- global edge labels
 142         mutable labelLongList* globalEdgeLabelPtr_;
 143
 144     // Parallel addressing
 145
 146         //- processors containing a vertex
 147         mutable VRWGraph* pProcsPtr_;
 148
 149         //- global to local point adressing
 150         mutable Map<label>* globalToLocalPointAddressingPtr_;
 151
 152         //- neighbour processors sharing a point with this processor
 153         mutable DynList<label>* pointNeiProcsPtr_;
 154
 155         //- processors containing an edge
 156         mutable VRWGraph* eProcsPtr_;
 157
 158         //- global to local edge addressing
 159         mutable Map<label>* globalToLocalEdgeAddressingPtr_;
 160
 161         //- neighbour processors sharing an edge with the current processor
 162         mutable DynList<label>* edgeNeiProcsPtr_;
 163
 164
 165     // Private member functions
 166
 167         //- Disallow construct as copy
 168         polyMeshGenAddressing(const polyMeshGenAddressing&);
 169
 170         //- Disallow default bitwise assignment
 171         void operator=(const polyMeshGenAddressing&);
 172
 173
 174     // Private member functions to calculate demand driven data
 175
 176     // Topological calculations
 177
 178         //- Calculate cell-cell addressing
 179         void calcCellCells() const;
 180
 181         //- Calculate cell-edge addressing
 182         void calcEdgeCells() const;
 183
 184         //- Calculate point-cell addressing
 185         void calcPointCells() const;
 186
 187         //- Calculate edge-face addressing
 188         void calcEdgeFaces() const;
 189
 190         //- Calculate face-edge addressing
 191         void calcFaceEdges() const;
 192
 193         //- Calculate point-face addressing
 194         void calcPointFaces() const;
 195
 196         //- Calculate edge list
 197         void calcCellEdges() const;
 198
 199         //- Calculate point-edge addressing
 200         void calcPointEdges() const;
 201
 202         //- Calculate point-point addressing
 203         void calcPointPoints() const;
 204
 205         //- Calculate cell-point addressing
 206         void calcCellPoints() const;
 207
 208         //- During edge calculation, a larger set of data is assembled.
 209         // Create and destroy as a set, using clearOutEdges()
 210         void calcEdges() const;
 211         void clearOutEdges();
 212
 213     // Parallel calculations
 214
 215         //- calculate global point labels
 216         void calcGlobalPointLabels() const;
 217
 218         //- calculate global face labels
 219         void calcGlobalFaceLabels() const;
 220
 221         //- calculate global cell labels
 222         void calcGlobalCellLabels() const;
 223
 224         //- calculate global edge labels
 225         void calcGlobalEdgeLabels() const;
 226
 227     // Geometrical calculations
 228
 229         //- Calculate face centres and areas
 230         void calcFaceCentresAndAreas() const;
 231         void makeFaceCentresAndAreas
 232         (
 233             const pointFieldPMG& p,
 234             vectorField& fCtrs,
 235             vectorField& fAreas
 236         ) const;
 237
 238         //- Calculate cell centres and volumes
 239         void calcCellCentresAndVols() const;
 240         void makeCellCentresAndVols
 241         (
 242             const vectorField& fCtrs,
 243             const vectorField& fAreas,
 244             vectorField& cellCtrs,
 245             scalarField& cellVols
 246         ) const;
 247
 248         //- Calculate edge vectors
 249         void calcEdgeVectors() const;
 250
 251     // Disallow bitwise construct
 252         //- Default constructor
 253         polyMeshGenAddressing();
 254
 255 public:
 256
 257         // Static data
 258
 259             ClassName("polyMeshGenAddressing");
 260
 261 /*            //- Estimated number of cells per edge
 262             static const unsigned cellsPerEdge_ = 4;
 263
 264             //- Estimated number of cells per point
 265             static const unsigned cellsPerPoint_ = 8;
 266
 267             //- Estimated number of faces per cell
 268             static const unsigned facesPerCell_ = 6;
 269
 270             //- Estimated number of faces per edge
 271             static const unsigned facesPerEdge_ = 4;
 272
 273             //- Estimated number of faces per point
 274             static const unsigned facesPerPoint_ = 12;
 275
 276             //- Estimated number of edges per cell
 277             static const unsigned edgesPerCell_ = 12;
 278
 279             //- Estimated number of edges per cell
 280             static const unsigned edgesPerFace_ = 4;
 281
 282             //- Estimated number of edges per point
 283             static const unsigned edgesPerPoint_ = 6;
 284
 285             //- Estimated number of points per cell
 286             static const unsigned pointsPerCell_ = 8;
 287
 288             //- Estimated number of points per face
 289             static const unsigned pointsPerFace_ = 4;
 290 */
 291     // Constructors
 292
 293         //- Construct from components
 294         polyMeshGenAddressing(const polyMeshGenCells& mesh);
 295
 296
 297     // Destructor
 298
 299         ~polyMeshGenAddressing();
 300
 301
 302     // Member Functions
 303
 304         // Primitive mesh data
 305
 306             //- Return mesh edges
 307             const edgeList& edges() const;
 308
 309         // Return mesh connectivity
 310
 311             const VRWGraph& cellCells() const;
 312             // faceCells given as faceOwner and faceNeighbour
 313             const VRWGraph& edgeCells() const;
 314             const VRWGraph& pointCells() const;
 315
 316             // faceFaces considered unnecessary
 317             const VRWGraph& edgeFaces() const;
 318             const VRWGraph& pointFaces() const;
 319
 320             const VRWGraph& cellEdges() const;
 321             const VRWGraph& faceEdges() const;
 322             // edgeEdges considered unnecessary
 323             const VRWGraph& pointEdges() const;
 324             const VRWGraph& pointPoints() const;
 325             const VRWGraph& cellPoints() const;
 326
 327         // Parallel addressing
 328
 329             const labelLongList& globalPointLabel() const;
 330             const labelLongList& globalFaceLabel() const;
 331             const labelLongList& globalCellLabel() const;
 332             const labelLongList& globalEdgeLabel() const;
 333
 334             const VRWGraph& pointAtProcs() const;
 335             const Map<label>& globalToLocalPointAddressing() const;
 336             const DynList<label>& pointNeiProcs() const;
 337             const VRWGraph& edgeAtProcs() const;
 338             const Map<label>& globalToLocalEdgeAddressing() const;
 339             const DynList<label>& edgeNeiProcs() const;
 340
 341         // Geometric data (raw!)
 342
 343             const vectorField& cellCentres() const;
 344             const vectorField& faceCentres() const;
 345             const scalarField& cellVolumes() const;
 346             const vectorField& faceAreas() const;
 347
 348     //  Storage management
 349
 350         //- Print a list of all the currently allocated mesh data
 351         void printAllocated() const;
 352
 353         //- Clear geometry
 354         void clearGeom();
 355
 356         //- Clear topological data
 357         void clearAddressing();
 358
 359         //- Clear parallel addressing
 360         void clearParallelAddressing();
 361
 362         //- Clear all geometry and addressing unnecessary for CFD
 363         void clearOut();
 364
 365         //- Clear everything primitive, geometry and addressing
 366         void clearAll();
 367
 368     // Update geometry data
 369         void updateGeometry(const boolList& changedFace);
 370 };
 371
 372
 373 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 374
 375 } // End namespace Foam
 376
 377 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 378
 379 #endif
 380
 381 // ************************************************************************* //