src/finiteVolume/fvMesh/wallDist/wallPointYPlus/wallPointYPlus.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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
  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::wallPointYPlus
  26
  27 Description
  28     Holds information (coordinate and yStar) regarding nearest wall point.
  29
  30     Used in VanDriest wall damping where the interest is in y+ but only
  31     needs to be calculated up to e.g. y+ < 200. In all other cells/faces
  32     the damping function becomes 1, since y gets initialized to GREAT and
  33     yStar to 1.
  34
  35     Note: should feed the additional argument (yPlusCutoff) through as a
  36     template argument into FaceCellWave
  37
  38 SourceFiles
  39     wallPointYPlusI.H
  40     wallPointYPlus.C
  41
  42 \*---------------------------------------------------------------------------*/
  43
  44 #ifndef wallPointYPlus_H
  45 #define wallPointYPlus_H
  46
  47 #include "wallPointData.H"
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 namespace Foam
  52 {
  53
  54
  55 /*---------------------------------------------------------------------------*\
  56                            Class wallPointYPlus Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class wallPointYPlus
  60 :
  61     public wallPointData<scalar>
  62 {
  63
  64 private:
  65
  66     // Private Member Functions
  67
  68         //- Evaluate distance to point. Update distSqr, origin from whomever
  69         //  is nearer pt. Return true if w2 is closer to point,
  70         //  false otherwise.
  71         template<class TrackingData>
  72         inline bool update
  73         (
  74             const point&,
  75             const wallPointYPlus& w2,
  76             const scalar tol,
  77             TrackingData& td
  78         );
  79
  80 public:
  81
  82     // Static data members
  83
  84         //- cut-off value for y+
  85         static scalar yPlusCutOff;
  86
  87
  88     // Constructors
  89
  90         //- Construct null
  91         inline wallPointYPlus();
  92
  93         //- Construct from origin, yStar, distance
  94         inline wallPointYPlus
  95         (
  96             const point& origin,
  97             const scalar yStar,
  98             const scalar distSqr
  99         );
 100
 101
 102     // Member Functions
 103
 104         // Needed by FaceCellWave
 105
 106             //- Influence of neighbouring face.
 107             //  Calls update(...) with cellCentre of cellI
 108             template<class TrackingData>
 109             inline bool updateCell
 110             (
 111                 const polyMesh& mesh,
 112                 const label thisCellI,
 113                 const label neighbourFaceI,
 114                 const wallPointYPlus& neighbourWallInfo,
 115                 const scalar tol,
 116                 TrackingData& td
 117             );
 118
 119             //- Influence of neighbouring cell.
 120             //  Calls update(...) with faceCentre of faceI
 121             template<class TrackingData>
 122             inline bool updateFace
 123             (
 124                 const polyMesh& mesh,
 125                 const label thisFaceI,
 126                 const label neighbourCellI,
 127                 const wallPointYPlus& neighbourWallInfo,
 128                 const scalar tol,
 129                 TrackingData& td
 130             );
 131
 132             //- Influence of different value on same face.
 133             //  Merge new and old info.
 134             //  Calls update(...) with faceCentre of faceI
 135             template<class TrackingData>
 136             inline bool updateFace
 137             (
 138                 const polyMesh& mesh,
 139                 const label thisFaceI,
 140                 const wallPointYPlus& neighbourWallInfo,
 141                 const scalar tol,
 142                 TrackingData& td
 143             );
 144 };
 145
 146
 147 //- Data associated with pointEdgePoint type as contiguous as underlying type
 148 template<>
 149 inline bool contiguous<wallPointYPlus>()
 150 {
 151     return contiguous<wallPointData<scalar> >();
 152 }
 153
 154
 155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 156
 157
 158 } // End namespace Foam
 159
 160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 161
 162 #include "wallPointYPlusI.H"
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 #endif
 167
 168 // ************************************************************************* //