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