OpenFOAM logo
Open Source CFD Toolkit

tetCell.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     tetCell
00027 
00028 Description
00029     A tetrahedral cell primitive used for tetra FEM and post-processing.
00030     It is important that the ordering of edges is the same for a tetrahedron
00031     class, a tetrahedron cell shape model and a tetCell
00032 
00033 SourceFiles
00034     tetCellI.H
00035 
00036 \*---------------------------------------------------------------------------*/
00037 
00038 #ifndef tetCell_H
00039 #define tetCell_H
00040 
00041 #include "FixedList.H"
00042 #include "triFace.H"
00043 #include "edge.H"
00044 #include "pointField.H"
00045 #include "tetPointRef.H"
00046 
00047 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00048 
00049 namespace Foam
00050 {
00051 
00052 class cellShape;
00053 
00054 /*---------------------------------------------------------------------------*\
00055                            class tetCell Declaration
00056 \*---------------------------------------------------------------------------*/
00057 
00058 class tetCell
00059 :
00060     public FixedList<label, 4>
00061 {
00062 
00063 public:
00064 
00065     // Constructors
00066 
00067         //- Construct null
00068         inline tetCell();
00069 
00070         //- Construct from four points
00071         inline tetCell
00072         (
00073             const label a,
00074             const label b,
00075             const label c,
00076             const label d
00077         );
00078 
00079         //- Construct from Istream
00080         inline tetCell(Istream&);
00081 
00082 
00083     // Member Functions
00084 
00085         // Access
00086 
00087             //- Return ith face
00088             inline triFace face(const label facei) const;
00089 
00090             //- Return fisrt face adjacent to the given edge
00091             inline label edgeFace(const label edgei) const;
00092 
00093             //- Return face adjacent to the given face sharing the same edge
00094             inline label edgeAdjacentFace
00095             (
00096                 const label edgei,
00097                 const label facei
00098             ) const;
00099 
00100             //- Return ith edge
00101             inline edge tetEdge(const label edgei) const;
00102 
00103 
00104         // Operations
00105 
00106             //- Return tet shape cell
00107             cellShape tetCellShape() const;
00108 
00109             //- Return the tetrahedron
00110             inline tetPointRef tet(const pointField&) const;
00111 };
00112 
00113 
00114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00115 
00116 } // End namespace Foam
00117 
00118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00119 
00120 #include "tetCellI.H"
00121 
00122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00123 
00124 #endif
00125 
00126 // ************************************************************************* //
For further information go to www.openfoam.org