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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::xmgrGraph
28 
29 Description
30  Output and \b agr file for \em xmgrace
31  (http://plasma-gate.weizmann.ac.il/Grace/)
32 
33 SourceFiles
34  xmgrGraph.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef xmgrGraph_H
39 #define xmgrGraph_H
40 
41 #include "graph.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class xmgrGraph Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class xmgrGraph
53 :
54  public graph::writer
55 {
56 
57 public:
58 
59  //- Runtime type information
60  TypeName("xmgr");
61 
62  //- FileName extension for this graph format
63  static const word ext_;
64 
65 
66  // Constructors
67 
68  //- Construct null
69  xmgrGraph()
70  {}
71 
72 
73  //- Destructor
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 // ************************************************************************* //
Foam::graph
Class to create, store and output qgraph files.
Definition: graph.H:61
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::xmgrGraph::~xmgrGraph
~xmgrGraph()
Destructor.
Definition: xmgrGraph.H:73
Foam::xmgrGraph::ext_
static const word ext_
FileName extension for this graph format.
Definition: xmgrGraph.H:62
Foam::graph::writer
Abstract base class for a graph writer.
Definition: graph.H:190
Foam::xmgrGraph::ext
const word & ext() const
Return the appropriate fileName extension.
Definition: xmgrGraph.H:83
Foam::xmgrGraph
Output and agr file for xmgrace (http://plasma-gate.weizmann.ac.il/Grace/)
Definition: xmgrGraph.H:51
Foam::xmgrGraph::write
void write(const graph &, Ostream &os) const
Write graph in appropriate format.
Definition: xmgrGraph.C:46
os
OBJstream os(runTime.globalPath()/outputName)
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::xmgrGraph::xmgrGraph
xmgrGraph()
Construct null.
Definition: xmgrGraph.H:68
Foam::xmgrGraph::TypeName
TypeName("xmgr")
Runtime type information.
graph.H
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56