src/sampling/sampledSurface/writers/proxy/proxySurfaceWriter.H

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