src/OpenFOAM/graph/writers/xmgrGraph/xmgrGraph.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::xmgrGraph
  27
  28 Description
  29     Output and @b agr file for @em xmgrace
  30     (http://plasma-gate.weizmann.ac.il/Grace/)
  31
  32 SourceFiles
  33     xmgrGraph.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef xmgrGraph_H
  38 #define xmgrGraph_H
  39
  40 #include "graph.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class xmgrGraph Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class xmgrGraph
  52 :
  53     public graph::writer
  54 {
  55
  56 public:
  57
  58     //- Runtime type information
  59     TypeName("xmgr");
  60
  61     //- FileName extension  for this graph format
  62     static const word ext_;
  63
  64
  65     // Constructors
  66
  67         //- Construct null
  68         xmgrGraph()
  69         {}
  70
  71
  72     // Destructor
  73
  74         ~xmgrGraph()
  75         {}
  76
  77
  78     // Member Functions
  79
  80         // Access
  81
  82             //- Return the appropriate fileName extension
  83             //  for this graph format
  84             const word& ext() const
  85             {
  86                 return ext_;
  87             }
  88
  89
  90         // Write
  91
  92             void write(const graph&, Ostream& os) const;
  93 };
  94
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 } // End namespace Foam
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 #endif
 103
 104 // ************************************************************************* //