src/OpenFOAM/meshes/primitiveShapes/tetrahedron/tetrahedron.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::tetrahedron
  27
  28 Description
  29     A tetrahedron primitive.
  30
  31     Ordering of edges needs to be the same for a tetrahedron
  32     class, a tetrahedron cell shape model and a tetCell.
  33
  34 SourceFiles
  35     tetrahedronI.H
  36     tetrahedron.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef tetrahedron_H
  41 #define tetrahedron_H
  42
  43 #include "point.H"
  44 #include "primitiveFieldsFwd.H"
  45 #include "pointHit.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 class Istream;
  53 class Ostream;
  54
  55 // Forward declaration of friend functions and operators
  56
  57 template<class Point, class PointRef> class tetrahedron;
  58
  59 template<class Point, class PointRef>
  60 inline Istream& operator>>
  61 (
  62     Istream&,
  63     tetrahedron<Point, PointRef>&
  64 );
  65
  66 template<class Point, class PointRef>
  67 inline Ostream& operator<<
  68 (
  69     Ostream&,
  70     const tetrahedron<Point, PointRef>&
  71 );
  72
  73
  74 /*---------------------------------------------------------------------------*\
  75                            class tetrahedron Declaration
  76 \*---------------------------------------------------------------------------*/
  77
  78 template<class Point, class PointRef>
  79 class tetrahedron
  80 {
  81     // Private data
  82
  83         PointRef a_, b_, c_, d_;
  84
  85
  86 public:
  87
  88     // Member constants
  89
  90         enum
  91         {
  92             nVertices = 4,  // Number of vertices in tetrahedron
  93             nEdges = 6      // Number of edges in tetrahedron
  94         };
  95
  96
  97     // Constructors
  98
  99         //- Construct from points
 100         inline tetrahedron
 101         (
 102             const Point& a,
 103             const Point& b,
 104             const Point& c,
 105             const Point& d
 106         );
 107
 108         //- Construct from Istream
 109         inline tetrahedron(Istream&);
 110
 111
 112     // Member Functions
 113
 114         // Access
 115
 116             //- Return vertices
 117             inline const Point& a() const;
 118
 119             inline const Point& b() const;
 120
 121             inline const Point& c() const;
 122
 123             inline const Point& d() const;
 124
 125
 126         // Properties
 127
 128             //- Return face normal
 129             inline vector Sa() const;
 130
 131             inline vector Sb() const;
 132
 133             inline vector Sc() const;
 134
 135             inline vector Sd() const;
 136
 137
 138             //- Return volume
 139             inline scalar mag() const;
 140
 141             //- Return circum-centre
 142             inline vector circumCentre() const;
 143
 144             //- Return circum-radius
 145             inline scalar circumRadius() const;
 146
 147             //- Return (min)containment sphere, i.e. the smallest sphere with
 148             //  all points inside. Returns pointHit with:
 149             //  - hit         : if sphere is equal to circumsphere
 150             //                  (biggest sphere)
 151             //  - point       : centre of sphere
 152             //  - distance    : radius of sphere
 153             //  - eligiblemiss: false
 154             // Tol (small compared to 1, e.g. 1E-9) is used to determine
 155             // whether point is inside: mag(pt - ctr) < (1+tol)*radius.
 156             pointHit containmentSphere(const scalar tol) const;
 157
 158             //- Fill buffer with shape function products
 159             void gradNiSquared(scalarField& buffer) const;
 160
 161             void gradNiDotGradNj(scalarField& buffer) const;
 162
 163             void gradNiGradNi(tensorField& buffer) const;
 164
 165             void gradNiGradNj(tensorField& buffer) const;
 166
 167
 168     // IOstream operators
 169
 170         friend Istream& operator>> <Point, PointRef>
 171         (
 172             Istream&,
 173             tetrahedron&
 174         );
 175
 176         friend Ostream& operator<< <Point, PointRef>
 177         (
 178             Ostream&,
 179             const tetrahedron&
 180         );
 181 };
 182
 183
 184 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 185
 186 } // End namespace Foam
 187
 188 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 189
 190 #include "tetrahedronI.H"
 191
 192 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 193
 194 #ifdef NoRepository
 195 #   include "tetrahedron.C"
 196 #endif
 197
 198 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 199
 200 #endif
 201
 202 // ************************************************************************* //