FreeFOAM The Cross-Platform CFD Toolkit
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 | Copyright (C) 1991-2010 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::jplotSetWriter
26 
27 SourceFiles
28  jplotSetWriter.C
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef jplotSetWriter_H
33 #define jplotSetWriter_H
34 
35 #include <sampling/writer.H>
36 #include <OpenFOAM/vector.H>
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Class jplotSetWriter Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 template<class Type>
49 :
50  public writer<Type>
51 {
52 
53  // Private Member Functions
54 
55  //- Write header
56  Ostream& writeHeader(Ostream&) const;
57 
58 public:
59 
60  //- Runtime type information
61  TypeName("jplot");
62 
63 
64  // Constructors
65 
66  //- Construct null
68 
69 
70  //- Destructor
71  virtual ~jplotSetWriter();
72 
73 
74  // Member Functions
75 
76  virtual fileName getFileName
77  (
78  const coordSet&,
79  const wordList&
80  ) const;
81 
82  virtual void write
83  (
84  const coordSet&,
85  const wordList&,
86  const List<const Field<Type>*>&,
87  Ostream&
88  ) const;
89 
90  virtual void write
91  (
92  const bool writeTracks,
93  const PtrList<coordSet>&,
94  const wordList& valueSetNames,
95  const List<List<Field<Type> > >&,
96  Ostream&
97  ) const
98  {
100  (
101  "jplotSetWriter<Type>::write\n"
102  "(\n"
103  " const bool,\n"
104  " const PtrList<coordSet>&,\n"
105  " const wordList&,\n"
106  " const List<List<Field<Type> > >&,\n"
107  " Ostream&\n"
108  ") const"
109  );
110  }
111 };
112 
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 } // End namespace Foam
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #ifdef NoRepository
121 # include "jplotSetWriter.C"
122 #endif
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************ vim: set sw=4 sts=4 et: ************************ //