src/autoMesh/autoHexMesh/autoHexMeshDriver/refinementParameters/refinementParameters.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::refinementParameters
  27
  28 Description
  29     Simple container to keep together refinement specific information.
  30
  31 SourceFiles
  32     refinementParameters.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef refinementParameters_H
  37 #define refinementParameters_H
  38
  39 #include "dictionary.H"
  40 #include "pointField.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Class forward declarations
  48 class polyMesh;
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class refinementParameters Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class refinementParameters
  55 {
  56     // Private data
  57
  58         //- Total number of cells
  59         const label maxGlobalCells_;
  60
  61         //- Per processor max number of cells
  62         const label maxLocalCells_;
  63
  64         //- When to stop refining
  65         const label minRefineCells_;
  66
  67         //- Curvature
  68         scalar curvature_;
  69
  70         //- Number of layers between different refinement levels
  71         const label nBufferLayers_;
  72
  73         //- Areas to keep
  74         const pointField keepPoints_;
  75
  76
  77     // Private Member Functions
  78
  79         //- Disallow default bitwise copy construct
  80         refinementParameters(const refinementParameters&);
  81
  82         //- Disallow default bitwise assignment
  83         void operator=(const refinementParameters&);
  84
  85
  86 public:
  87
  88     // Constructors
  89
  90         //- Construct from dictionary - old syntax
  91         refinementParameters(const dictionary& dict, const label dummy);
  92
  93         //- Construct from dictionary - new syntax
  94         refinementParameters(const dictionary& dict);
  95
  96
  97     // Member Functions
  98
  99         // Access
 100
 101             //- Total number of cells
 102             label maxGlobalCells() const
 103             {
 104                 return maxGlobalCells_;
 105             }
 106
 107             //- Per processor max number of cells
 108             label maxLocalCells() const
 109             {
 110                 return maxLocalCells_;
 111             }
 112
 113             //- When to stop refining
 114             label minRefineCells() const
 115             {
 116                 return minRefineCells_;
 117             }
 118
 119             //- Curvature
 120             scalar curvature() const
 121             {
 122                 return curvature_;
 123             }
 124
 125             //- Number of layers between different refinement levels
 126             label nBufferLayers() const
 127             {
 128                 return nBufferLayers_;
 129             }
 130
 131             //- Areas to keep
 132             const pointField& keepPoints() const
 133             {
 134                 return keepPoints_;
 135             }
 136
 137
 138         // Other
 139
 140             //- Checks that cells are in mesh. Returns cells they are in.
 141             labelList findCells(const polyMesh&) const;
 142
 143 };
 144
 145
 146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 147
 148 } // End namespace Foam
 149
 150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 151
 152 #endif
 153
 154 // ************************************************************************* //