Build instructions update: Cesare Guardino
[foam-extend-3.2.git] / src / edgeMesh / featureEdgeMesh.H
blobf370b6e57a945b3ba3d4f61eeda582859f61caf5
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::featureEdgeMesh
27 Description
28     features (lines), readable from file
30 SourceFiles
31     featureEdgeMesh.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef featureEdgeMesh_H
36 #define featureEdgeMesh_H
38 #include "edgeMesh.H"
39 #include "regIOobject.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 /*---------------------------------------------------------------------------*\
47                            Class featureEdgeMesh Declaration
48 \*---------------------------------------------------------------------------*/
50 class featureEdgeMesh
52     public regIOobject,
53     public edgeMesh
56 public:
58     TypeName("featureEdgeMesh");
61     // Constructors
63         //- Construct (read) given an IOobject
64         featureEdgeMesh(const IOobject&);
66         //- Construct from featureEdgeMesh data
67         featureEdgeMesh
68         (
69             const IOobject&,
70             const pointField&,
71             const edgeList&
72         );
74         //- Construct as copy
75         featureEdgeMesh(const IOobject&, const featureEdgeMesh&);
78         //- ReadData function required for regIOobject read operation
79         virtual bool readData(Istream&);
81         //- WriteData function required for regIOobject write operation
82         virtual bool writeData(Ostream&) const;
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 } // End namespace Foam
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 #endif
94 // ************************************************************************* //