src/foam/meshes/primitiveShapes/tetrahedron/tetrahedron.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::tetrahedron
  26
  27 Description
  28     A tetrahedron primitive.
  29
  30     Ordering of edges needs to be the same for a tetrahedron
  31     class, a tetrahedron cell shape model and a tetCell.
  32
  33 SourceFiles
  34     tetrahedronI.H
  35     tetrahedron.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef tetrahedron_H
  40 #define tetrahedron_H
  41
  42 #include "point.H"
  43 #include "primitiveFieldsFwd.H"
  44 #include "pointHit.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 class Istream;
  52 class Ostream;
  53
  54 // Forward declaration of friend functions and operators
  55
  56 template<class Point, class PointRef> class tetrahedron;
  57
  58 template<class Point, class PointRef>
  59 inline Istream& operator>>
  60 (
  61     Istream&,
  62     tetrahedron<Point, PointRef>&
  63 );
  64
  65 template<class Point, class PointRef>
  66 inline Ostream& operator<<
  67 (
  68     Ostream&,
  69     const tetrahedron<Point, PointRef>&
  70 );
  71
  72
  73 /*---------------------------------------------------------------------------*\
  74                            class tetrahedron Declaration
  75 \*---------------------------------------------------------------------------*/
  76
  77 template<class Point, class PointRef>
  78 class tetrahedron
  79 {
  80     // Private data
  81
  82         PointRef a_, b_, c_, d_;
  83
  84
  85 public:
  86
  87     // Member constants
  88
  89         enum
  90         {
  91             nVertices = 4,  // Number of vertices in tetrahedron
  92             nEdges = 6      // Number of edges in tetrahedron
  93         };
  94
  95
  96     // Constructors
  97
  98         //- Construct from points
  99         inline tetrahedron
 100         (
 101             const Point& a,
 102             const Point& b,
 103             const Point& c,
 104             const Point& d
 105         );
 106
 107         //- Construct from Istream
 108         inline tetrahedron(Istream&);
 109
 110
 111     // Member Functions
 112
 113         // Access
 114
 115             //- Return vertices
 116             inline const Point& a() const;
 117
 118             inline const Point& b() const;
 119
 120             inline const Point& c() const;
 121
 122             inline const Point& d() const;
 123
 124
 125         // Properties
 126
 127             //- Return face normal
 128             inline vector Sa() const;
 129
 130             inline vector Sb() const;
 131
 132             inline vector Sc() const;
 133
 134             inline vector Sd() const;
 135
 136
 137             //- Return volume
 138             inline scalar mag() const;
 139
 140             //- Return centre
 141             inline vector centre() const;
 142
 143             //- Return circum-centre
 144             inline vector circumCentre() const;
 145
 146             //- Return circum-radius
 147             inline scalar circumRadius() const;
 148
 149             //- Return (min)containment sphere, i.e. the smallest sphere with
 150             //  all points inside. Returns pointHit with:
 151             //  - hit         : if sphere is equal to circumsphere
 152             //                  (biggest sphere)
 153             //  - point       : centre of sphere
 154             //  - distance    : radius of sphere
 155             //  - eligiblemiss: false
 156             // Tol (small compared to 1, e.g. 1E-9) is used to determine
 157             // whether point is inside: mag(pt - ctr) < (1+tol)*radius.
 158             pointHit containmentSphere(const scalar tol) const;
 159
 160             //- Fill buffer with shape function products
 161             void gradNiSquared(scalarField& buffer) const;
 162
 163             void gradNiDotGradNj(scalarField& buffer) const;
 164
 165             void gradNiGradNi(tensorField& buffer) const;
 166
 167             void gradNiGradNj(tensorField& buffer) const;
 168
 169
 170     // IOstream operators
 171
 172         friend Istream& operator>> <Point, PointRef>
 173         (
 174             Istream&,
 175             tetrahedron&
 176         );
 177
 178         friend Ostream& operator<< <Point, PointRef>
 179         (
 180             Ostream&,
 181             const tetrahedron&
 182         );
 183 };
 184
 185
 186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 187
 188 } // End namespace Foam
 189
 190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 191
 192 #include "tetrahedronI.H"
 193
 194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 195
 196 #ifdef NoRepository
 197 #   include "tetrahedron.C"
 198 #endif
 199
 200 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 201
 202 #endif
 203
 204 // ************************************************************************* //