src/meshLibrary/utilities/octrees/meshOctree/meshOctreeCreator/meshOctreeCreator.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     meshOctreeCreator
  26
  27 Description
  28     Creates octree for mesh generation
  29
  30 SourceFiles
  31     meshOctreeCreator.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef meshOctreeCreator_H
  36 #define meshOctreeCreator_H
  37
  38 #include "boolList.H"
  39 #include "DynList.H"
  40 #include "meshOctreeModifier.H"
  41 //#include "volFields.H"
  42 #include "patchRefinementList.H"
  43
  44 #include <map>
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 // Forward declarations
  52 class IOdictionary;
  53 class meshOctreeCube;
  54
  55 /*---------------------------------------------------------------------------*\
  56                     Class meshOctreeCreator Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class meshOctreeCreator
  60 {
  61 protected:
  62
  63     // Protected data
  64         //- Reference to meshOctree
  65         meshOctree& octree_;
  66
  67         //- Scaling factor
  68         scalar scalingFactor_;
  69
  70         //- Dictionary containing information necessary to perform refinement
  71         const IOdictionary* meshDictPtr_;
  72
  73         //- hex refinement flag
  74         bool hexRefinement_;
  75
  76 private:
  77     // Private member functions
  78
  79     // Octree refinement
  80         //- refine boxes contained inside the objects for refinement
  81         void refineBoxesContainedInObjects();
  82
  83         //- refine boxes near DATA boxes to get a nice smooth surface
  84         void refineBoxesNearDataBoxes(const direction nLayers = 1);
  85
  86         //- refine boxes of the given flag to the given size
  87         void refineBoxes(const direction refLevel, const direction cubeType);
  88
  89         // Private octree creation methods
  90         void refineBoundary();
  91         void createInsideOutsideInformation();
  92         void refineInsideAndUnknownBoxes();
  93
  94     // Private member functions for parallel runs
  95         //- move octree cubes from one processor to another until
  96         //- each processor contains the same number of leaves
  97         //- of the required type
  98         void loadDistribution(const bool distributeUsed = false);
  99
 100         // information about octree refinement
 101         //- ref level to achieve max cell size
 102         direction globalRefLevel_;
 103
 104         //- this list contains ref level for each surface triangle
 105         List<direction> surfRefLevel_;
 106
 107         //- set the boundBox such that maxCellSize is achieved
 108         void setRootCubeSizeAndRefParameters();
 109
 110     // Private copy constructor
 111         //- Disallow default bitwise copy construct
 112         meshOctreeCreator(const meshOctreeCreator&);
 113
 114         //- Disallow default bitwise assignment
 115         void operator=(const meshOctreeCreator&);
 116
 117 public:
 118
 119     // Constructors
 120
 121         //- construct from meshOctree
 122         meshOctreeCreator(meshOctree&);
 123
 124         //- Construct from meshOctree and dictionary
 125         meshOctreeCreator(meshOctree& mo, const IOdictionary& dict);
 126
 127         //- Construct from surface, dictionary and cell sizes
 128         /*        meshOctreeCreator
 129                 (
 130                     meshOctree& mo,
 131                     const IOdictionary& dict,
 132                     const volScalarField& localCellSize
 133                 );
 134         */
 135
 136     // Destructor
 137
 138         ~meshOctreeCreator();
 139
 140
 141     // Member Functions
 142         //- set the scaling factor
 143         void setScalingFactor(const scalar);
 144
 145         //- activate octree refinement which marks all sons of an octree box
 146         //- for refinement in case a single son is marked for refinement
 147         //- this type of refinement is necessary for creating hex meshes
 148         void activateHexRefinement();
 149
 150         //- create octree boxes
 151         void createOctreeBoxes();
 152
 153         //- refine boxes containing surface elements
 154         //- this is used for proximity searches
 155         void createOctreeWithRefinedBoundary
 156         (
 157             const direction maxLevel,
 158             const label nTrianglesInLeaf = 15
 159         );
 160 };
 161
 162
 163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 164
 165 } // End namespace Foam
 166
 167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 168
 169 #endif
 170
 171 // ************************************************************************* //