src/sampling/sampledSet/writers/jplot/jplotSetWriter.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::jplotSetWriter
  27
  28 SourceFiles
  29     jplotSetWriter.C
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef jplotSetWriter_H
  34 #define jplotSetWriter_H
  35
  36 #include "writer.H"
  37 #include "vector.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 /*---------------------------------------------------------------------------*\
  45                       Class jplotSetWriter Declaration
  46 \*---------------------------------------------------------------------------*/
  47
  48 template<class Type>
  49 class jplotSetWriter
  50 :
  51     public writer<Type>
  52 {
  53
  54     // Private Member Functions
  55
  56         //- Write header
  57         Ostream& writeHeader(Ostream&) const;
  58
  59 public:
  60
  61     //- Runtime type information
  62     TypeName("jplot");
  63
  64
  65     // Constructors
  66
  67         //- Construct null
  68         jplotSetWriter();
  69
  70
  71     //- Destructor
  72     virtual ~jplotSetWriter();
  73
  74
  75     // Member Functions
  76
  77         virtual fileName getFileName
  78         (
  79             const coordSet&,
  80             const wordList&
  81         ) const;
  82
  83         void write
  84         (
  85             const coordSet&,
  86             const wordList&,
  87             const List<const Field<Type>*>&,
  88             Ostream&
  89         ) const;
  90 };
  91
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 } // End namespace Foam
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 #ifdef NoRepository
 100 #   include "jplotSetWriter.C"
 101 #endif
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #endif
 106
 107 // ************************************************************************* //