src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/snapParameters/snapParameters.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::snapParameters
  26
  27 Description
  28     Simple container to keep together snap specific information.
  29
  30 SourceFiles
  31     snapParameters.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef snapParameters_H
  36 #define snapParameters_H
  37
  38 #include "dictionary.H"
  39 #include "scalar.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 // Class forward declarations
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class snapParameters Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class snapParameters
  53 {
  54     // Private data
  55
  56         const label nSmoothPatch_;
  57
  58         const scalar snapTol_;
  59
  60         const label nSmoothDispl_;
  61
  62         const label nSnap_;
  63
  64         const label nFeatureSnap_;
  65
  66
  67     // Private Member Functions
  68
  69         //- Disallow default bitwise copy construct
  70         snapParameters(const snapParameters&);
  71
  72         //- Disallow default bitwise assignment
  73         void operator=(const snapParameters&);
  74
  75
  76 public:
  77
  78     // Constructors
  79
  80         //- Construct from dictionary
  81         snapParameters(const dictionary& dict);
  82
  83
  84     // Member Functions
  85
  86         // Access
  87
  88             //- Number of patch smoothing iterations before finding
  89             //  correspondence to surface
  90             label nSmoothPatch() const
  91             {
  92                 return nSmoothPatch_;
  93             }
  94
  95             //- Relative distance for points to be attracted by surface
  96             //  feature point
  97             //  or edge. True distance is this factor times local
  98             //  maximum edge length.
  99             scalar snapTol() const
 100             {
 101                 return snapTol_;
 102             }
 103
 104             //- Number of mesh displacement smoothing iterations.
 105             label nSmoothDispl() const
 106             {
 107                 return nSmoothDispl_;
 108             }
 109
 110             //- Maximum number of snapping relaxation iterations. Should stop
 111             //  before upon reaching a correct mesh.
 112             label nSnap() const
 113             {
 114                 return nSnap_;
 115             }
 116
 117             label nFeatureSnap() const
 118             {
 119                 return nFeatureSnap_;
 120             }
 121
 122 };
 123
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 } // End namespace Foam
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 #endif
 132
 133 // ************************************************************************* //