src/edgeMesh/featureEdgeMesh.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::featureEdgeMesh
  27
  28 Description
  29     features (lines), readable from file
  30
  31 SourceFiles
  32     featureEdgeMesh.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef featureEdgeMesh_H
  37 #define featureEdgeMesh_H
  38
  39 #include "edgeMesh.H"
  40 #include <OpenFOAM/regIOobject.H>
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class featureEdgeMesh Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class featureEdgeMesh
  52 :
  53     public regIOobject,
  54     public edgeMesh
  55 {
  56
  57 public:
  58
  59     TypeName("featureEdgeMesh");
  60
  61
  62     // Constructors
  63
  64         //- Construct (read) given an IOobject
  65         featureEdgeMesh(const IOobject&);
  66
  67         //- Construct from featureEdgeMesh data
  68         featureEdgeMesh
  69         (
  70             const IOobject&,
  71             const pointField&,
  72             const edgeList&
  73         );
  74
  75         //- Construct as copy
  76         featureEdgeMesh(const IOobject&, const featureEdgeMesh&);
  77
  78
  79         //- ReadData function required for regIOobject read operation
  80         virtual bool readData(Istream&);
  81
  82         //- WriteData function required for regIOobject write operation
  83         virtual bool writeData(Ostream&) const;
  84 };
  85
  86
  87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  88
  89 } // End namespace Foam
  90
  91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  92
  93 #endif
  94
  95 // ************************ vim: set sw=4 sts=4 et: ************************ //