FreeFOAM The Cross-Platform CFD Toolkit
labelledTri.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-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 <OpenFOAM/triFace.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class labelledTri Declaration
47 \*---------------------------------------------------------------------------*/
48 
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 three point labels and a region label
66  inline labelledTri
67  (
68  const label a,
69  const label b,
70  const label c,
71  const label region
72  );
73 
74  //- Construct from Istream
75  inline labelledTri(Istream&);
76 
77 
78  // Member Functions
79 
80  // Access
81 
82  //- Return region label
83  inline label region() const;
84 
85  //- Return region label
86  inline label& region();
87 
88 
89  // Check
90 
91  // Edit
92 
93  // Write
94 
95 
96  // Friend Functions
97 
98  // Friend Operators
99 
100  // IOstream Operators
101 
102  inline friend Istream& operator>>(Istream&, labelledTri&);
103  inline friend Ostream& operator<<(Ostream&, const labelledTri&);
104 };
105 
106 
107 template<>
108 inline bool contiguous<labelledTri>() {return true;}
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #include <triSurface/labelledTriI.H>
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************ vim: set sw=4 sts=4 et: ************************ //