xmgraceGraphWriter.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-------------------------------------------------------------------------------
11License
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
27Class
28 Foam::graphWriters::xmgraceWriter
29
30Description
31 Output and \b agr file for \em xmgrace
32 (http://plasma-gate.weizmann.ac.il/Grace/)
33
34SourceFiles
35 xmgraceGraphWriter.C
36
37\*---------------------------------------------------------------------------*/
38
39#ifndef Foam_xmgraceGraphWriter_H
40#define Foam_xmgraceGraphWriter_H
41
42#include "graph.H"
43
44// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46namespace Foam
47{
48namespace graphWriters
49{
50
51/*---------------------------------------------------------------------------*\
52 Class xmgraceWriter Declaration
53\*---------------------------------------------------------------------------*/
55class xmgraceWriter
56:
57 public graph::writer
58{
59public:
60
61 //- Runtime type information
62 TypeNameNoDebug("xmgr");
63
64 //- Default construct
65 xmgraceWriter() = default;
66
67 //- Destructor
68 ~xmgraceWriter() = default;
69
70
71 // Member Functions
72
73 //- The fileName extension for this graph format
74 word ext() const { return "agr"; }
75
76 //- Write
77 void write(const graph&, Ostream& os) const;
78};
79
80
81// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82
83} // End namespace graphWriters
84} // End namespace Foam
85
86// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87
88#endif
89
90// ************************************************************************* //
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
Output and agr file for xmgrace (http://plasma-gate.weizmann.ac.il/Grace/)
~xmgraceWriter()=default
Destructor.
xmgraceWriter()=default
Default construct.
TypeNameNoDebug("xmgr")
Runtime type information.
word ext() const
The fileName extension for this graph format.
Abstract base class for a graph writer.
Definition: graph.H:186
Class to create, store and output qgraph files.
Definition: graph.H:62
A class for handling words, derived from Foam::string.
Definition: word.H:68
OBJstream os(runTime.globalPath()/outputName)
Namespace for OpenFOAM.
runTime write()
#define TypeNameNoDebug(TypeNameString)
Declare a ClassNameNoDebug() with extra virtual type info.
Definition: typeInfo.H:68