FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

labelledTri.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::labelledTri
00026 
00027 Description
00028     Triangle with additional region number.
00029 
00030 SourceFiles
00031     labelledTriI.H
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef labelledTri_H
00036 #define labelledTri_H
00037 
00038 #include <OpenFOAM/triFace.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class labelledTri Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 class labelledTri
00050 :
00051     public triFace
00052 {
00053     // Private data
00054 
00055         label region_;
00056 
00057 
00058 public:
00059 
00060     // Constructors
00061 
00062         //- Construct null
00063         inline labelledTri();
00064 
00065         //- Construct from three point labels and a region label
00066         inline labelledTri
00067         (
00068             const label a,
00069             const label b,
00070             const label c,
00071             const label region
00072         );
00073 
00074         //- Construct from Istream
00075         inline labelledTri(Istream&);
00076 
00077 
00078     // Member Functions
00079 
00080         // Access
00081 
00082             //- Return region label
00083             inline label region() const;
00084 
00085             //- Return region label
00086             inline label& region();
00087 
00088 
00089         // Check
00090 
00091         // Edit
00092 
00093         // Write
00094 
00095 
00096     // Friend Functions
00097 
00098     // Friend Operators
00099 
00100     // IOstream Operators
00101 
00102         inline friend Istream& operator>>(Istream&, labelledTri&);
00103         inline friend Ostream& operator<<(Ostream&, const labelledTri&);
00104 };
00105 
00106 
00107 template<>
00108 inline bool contiguous<labelledTri>()  {return true;}
00109 
00110 
00111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00112 
00113 } // End namespace Foam
00114 
00115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00116 
00117 #include <triSurface/labelledTriI.H>
00118 
00119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00120 
00121 #endif
00122 
00123 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines