FreeFOAM The Cross-Platform CFD Toolkit
featureEdgeMesh.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::featureEdgeMesh
26 
27 Description
28  features (lines), readable from file
29 
30 SourceFiles
31  featureEdgeMesh.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef featureEdgeMesh_H
36 #define featureEdgeMesh_H
37 
38 #include "edgeMesh.H"
39 #include <OpenFOAM/regIOobject.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class featureEdgeMesh Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public regIOobject,
53  public edgeMesh
54 {
55 
56 public:
57 
58  TypeName("featureEdgeMesh");
59 
60 
61  // Constructors
62 
63  //- Construct (read) given an IOobject
64  featureEdgeMesh(const IOobject&);
65 
66  //- Construct from featureEdgeMesh data
68  (
69  const IOobject&,
70  const pointField&,
71  const edgeList&
72  );
73 
74  //- Construct as copy
76 
77 
78  //- ReadData function required for regIOobject read operation
79  virtual bool readData(Istream&);
80 
81  //- WriteData function required for regIOobject write operation
82  virtual bool writeData(Ostream&) const;
83 };
84 
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #endif
93 
94 // ************************ vim: set sw=4 sts=4 et: ************************ //