src/finiteVolume/fvMesh/wallDist/nearWallDist.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::nearWallDist
  27
  28 Description
  29     Distance calculation for cells with face on a wall.
  30     Searches pointNeighbours to find closest.
  31
  32 SourceFiles
  33     nearWallDist.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef nearWallDist_H
  38 #define nearWallDist_H
  39
  40 #include "volFields.H"
  41
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 class fvMesh;
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class nearWallDist Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class nearWallDist
  55 :
  56     public volScalarField::GeometricBoundaryField
  57 {
  58     // Private data
  59
  60         //- Reference to mesh
  61         const fvMesh& mesh_;
  62
  63
  64     // Private Member Functions
  65
  66         //- Do all calculations.
  67         void doAll();
  68
  69         //- Disallow default bitwise copy construct
  70         nearWallDist(const nearWallDist&);
  71
  72         //- Disallow default bitwise assignment
  73         void operator=(const nearWallDist&);
  74
  75
  76 public:
  77
  78     // Constructors
  79
  80         //- Construct from components
  81         nearWallDist(const fvMesh& mesh);
  82
  83
  84     // Destructor
  85
  86         virtual ~nearWallDist();
  87
  88
  89     // Member Functions
  90
  91         const volScalarField::GeometricBoundaryField& y() const
  92         {
  93             return *this;
  94         }
  95
  96         //- Correct for mesh geom/topo changes
  97         virtual void correct();
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #endif
 108
 109 // ************************************************************************* //