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