src/finiteVolume/fvMesh/wallDist/wallDistData.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::wallDistData
  27
  28 Description
  29     Wall distance calculation. Like wallDist but also transports extra
  30     data (template argument).
  31
  32     Used for e.g reflection vector calculation or vanDriest damping.
  33
  34     Templated on two parameters:
  35         - TransferType: type of overall data transported
  36           (e.g. wallPointData\<vector\>)
  37
  38 SourceFiles
  39     wallDistData.C
  40
  41 \*---------------------------------------------------------------------------*/
  42
  43 #ifndef wallDistData_H
  44 #define wallDistData_H
  45
  46 #include "cellDistFuncs.H"
  47 #include "volFields.H"
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 namespace Foam
  52 {
  53
  54 /*---------------------------------------------------------------------------*\
  55                            Class wallDistData Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 template<class TransferType>
  59 class wallDistData
  60 :
  61     public volScalarField,
  62     public cellDistFuncs
  63 {
  64
  65 private:
  66
  67     typedef typename TransferType::dataType Type;
  68
  69
  70     // Private Member Data
  71
  72         //- Reference to field whose data to use (on walls) and update
  73         //  (every cell and non-wall face)
  74         GeometricField<Type, fvPatchField, volMesh>& field_;
  75
  76         //- Do accurate distance calculation for near-wall cells.
  77         bool correctWalls_;
  78
  79         //- Number of unset cells and faces.
  80         label nUnset_;
  81
  82
  83     // Private Member Functions
  84
  85         //- Disallow default bitwise copy construct
  86         wallDistData(const wallDistData&);
  87
  88         //- Disallow default bitwise assignment
  89         void operator=(const wallDistData&);
  90
  91
  92 public:
  93
  94     // Constructors
  95
  96         //- Construct from mesh and flag whether or not to correct wall.
  97         //  Calculate for all cells. correctWalls : correct wall (face&point)
  98         //  cells for correct distance, searching neighbours.
  99         wallDistData
 100         (
 101             const fvMesh& mesh,
 102             GeometricField<Type, fvPatchField, volMesh>&,
 103             bool correctWalls = true
 104         );
 105
 106
 107     // Destructor
 108
 109         virtual ~wallDistData();
 110
 111
 112     // Member Functions
 113
 114         const volScalarField& y() const
 115         {
 116             return *this;
 117         }
 118
 119         label nUnset() const
 120         {
 121             return nUnset_;
 122         }
 123
 124         //- Access field
 125         const GeometricField<Type, fvPatchField, volMesh>& data() const
 126         {
 127             return field_;
 128         }
 129
 130         //- Correct for mesh geom/topo changes
 131         virtual void correct();
 132 };
 133
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 } // End namespace Foam
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 #ifdef NoRepository
 142 #   include "wallDistData.C"
 143 #endif
 144
 145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 146
 147 #endif
 148
 149 // ************************************************************************* //