src/sampling/sampledSurface/writers/vtk/vtkSurfaceWriter.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::vtkSurfaceWriter
  27
  28 Description
  29
  30 SourceFiles
  31     vtkSurfaceWriter.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef vtkSurfaceWriter_H
  36 #define vtkSurfaceWriter_H
  37
  38 #include "surfaceWriter.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                      Class vtkSurfaceWriter Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class Type>
  50 class vtkSurfaceWriter
  51 :
  52     public surfaceWriter<Type>
  53 {
  54     // Private Member Functions
  55
  56         static void writeGeometry(Ostream&, const pointField&, const faceList&);
  57
  58         static void writeData(Ostream&, const Field<Type>& values);
  59
  60
  61 public:
  62
  63     //- Runtime type information
  64     TypeName("vtk");
  65
  66
  67     // Constructors
  68
  69         //- Construct null
  70         vtkSurfaceWriter();
  71
  72
  73     // Destructor
  74
  75         virtual ~vtkSurfaceWriter();
  76
  77
  78     // Member Functions
  79
  80         // Write
  81
  82         //- Write geometry to file.
  83         virtual void write
  84         (
  85             const fileName& outputDir,
  86             const fileName& surfaceName,
  87             const pointField& points,
  88             const faceList& faces,
  89             const bool verbose = false
  90         ) const;
  91
  92
  93         //- Writes single surface to file.
  94         virtual void write
  95         (
  96             const fileName& outputDir,
  97             const fileName& surfaceName,
  98             const pointField& points,
  99             const faceList& faces,
 100             const fileName& fieldName,
 101             const Field<Type>& values,
 102             const bool verbose = false
 103         ) const;
 104 };
 105
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 } // End namespace Foam
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 #ifdef NoRepository
 114 #   include "vtkSurfaceWriter.C"
 115 #endif
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 #endif
 120
 121 // ************************************************************************* //