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