src/finiteVolume/fvMesh/wallDist/wallDist.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::wallDist
  26
  27 Description
  28     Calculation of distance to nearest wall for all cells and boundary.
  29     Uses meshWave to do actual calculation.
  30
  31     Distance correction:
  32
  33     if correctWalls = true:
  34     For each cell with face on wall calculate the true nearest point
  35     (by triangle decomposition) on that face and do that same for that face's
  36     pointNeighbours. This will find the true nearest distance in almost all
  37     cases. Only very skewed cells or cells close to another wall might be
  38     missed.
  39
  40     For each cell with only point on wall the same is done except now it takes
  41     the pointFaces() of the wall point to look for the nearest point.
  42
  43 Note
  44
  45     correct() : for now does complete recalculation. (which usually is
  46     ok since mesh is smoothed). However for topology change where geometry
  47     in most of domain does not change you could think of starting from the
  48     old cell values. Tried but not done since:
  49     - meshWave would have to be called with old cellInfo.
  50       This is List\<wallInfo\> of nCells.
  51     - cannot construct from distance (y_) only since we don't know a value
  52       for origin_. (origin_ = GREAT already used to denote illegal value.)
  53     - so we would have to store a List\<wallInfo\> which unfortunately does
  54       not get resized/mapped automatically upon mesh changes.
  55
  56 SourceFiles
  57     wallDist.C
  58
  59 \*---------------------------------------------------------------------------*/
  60
  61 #ifndef wallDist_H
  62 #define wallDist_H
  63
  64 #include "objectRegistry.H"
  65 #include "volFields.H"
  66 #include "cellDistFuncs.H"
  67
  68
  69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  70
  71 namespace Foam
  72 {
  73
  74 class fvMesh;
  75
  76 /*---------------------------------------------------------------------------*\
  77                            Class wallDist Declaration
  78 \*---------------------------------------------------------------------------*/
  79
  80 class wallDist
  81 :
  82     public volScalarField,
  83     public cellDistFuncs
  84 {
  85 private:
  86
  87     // Private Member Data
  88
  89         //- Do accurate distance calculation for near-wall cells.
  90         bool correctWalls_;
  91
  92         //- Number of unset cells and faces.
  93         label nUnset_;
  94
  95
  96     // Private Member Functions
  97
  98         //- Disallow default bitwise copy construct
  99         wallDist(const wallDist&);
 100
 101         //- Disallow default bitwise assignment
 102         void operator=(const wallDist&);
 103
 104
 105 public:
 106
 107     // Constructors
 108
 109         //- Construct from mesh and flag whether or not to correct wall.
 110         //  Calculate for all cells. correctWalls : correct wall (face&point)
 111         //  cells for correct distance, searching neighbours.
 112         wallDist(const fvMesh& mesh, bool correctWalls = true);
 113
 114
 115     // Destructor
 116
 117         virtual ~wallDist();
 118
 119
 120     // Member Functions
 121
 122         const volScalarField& y() const
 123         {
 124             return *this;
 125         }
 126
 127         label nUnset() const
 128         {
 129             return nUnset_;
 130         }
 131
 132         //- Correct for mesh geom/topo changes
 133         virtual void correct();
 134 };
 135
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 } // End namespace Foam
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 #endif
 144
 145 // ************************************************************************* //