jplotGraph.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::jplotGraph
28 
29 Description
30  jplot graph output
31 
32 SourceFiles
33  jplotGraph.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef jplotGraph_H
38 #define jplotGraph_H
39 
40 #include "graph.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class jplotGraph Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class jplotGraph
52 :
53  public graph::writer
54 {
55 
56 public:
57 
58  //- Runtime type information
59  TypeName("jplot");
60 
61  //- FileName extension for this graph format
62  static const word ext_;
63 
64 
65  // Constructors
66 
67  //- Construct null
68  jplotGraph()
69  {}
70 
71 
72  //- Destructor
73  ~jplotGraph()
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 // ************************************************************************* //
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::jplotGraph::ext
const word & ext() const
Return the appropriate fileName extension.
Definition: jplotGraph.H:82
Foam::jplotGraph::write
void write(const graph &, Ostream &os) const
Write graph in appropriate format.
Definition: jplotGraph.C:46
Foam::jplotGraph::jplotGraph
jplotGraph()
Construct null.
Definition: jplotGraph.H:67
Foam::graph::writer
Abstract base class for a graph writer.
Definition: graph.H:190
Foam::jplotGraph::TypeName
TypeName("jplot")
Runtime type information.
Foam::jplotGraph
jplot graph output
Definition: jplotGraph.H:50
Foam::jplotGraph::ext_
static const word ext_
FileName extension for this graph format.
Definition: jplotGraph.H:61
os
OBJstream os(runTime.globalPath()/outputName)
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::jplotGraph::~jplotGraph
~jplotGraph()
Destructor.
Definition: jplotGraph.H:72
graph.H
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56