src/mesh/cfMesh/meshLibrary/utilities/meshes/primitives/partTet/partTet.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | cfMesh: A library for mesh generation
   4    \\    /   O peration     |
   5     \\  /    A nd           | Author: Franjo Juretic (franjo.juretic@c-fields.com)
   6      \\/     M anipulation  | Copyright (C) Creative Fields, Ltd.
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of cfMesh.
  10
  11     cfMesh 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     cfMesh 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 cfMesh.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     partTet
  26
  27 Description
  28     A partTet is a primitive needed during mesh smoothing
  29
  30 SourceFiles
  31     partTetI.H
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef partTet_H
  36 #define partTet_H
  37
  38 #include "label.H"
  39 #include "pointField.H"
  40 #include "edgeList.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 class Istream;
  48 class Ostream;
  49
  50 /*---------------------------------------------------------------------------*\
  51                            class partTet Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class partTet
  55 {
  56 protected:
  57
  58     // Protected data
  59         label data_[4];
  60
  61 public:
  62
  63     // Constructors
  64         //- Null construct
  65         inline partTet();
  66
  67         //- Construct from point labels
  68         inline partTet
  69         (
  70             const label a,
  71             const label b,
  72             const label c,
  73             const label d
  74         );
  75
  76     // Destructor
  77         ~partTet();
  78
  79
  80     // Member Functions
  81
  82         // Access
  83
  84             //- Return vertices
  85             inline label a() const;
  86
  87             inline label b() const;
  88
  89             inline label c() const;
  90
  91             inline label d() const;
  92
  93             inline label size() const;
  94
  95         // Searches
  96             //- find position of the node in the partTet
  97             inline label whichPosition(const label) const;
  98
  99         // Properties
 100
 101             //- Return face normal
 102             template<class PointField>
 103             inline vector Sa(const PointField&) const;
 104
 105             template<class PointField>
 106             inline vector Sb(const PointField&) const;
 107
 108             template<class PointField>
 109             inline vector Sc(const PointField&) const;
 110
 111             template<class PointField>
 112             inline vector Sd(const PointField&) const;
 113
 114
 115             //- Return volume
 116             template<class PointField>
 117             inline scalar mag(const PointField&) const;
 118
 119             //- Return circum-centre
 120             template<class PointField>
 121             inline point crcmCentre(const PointField&) const;
 122
 123             template<class PointField>
 124             inline scalar crcmRadius(const PointField&) const;
 125
 126             //- Return centroid of the tetrahedron
 127             template<class PointField>
 128             inline point centroid(const PointField&) const;
 129
 130             //- Return edges
 131             edgeList edges() const;
 132
 133     // Member operators
 134
 135             inline label operator[](const label) const;
 136
 137             inline void operator=(const partTet&);
 138
 139     // IOstream operators
 140
 141             friend Ostream& operator<<(Ostream&, const partTet&);
 142 };
 143
 144
 145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 146
 147 } // End namespace Foam
 148
 149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 150
 151 #include "partTetI.H"
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 #endif
 156
 157 // ************************************************************************* //