src/mesh/cfMesh/meshLibrary/utilities/octrees/meshOctree/meshOctreeCube/meshOctreeCube.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     meshOctreeCube
  26
  27 Description
  28     A cube stores information needed for mesh generation
  29
  30 SourceFiles
  31     meshOctreeCube.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef meshOctreeCube_H
  36 #define meshOctreeCube_H
  37
  38 #include "DynList.H"
  39 #include "LongList.H"
  40 #include "boolList.H"
  41 #include "meshOctreeCubeBasic.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 class Ostream;
  49 class triSurf;
  50 class VRWGraph;
  51 class meshOctreeSlot;
  52
  53 /*---------------------------------------------------------------------------*\
  54                     Class meshOctreeCube Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class meshOctreeCube
  58 : public meshOctreeCubeBasic
  59 {
  60     // Private data
  61         //- pointer the slot containing this cube
  62         meshOctreeSlot* activeSlotPtr_;
  63
  64         //- pointer to the first child element
  65         meshOctreeCube** subCubesPtr_;
  66
  67         //- position of the cube in the list of leaves
  68         mutable label cubeLabel_;
  69
  70         //- label of the row which contains elements contained in the cube
  71         label containedElementsLabel_;
  72
  73         //- labels of contained surface edges
  74         label containedEdgesLabel_;
  75
  76     // Static data
  77         //- this data is needed to map the the current refinement pattern
  78         //- to the Hilbert space-filling curve in order to reduce the bandwidth
  79         //- in the list of leaves. The procedure is performed using the table
  80         //- published in (Campbell etal: Dynamic Octree Load Balancing Using
  81         //- Space-Filling Curves) which is adjusted to the current ref pattern
  82         static const label hOrder_[24][8];
  83
  84         //- orientation of the Hilbert curve in the refined cubes of a cube
  85         //- with the ordering in the above table
  86         static const label hOrient_[24][8];
  87
  88     // Private member functions
  89         //- find edges contained in the cube
  90         void findContainedEdges
  91         (
  92             const triSurf&,
  93             const boundBox&
  94         );
  95
  96         //- store data which is contained in the child cube
  97         //- this is needed for parallel coarsening of the octree
  98         //inline void reclaimDataFromChild(const label scI);
  99
 100         //- Disallow default bitwise copy construct
 101         meshOctreeCube(const meshOctreeCube&);
 102
 103         //- Disallow copy construct from meshOctreeCubeBasic
 104         meshOctreeCube(const meshOctreeCubeBasic&);
 105
 106 public:
 107
 108     // Constructors
 109
 110         //- Default constructor
 111         inline meshOctreeCube();
 112
 113         //- Construct from coordinates
 114         meshOctreeCube(const meshOctreeCubeCoordinates&);
 115
 116         //- Construct from coordinates and the number of surface triangles
 117         //- this constructor is used for the initial cube, only
 118         meshOctreeCube
 119         (
 120             const meshOctreeCubeCoordinates& cc,
 121             const label nElmts,
 122             meshOctreeSlot* slotPtr
 123         );
 124
 125     // Destructor
 126
 127         ~meshOctreeCube();
 128
 129     // Member Functions
 130
 131         //- refine cube in two directions, it is used for generating quadtrees
 132         void refineCube2D
 133         (
 134             const triSurf&,
 135             const boundBox&,
 136             meshOctreeSlot* slotPtr = NULL
 137         );
 138
 139         //- subdivide the octree cube
 140         void refineCube
 141         (
 142             const triSurf&,
 143             const boundBox&,
 144             meshOctreeSlot* slotPtr = NULL
 145         );
 146
 147         //- create missing child cubes and refine them until the required
 148         //- cube is reached (this function is used for parallel octree creation)
 149         void refineMissingCube
 150         (
 151             const triSurf&,
 152             const boundBox&,
 153             const label scI,
 154             meshOctreeSlot* slotPtr = NULL
 155         );
 156
 157         //- create missing child cubes and refine them until the required
 158         //- cube is reached (this function is used for parallel octree creation)
 159         //- contained elements and edges are provided as argument
 160         void refineMissingCube
 161         (
 162             const label scI,
 163             const label elementsRowI = -1,
 164             const label edgesRowI = -1,
 165             meshOctreeSlot* slotPtr = NULL
 166         );
 167
 168         //- return the pointer to the slot containing the cube
 169         inline const meshOctreeSlot* slotPtr() const;
 170
 171         //- position of the cube in the list of leaves
 172         inline label cubeLabel() const;
 173
 174         //- check if the cube is a leaf
 175         inline bool isLeaf() const;
 176
 177         //- return a pointer to a child cubes at given position
 178         inline meshOctreeCube* subCube(const label) const;
 179
 180         //- return the pointers to the sons
 181         FixedList<meshOctreeCube*, 8> subCubes() const;
 182
 183         //- check if this box has some contained triangles
 184         bool hasContainedTriangles
 185         (
 186             const triSurf&,
 187             const boundBox&,
 188             const VRWGraph& containedElements
 189         ) const;
 190
 191         //- return true if the box contains some triangles
 192         inline bool hasContainedElements() const;
 193
 194         //- returns the list of contained surface elements
 195         //- this list is only allocated for cubes containing elements
 196         inline label containedElements() const;
 197
 198         //- returns true if the box contains some edges
 199         inline bool hasContainedEdges() const;
 200
 201         //- returns the list of contained surface edges
 202         //- this list is only allocated for cubes containing edges
 203         inline label containedEdges() const;
 204
 205     // Recursive functions
 206         //- leaves contained in the given box
 207         void leavesInBox
 208         (
 209             const boundBox& rootBox,
 210             const boundBox& searchingBox,
 211             DynList<const meshOctreeCube*, 256>&
 212         ) const;
 213
 214         //- find leaves for a given cube
 215         void findLeaves
 216         (
 217             LongList<meshOctreeCube*>& leaves
 218         ) const;
 219
 220         //- find coordinates of cubes which are located on other processors
 221         void findCoordinatesOfMissingCubes
 222         (
 223             LongList<meshOctreeCubeCoordinates>& coordinates
 224         ) const;
 225
 226         //- count number of originating from this cube
 227         void countChildCubes(label& nCubes) const;
 228
 229         //- delete boxes which are not local to the given processor
 230         bool purgeProcessorCubes(const short procNo);
 231
 232     // Member operators
 233
 234         //- assignment
 235         inline void operator=(const meshOctreeCube&);
 236         friend Ostream& operator<<(Ostream&, const meshOctreeCube&);
 237 };
 238
 239
 240 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 241
 242 } // End namespace Foam
 243
 244 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 245
 246 #include "meshOctreeCubeI.H"
 247
 248 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 249
 250 #endif
 251
 252 // ************************************************************************* //