FreeFOAM The Cross-Platform CFD Toolkit
vtkSurfaceWriter.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::vtkSurfaceWriter
26 
27 Description
28 
29 SourceFiles
30  vtkSurfaceWriter.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef vtkSurfaceWriter_H
35 #define vtkSurfaceWriter_H
36 
37 #include <sampling/surfaceWriter.H>
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 /*---------------------------------------------------------------------------*\
45  Class vtkSurfaceWriter Declaration
46 \*---------------------------------------------------------------------------*/
47 
48 template<class Type>
50 :
51  public surfaceWriter<Type>
52 {
53  // Private Member Functions
54 
55  static void writeGeometry(Ostream&, const pointField&, const faceList&);
56 
57  static void writeData(Ostream&, const Field<Type>& values);
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("vtk");
64 
65 
66  // Constructors
67 
68  //- Construct null
70 
71 
72  // Destructor
73 
74  virtual ~vtkSurfaceWriter();
75 
76 
77  // Member Functions
78 
79  // Write
80 
81  //- Write geometry to file.
82  virtual void write
83  (
84  const fileName& outputDir,
85  const fileName& surfaceName,
86  const pointField& points,
87  const faceList& faces,
88  const bool verbose = false
89  ) const;
90 
91 
92  //- Writes single surface to file.
93  virtual void write
94  (
95  const fileName& outputDir,
96  const fileName& surfaceName,
97  const pointField& points,
98  const faceList& faces,
99  const fileName& fieldName,
100  const Field<Type>& values,
101  const bool verbose = false
102  ) const;
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #ifdef NoRepository
113 # include "vtkSurfaceWriter.C"
114 #endif
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #endif
119 
120 // ************************ vim: set sw=4 sts=4 et: ************************ //