src/sampling/sampledSet/writers/gnuplot/gnuplotSetWriter.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-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::gnuplotSetWriter
  26
  27 Description
  28
  29 SourceFiles
  30     gnuplotSetWriter.C
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef gnuplotSetWriter_H
  35 #define gnuplotSetWriter_H
  36
  37 #include "writer.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45                      Class gnuplotSetWriter Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 template<class Type>
  49 class gnuplotSetWriter
  50 :
  51     public writer<Type>
  52 {
  53
  54 public:
  55
  56     //- Runtime type information
  57     TypeName("gnuplot");
  58
  59
  60     // Constructors
  61
  62         //- Construct null
  63         gnuplotSetWriter();
  64
  65
  66     //- Destructor
  67     virtual ~gnuplotSetWriter();
  68
  69
  70     // Member Functions
  71
  72         virtual fileName getFileName
  73         (
  74             const coordSet&,
  75             const wordList&
  76         ) const;
  77
  78         virtual void write
  79         (
  80             const coordSet&,
  81             const wordList&,
  82             const List<const Field<Type>*>&,
  83             Ostream&
  84         ) const;
  85
  86         virtual void write
  87         (
  88             const bool writeTracks,
  89             const PtrList<coordSet>&,
  90             const wordList& valueSetNames,
  91             const List<List<Field<Type> > >&,
  92             Ostream&
  93         ) const;
  94 };
  95
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 } // End namespace Foam
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 #ifdef NoRepository
 104 #   include "gnuplotSetWriter.C"
 105 #endif
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 #endif
 110
 111 // ************************************************************************* //