vtkSurfaceWriter.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation
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  A surfaceWriter for VTK legacy format
29  with support for writing ASCII or binary.
30 
31 SourceFiles
32  vtkSurfaceWriter.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef vtkSurfaceWriter_H
37 #define vtkSurfaceWriter_H
38 
39 #include "surfaceWriter.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class vtkSurfaceWriter Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class vtkSurfaceWriter
51 :
52  public surfaceWriter
53 {
54 public:
55 
56  //- Runtime type information
57  TypeName("vtk");
58 
59 
60  // Constructors
61 
62  //- Inherit constructors
64 
65 
66  //- Destructor
67  virtual ~vtkSurfaceWriter();
68 
69 
70  // Member Functions
71 
72  //- Write fields for a single surface to file.
73  virtual void write
74  (
75  const fileName& outputDir, // <case>/surface/TIME
76  const fileName& surfaceName, // name of surface
77  const pointField& points,
78  const faceList& faces,
79  const wordList& fieldNames, // names of fields
80  const bool writePointValues
81  #define FieldTypeValuesConstArg(Type, nullArg) \
82  , const UPtrList<const Field<Type>>& field##Type##Values
85  ) const;
86 
87  //- Inherit base class templated write
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
A class for handling file names.
Definition: fileName.H:79
virtual ~vtkSurfaceWriter()
Destructor.
#define FieldTypeValuesConstArg(Type, nullArg)
virtual void write(const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const wordList &fieldNames, const bool writePointValues #define FieldTypeValuesConstArg(Type, nullArg)) const
Write fields for a single surface to file.
static List< word > fieldNames
Definition: globalFoam.H:46
surfaceWriter(const IOstream::streamFormat writeFormat, const IOstream::compressionType writeCompression)
Construct given write options.
Definition: surfaceWriter.C:44
const pointField & points
virtual void write(const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const wordList &fieldNames, const bool writePointValues #define FieldTypeValuesConstArg(Type, nullArg)) const =0
Write fields for a single surface to file.
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: UPtrList.H:54
A surfaceWriter for VTK legacy format with support for writing ASCII or binary.
FOR_ALL_FIELD_TYPES(DefineFvWallInfoType)
Base class for surface writers.
Definition: surfaceWriter.H:54
rDeltaTY field()
TypeName("vtk")
Runtime type information.
Namespace for OpenFOAM.