src/triSurface/tools/labelledTri/labelledTri.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::labelledTri
  27
  28 Description
  29     Triangle with additional region number.
  30
  31 SourceFiles
  32     labelledTriI.H
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef labelledTri_H
  37 #define labelledTri_H
  38
  39 #include "triFace.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class labelledTri Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class labelledTri
  51 :
  52     public triFace
  53 {
  54     // Private data
  55
  56         label region_;
  57
  58
  59 public:
  60
  61     // Constructors
  62
  63         //- Construct null
  64         inline labelledTri();
  65
  66         //- Construct from three point labels and a region label
  67         inline labelledTri
  68         (
  69             const label a,
  70             const label b,
  71             const label c,
  72             const label region
  73         );
  74
  75         //- Construct from Istream
  76         inline labelledTri(Istream&);
  77
  78
  79     // Member Functions
  80
  81         // Access
  82
  83             //- Return region label
  84             inline label region() const;
  85
  86             //- Return region label
  87             inline label& region();
  88
  89
  90         // Check
  91
  92         // Edit
  93
  94         // Write
  95
  96
  97     // Friend Functions
  98
  99     // Friend Operators
 100
 101     // IOstream Operators
 102
 103         inline friend Istream& operator>>(Istream&, labelledTri&);
 104         inline friend Ostream& operator<<(Ostream&, const labelledTri&);
 105 };
 106
 107
 108 template<>
 109 inline bool contiguous<labelledTri>()  {return true;}
 110
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 } // End namespace Foam
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 #include "labelledTriI.H"
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #endif
 123
 124 // ************************************************************************* //