src/sampling/sampledSurface/writers/surfaceWriter.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::surfaceWriter
  27
  28 Description
  29
  30 SourceFiles
  31     surfaceWriter.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef surfaceWriter_H
  36 #define surfaceWriter_H
  37
  38 #include "Field.H"
  39 #include "typeInfo.H"
  40 #include "autoPtr.H"
  41 #include "pointField.H"
  42 #include "faceList.H"
  43 #include "fileName.H"
  44
  45 #include "runTimeSelectionTables.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 // Forward declaration of friend functions and operators
  53
  54 template<class Type> class surfaceWriter;
  55 template<class Type> class nullSurfaceWriter;
  56 template<class Type> class proxySurfaceWriter;
  57
  58 /*---------------------------------------------------------------------------*\
  59                         Class surfaceWriter Declaration
  60 \*---------------------------------------------------------------------------*/
  61
  62 template<class Type>
  63 class surfaceWriter
  64 {
  65     //- friendship between writer data types
  66     template<class Type2> friend class surfaceWriter;
  67
  68 public:
  69
  70     //- Runtime type information
  71     TypeName("surfaceWriter");
  72
  73     // Declare run-time constructor selection table
  74
  75         declareRunTimeSelectionTable
  76         (
  77             autoPtr,
  78             surfaceWriter,
  79             word,
  80             (),
  81             ()
  82         );
  83
  84
  85     // Selectors
  86
  87         //- Return a reference to the selected surfaceWriter
  88         static autoPtr<surfaceWriter> New(const word& writeFormat);
  89
  90
  91     // Constructors
  92
  93         //- Construct null
  94         surfaceWriter();
  95
  96
  97     // Destructor
  98
  99         virtual ~surfaceWriter();
 100
 101
 102     // Member Functions
 103
 104         //- Return true if the surface format supports separate files
 105         virtual bool separateFiles()
 106         {
 107             return false;
 108         }
 109
 110
 111         //- Writes single surface geometry to file.
 112         virtual void write
 113         (
 114             const fileName& outputDir,      // <root>/<case>/surface/TIME
 115             const fileName& surfaceName,    // name of surface
 116             const pointField& points,
 117             const faceList& faces,
 118             const bool verbose = false
 119         ) const
 120         {}
 121
 122
 123         //- Writes single surface to file. Either one value per vertex or
 124         //  one value per face (detected by values.size()==faces.size())
 125         virtual void write
 126         (
 127             const fileName& outputDir,      // <root>/<case>/surface/TIME
 128             const fileName& surfaceName,    // name of surface
 129             const pointField& points,
 130             const faceList& faces,
 131             const fileName& fieldName,      // name of field
 132             const Field<Type>& values,
 133             const bool verbose = false
 134         ) const = 0;
 135 };
 136
 137
 138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 139
 140 } // End namespace Foam
 141
 142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 143
 144 #ifdef NoRepository
 145 #   include "surfaceWriter.C"
 146 #endif
 147
 148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 149
 150 #endif
 151
 152 // ************************************************************************* //