src/triSurface/tools/labelledTri/labelledTri.H

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