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