OpenFOAM logo
Open Source CFD Toolkit

edgeMesh.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     edgeMesh
00027 
00028 Description
00029 
00030 SourceFiles
00031     edgeMeshI.H
00032     edgeMesh.C
00033     edgeMeshIO.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef edgeMesh_H
00038 #define edgeMesh_H
00039 
00040 #include "pointField.H"
00041 #include "edgeList.H"
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 namespace Foam
00046 {
00047 
00048 /*---------------------------------------------------------------------------*\
00049                            Class edgeMesh Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 class edgeMesh
00053 {
00054     // Private data
00055 
00056         //- Vertices of the edges
00057         pointField points_;
00058 
00059         //- The edges defining the boundary
00060         edgeList edges_;
00061 
00062 
00063 public:
00064 
00065     // Constructors
00066 
00067         //- Construct from file
00068         edgeMesh(const fileName&);
00069 
00070         //- Construct from Istream
00071         edgeMesh(Istream&);
00072 
00073 
00074     // Member Functions
00075 
00076         // Access
00077 
00078             inline const pointField& points() const;
00079 
00080             inline const edgeList& edges() const;
00081 
00082 
00083         // Check
00084 
00085         // Edit
00086 
00087         // Write
00088 
00089 
00090     // Ostream Operator
00091 
00092         friend Ostream& operator<<(Ostream&, const edgeMesh&);
00093 };
00094 
00095 
00096 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00097 
00098 } // End namespace Foam
00099 
00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00101 
00102 #include "edgeMeshI.H"
00103 
00104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00105 
00106 #endif
00107 
00108 // ************************************************************************* //
For further information go to www.openfoam.org