src/surfMesh/surfaceFormats/off/OFFsurfaceFormat.H

   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.
  10
  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.
  15
  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.
  20
  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/>.
  23
  24 Class
  25     Foam::fileFormats::OFFsurfaceFormat
  26
  27 Description
  28     Provide a means of reading/writing Geomview OFF polyList format.
  29
  30
  31 See Also
  32     The <a href="http://www.geoview.org">Geoview</a>
  33     file format information:
  34     http://www.geomview.org/docs/html/OFF.html#OFF
  35
  36 Note
  37     When reading, the optional @a colorspec is ignored.
  38     When writing, it is set to the zone number (integer).
  39
  40 SourceFiles
  41     OFFsurfaceFormat.C
  42
  43 \*---------------------------------------------------------------------------*/
  44
  45 #ifndef OFFsurfaceFormat_H
  46 #define OFFsurfaceFormat_H
  47
  48 #include "MeshedSurface.H"
  49 #include "MeshedSurfaceProxy.H"
  50 #include "UnsortedMeshedSurface.H"
  51
  52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  53
  54 namespace Foam
  55 {
  56 namespace fileFormats
  57 {
  58
  59 /*---------------------------------------------------------------------------*\
  60                       Class OFFsurfaceFormat Declaration
  61 \*---------------------------------------------------------------------------*/
  62
  63 template<class Face>
  64 class OFFsurfaceFormat
  65 :
  66     public MeshedSurface<Face>
  67 {
  68     // Private Member Functions
  69
  70         //- Disallow default bitwise copy construct
  71         OFFsurfaceFormat(const OFFsurfaceFormat&);
  72
  73         //- Disallow default bitwise assignment
  74         void operator=(const OFFsurfaceFormat&);
  75
  76
  77 public:
  78
  79     // Constructors
  80
  81         //- Construct from file name
  82         OFFsurfaceFormat(const fileName&);
  83
  84
  85     // Selectors
  86
  87         //- Read file and return surface
  88         static autoPtr<MeshedSurface<Face> > New(const fileName& name)
  89         {
  90             return autoPtr<MeshedSurface<Face> >
  91             (
  92                 new OFFsurfaceFormat(name)
  93             );
  94         }
  95
  96
  97     //- Destructor
  98     virtual ~OFFsurfaceFormat()
  99     {}
 100
 101
 102     // Member Functions
 103
 104         //- Write surface mesh components by proxy
 105         static void write(const fileName&, const MeshedSurfaceProxy<Face>&);
 106
 107         //- Read from file
 108         virtual bool read(const fileName&);
 109
 110         //- Write object
 111         virtual void write(const fileName& name) const
 112         {
 113             write(name, MeshedSurfaceProxy<Face>(*this));
 114         }
 115 };
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace fileFormats
 121 } // End namespace Foam
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125
 126 #ifdef NoRepository
 127 #   include "OFFsurfaceFormat.C"
 128 #endif
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 #endif
 133
 134 // ************************************************************************* //