src/meshTools/cellDist/wallPoint/wallPoint.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::wallPoint
  27
  28 Description
  29     Holds information regarding nearest wall point. Used in wall distance
  30     calculation.
  31
  32 SourceFiles
  33     wallPointI.H
  34     wallPoint.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef wallPoint_H
  39 #define wallPoint_H
  40
  41 #include "point.H"
  42 #include "label.H"
  43 #include "scalar.H"
  44 #include "tensor.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 // Forward declaration of classes
  52 class polyPatch;
  53 class polyMesh;
  54 class wallPoint;
  55
  56 // Forward declaration of friend functions and operators
  57 Ostream& operator<<(Ostream&, const wallPoint&);
  58 Istream& operator>>(Istream&, wallPoint&);
  59
  60
  61 /*---------------------------------------------------------------------------*\
  62                            Class wallPoint Declaration
  63 \*---------------------------------------------------------------------------*/
  64
  65 class wallPoint
  66 {
  67     // Private data
  68
  69         //- position of nearest wall center
  70         point origin_;
  71
  72         //- normal distance (squared) from cellcenter to origin
  73         scalar distSqr_;
  74
  75     // Private Member Functions
  76
  77         //- Evaluate distance to point. Update distSqr, origin from whomever
  78         //  is nearer pt. Return true if w2 is closer to point,
  79         //  false otherwise.
  80         inline bool update
  81         (
  82             const point&,
  83             const wallPoint& w2,
  84             const scalar tol
  85         );
  86
  87
  88 public:
  89
  90     // Static data members
  91
  92         //- initial point far away.
  93         static point greatPoint;
  94
  95
  96     // Constructors
  97
  98         //- Construct null
  99         inline wallPoint();
 100
 101         //- Construct from origin, distance
 102         inline wallPoint
 103         (
 104             const point& origin,
 105             const scalar distSqr
 106         );
 107
 108         //- Construct as copy
 109         inline wallPoint
 110         (
 111             const wallPoint&
 112         );
 113
 114
 115     // Member Functions
 116
 117         // Access
 118
 119             inline const point& origin() const;
 120
 121             inline point& origin();
 122
 123             inline scalar distSqr() const;
 124
 125             inline scalar& distSqr();
 126
 127
 128         // Needed by FaceCellWave
 129
 130             //- Check whether origin has been changed at all or
 131             //  still contains original (invalid) value.
 132             inline bool valid() const;
 133
 134             //- Check for identical geometrical data. Used for cyclics checking.
 135             inline bool sameGeometry
 136             (
 137                 const polyMesh&,
 138                 const wallPoint&,
 139                 const scalar
 140             ) const;
 141
 142             //- Convert any absolute coordinates into relative to (patch)face
 143             //  centre
 144             inline void leaveDomain
 145             (
 146                 const polyMesh&,
 147                 const polyPatch&,
 148                 const label patchFaceI,
 149                 const point& faceCentre
 150             );
 151
 152             //- Reverse of leaveDomain
 153             inline void enterDomain
 154             (
 155                 const polyMesh&,
 156                 const polyPatch&,
 157                 const label patchFaceI,
 158                 const point& faceCentre
 159             );
 160
 161             //- Apply rotation matrix to any coordinates
 162             inline void transform
 163             (
 164                 const polyMesh&,
 165                 const tensor&
 166             );
 167
 168             //- Influence of neighbouring face.
 169             inline bool updateCell
 170             (
 171                 const polyMesh&,
 172                 const label thisCellI,
 173                 const label neighbourFaceI,
 174                 const wallPoint& neighbourInfo,
 175                 const scalar tol
 176             );
 177
 178             //- Influence of neighbouring cell.
 179             inline bool updateFace
 180             (
 181                 const polyMesh&,
 182                 const label thisFaceI,
 183                 const label neighbourCellI,
 184                 const wallPoint& neighbourInfo,
 185                 const scalar tol
 186             );
 187
 188             //- Influence of different value on same face.
 189             inline bool updateFace
 190             (
 191                 const polyMesh&,
 192                 const label thisFaceI,
 193                 const wallPoint& neighbourInfo,
 194                 const scalar tol
 195             );
 196
 197
 198     // Member Operators
 199
 200         // Needed for List IO
 201         inline bool operator==(const wallPoint&) const;
 202         inline bool operator!=(const wallPoint&) const;
 203
 204
 205     // IOstream Operators
 206
 207         friend Ostream& operator<<(Ostream&, const wallPoint&);
 208         friend Istream& operator>>(Istream&, wallPoint&);
 209 };
 210
 211
 212 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 213
 214 } // End namespace Foam
 215
 216 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 217
 218 #include "wallPointI.H"
 219
 220 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 221
 222 #endif
 223
 224 // ************************************************************************* //