src/meshTools/cellDist/wallPoint/wallPointData.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::wallPointData
  27
  28 Description
  29     Holds information (coordinate and normal) regarding nearest wall point.
  30
  31     Is like wallPoint but transfer extra (passive) data.
  32     Used e.g. in wall distance calculation with wall reflection vectors.
  33
  34 SourceFiles
  35     wallPointDataI.H
  36     wallPointData.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef wallPointData_H
  41 #define wallPointData_H
  42
  43 #include "wallPoint.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 template<class Type> class wallPointData;
  51
  52 // Forward declaration of friend functions and operators
  53
  54 template<class Type> Istream& operator>>(Istream&, wallPointData<Type>&);
  55 template<class Type> Ostream& operator<<(Ostream&, const wallPointData<Type>&);
  56
  57
  58 /*---------------------------------------------------------------------------*\
  59                            Class wallPointData Declaration
  60 \*---------------------------------------------------------------------------*/
  61
  62 template <class Type>
  63 class wallPointData
  64 :
  65     public wallPoint
  66 {
  67     // Private data
  68
  69         //- data at nearest wall center
  70         Type data_;
  71
  72
  73     // Private Member Functions
  74
  75         //- Evaluate distance to point. Update distSqr, origin from whomever
  76         //  is nearer pt. Return true if w2 is closer to point,
  77         //  false otherwise.
  78         inline bool update
  79         (
  80             const point&,
  81             const wallPointData<Type>& w2,
  82             const scalar tol
  83         );
  84
  85
  86 public:
  87
  88     typedef Type dataType;
  89
  90
  91     // Constructors
  92
  93         //- Construct null
  94         inline wallPointData();
  95
  96         //- Construct from origin, normal, distance
  97         inline wallPointData
  98         (
  99             const point& origin,
 100             const Type& data,
 101             const scalar distSqr
 102         );
 103
 104
 105     // Member Functions
 106
 107         // Access
 108
 109             inline const Type& data() const;
 110             inline Type& data();
 111
 112         // Needed by meshWave
 113
 114             //- Influence of neighbouring face.
 115             //  Calls update(...) with cellCentre of cellI
 116             inline bool updateCell
 117             (
 118                 const polyMesh& mesh,
 119                 const label thisCellI,
 120                 const label neighbourFaceI,
 121                 const wallPointData<Type>& neighbourWallInfo,
 122                 const scalar tol
 123             );
 124
 125             //- Influence of neighbouring cell.
 126             //  Calls update(...) with faceCentre of faceI
 127             inline bool updateFace
 128             (
 129                 const polyMesh& mesh,
 130                 const label thisFaceI,
 131                 const label neighbourCellI,
 132                 const wallPointData<Type>& neighbourWallInfo,
 133                 const scalar tol
 134             );
 135
 136             //- Influence of different value on same face.
 137             //  Merge new and old info.
 138             //  Calls update(...) with faceCentre of faceI
 139             inline bool updateFace
 140             (
 141                 const polyMesh& mesh,
 142                 const label thisFaceI,
 143                 const wallPointData<Type>& neighbourWallInfo,
 144                 const scalar tol
 145             );
 146
 147     // Member Operators
 148
 149     // IOstream Operators
 150
 151         friend Ostream& operator<< <Type>(Ostream&, const wallPointData<Type>&);
 152         friend Istream& operator>> <Type>(Istream&, wallPointData<Type>&);
 153 };
 154
 155
 156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 157
 158
 159 } // End namespace Foam
 160
 161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 162
 163 #ifdef NoRepository
 164 #   include "wallPointData.C"
 165 #endif
 166
 167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 168
 169 #include "wallPointDataI.H"
 170
 171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 172
 173 #endif
 174
 175 // ************************************************************************* //