OpenFOAM logo
Open Source CFD Toolkit

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-2005 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 the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     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, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     labelledTri
00027 
00028 Description
00029     Triangle with additional region number.
00030 
00031 SourceFiles
00032     labelledTriI.H
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef labelledTri_H
00037 #define labelledTri_H
00038 
00039 #include "triFace.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                            Class labelledTri Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class labelledTri
00051 :
00052     public triFace
00053 {
00054     // Private data
00055 
00056         label region_;
00057 
00058 
00059 public:
00060 
00061     // Constructors
00062 
00063         //- Construct null
00064         inline labelledTri();
00065 
00066         //- Construct from three point labels and a region label
00067         inline labelledTri
00068         (
00069             const label a,
00070             const label b,
00071             const label c,
00072             const label region
00073         );
00074 
00075         //- Construct from Istream
00076         inline labelledTri(Istream&);
00077 
00078 
00079     // Member Functions
00080 
00081         // Access
00082 
00083             //- Return region label
00084             inline label region() const;
00085 
00086             //- Return region label
00087             inline label& region();
00088 
00089 
00090         // Check
00091 
00092         // Edit
00093 
00094         // Write
00095 
00096 
00097     // Friend Functions
00098 
00099     // Friend Operators
00100 
00101     // IOstream Operators
00102 
00103         inline friend Istream& operator>>(Istream&, labelledTri&);
00104         inline friend Ostream& operator<<(Ostream&, const labelledTri&);
00105 };
00106 
00107 
00108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00109 
00110 } // End namespace Foam
00111 
00112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00113 
00114 #include "labelledTriI.H"
00115 
00116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00117 
00118 #endif
00119 
00120 // ************************************************************************* //
For further information go to www.openfoam.org