gnuplotGraphWriter.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  Copyright (C) 2022 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::graphWriters::gnuplotWriter
29 
30 Description
31  Output in gnuplot (http://www.gnuplot.info) format
32 
33 SourceFiles
34  gnuplotGraphWriter.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef Foam_gnuplotGraphWriter_H
39 #define Foam_gnuplotGraphWriter_H
40 
41 #include "graph.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace graphWriters
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class gnuplotWriter Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class gnuplotWriter
55 :
56  public graph::writer
57 {
58 public:
59 
60  //- Runtime type information
61  TypeNameNoDebug("gnuplot");
62 
63  //- Default construct
64  gnuplotWriter() = default;
65 
66  //- Destructor
67  ~gnuplotWriter() = default;
68 
69 
70  // Member Functions
71 
72  //- The fileName extension for this graph format
73  word ext() const { return "gplt"; }
74 
75  //- Write
76  void write(const graph&, Ostream& os) const;
77 };
78 
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 } // End namespace graphWriters
83 } // End namespace Foam
84 
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 
87 #endif
88 
89 // ************************************************************************* //
Output in gnuplot (http://www.gnuplot.info) format.
TypeNameNoDebug("gnuplot")
Runtime type information.
gnuplotWriter()=default
Default construct.
Abstract base class for a graph writer.
Definition: graph.H:189
Class to create, store and output qgraph files.
Definition: graph.H:53
void write(const graph &, Ostream &os) const
Write.
A class for handling words, derived from Foam::string.
Definition: word.H:63
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:56
OBJstream os(runTime.globalPath()/outputName)
~gnuplotWriter()=default
Destructor.
word ext() const
The fileName extension for this graph format.
Namespace for OpenFOAM.