jplotSetWriter.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-2016 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::jplotSetWriter
28 
29 SourceFiles
30  jplotSetWriter.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef jplotSetWriter_H
35 #define jplotSetWriter_H
36 
37 #include "writer.H"
38 #include "vector.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class jplotSetWriter Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class Type>
50 class jplotSetWriter
51 :
52  public writer<Type>
53 {
54 
55  // Private Member Functions
56 
57  //- Write header
58  Ostream& writeHeader(Ostream&) const;
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("jplot");
64 
65 
66  // Constructors
67 
68  //- Construct null
70 
71 
72  //- Destructor
73  virtual ~jplotSetWriter();
74 
75 
76  // Member Functions
77 
78  virtual fileName getFileName
79  (
80  const coordSet&,
81  const wordList&
82  ) const;
83 
84  virtual void write
85  (
86  const coordSet&,
87  const wordList&,
88  const List<const Field<Type>*>&,
89  Ostream&
90  ) const;
91 
92  virtual void write
93  (
94  const bool writeTracks,
95  const PtrList<coordSet>&,
96  const wordList& valueSetNames,
97  const List<List<Field<Type>>>&,
98  Ostream&
99  ) const
100  {
102  }
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #ifdef NoRepository
113  #include "jplotSetWriter.C"
114 #endif
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #endif
119 
120 // ************************************************************************* //
Foam::fileName
A class for handling file names.
Definition: fileName.H:69
Foam::jplotSetWriter::~jplotSetWriter
virtual ~jplotSetWriter()
Destructor.
Definition: jplotSetWriter.C:59
Foam::jplotSetWriter
Definition: jplotSetWriter.H:49
Foam::jplotSetWriter::jplotSetWriter
jplotSetWriter()
Construct null.
Definition: jplotSetWriter.C:50
jplotSetWriter.C
NotImplemented
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:445
Foam::Field
Generic templated field type.
Definition: Field.H:63
Foam::PtrList
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
Definition: List.H:62
Foam::jplotSetWriter::write
virtual void write(const coordSet &, const wordList &, const List< const Field< Type > * > &, Ostream &) const
General entry point for writing.
Definition: jplotSetWriter.C:78
Foam::writer
Base class for graphics format writing. Entry points are.
Definition: writer.H:80
Foam::coordSet
Holds list of sampling positions.
Definition: coordSet.H:53
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::jplotSetWriter::TypeName
TypeName("jplot")
Runtime type information.
Foam::jplotSetWriter::getFileName
virtual fileName getFileName(const coordSet &, const wordList &) const
Generate file name with correct extension.
Definition: jplotSetWriter.C:67
Foam::List< word >
vector.H
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
writer.H