VTKsurfaceFormat.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-2018 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::fileFormats::VTKsurfaceFormat
26 
27 Description
28  Provide a means of reading/writing VTK legacy format.
29  The output is never sorted by zone.
30 
31 SourceFiles
32  VTKsurfaceFormat.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef VTKsurfaceFormat_H
37 #define VTKsurfaceFormat_H
38 
39 #include "MeshedSurface.H"
40 #include "MeshedSurfaceProxy.H"
41 #include "UnsortedMeshedSurface.H"
42 #include "VTKsurfaceFormatCore.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 namespace fileFormats
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class VTKsurfaceFormat Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 template<class Face>
56 class VTKsurfaceFormat
57 :
58  public MeshedSurface<Face>,
60 {
61  // Private Member Functions
62 
63  //- Write header information about number of polygon points
64  static void writeHeaderPolygons(Ostream&, const UList<Face>&);
65 
66  //- Disallow default bitwise copy construct
68 
69  //- Disallow default bitwise assignment
70  void operator=(const VTKsurfaceFormat<Face>&);
71 
72 
73 public:
74 
75  // Constructors
76 
77  //- Construct from file name
78  VTKsurfaceFormat(const fileName&);
79 
80 
81  // Selectors
82 
83  //- Read file and return surface
85  {
87  (
89  );
90  }
91 
92  //- Destructor
93  virtual ~VTKsurfaceFormat()
94  {}
95 
96 
97  // Member Functions
98 
99  // Write
100 
101  //- Write surface mesh components by proxy
102  static void write(const fileName&, const MeshedSurfaceProxy<Face>&);
103 
104  //- Write UnsortedMeshedSurface, the output remains unsorted
105  static void write(const fileName&, const UnsortedMeshedSurface<Face>&);
106 
107  //- Read from file
108  virtual bool read(const fileName&);
109 
110  //- Write object file
111  virtual void write(const fileName& name) const
112  {
113  write(name, MeshedSurfaceProxy<Face>(*this));
114  }
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace fileFormats
121 } // End namespace Foam
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 #ifdef NoRepository
126  #include "VTKsurfaceFormat.C"
127 #endif
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 #endif
132 
133 // ************************************************************************* //
A surface geometry mesh, in which the surface zone information is conveyed by the &#39;zoneId&#39; associated...
Definition: MeshedSurface.H:74
A class for handling file names.
Definition: fileName.H:69
A surface geometry mesh with zone information, not to be confused with the similarly named surfaceMes...
Definition: MeshedSurface.H:72
Provide a means of reading/writing VTK legacy format. The output is never sorted by zone...
Internal class used by the VTKsurfaceFormat.
static autoPtr< MeshedSurface< Face > > New(const fileName &name)
Read file and return surface.
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition: HashTable.H:61
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
A proxy for writing MeshedSurface, UnsortedMeshedSurface and surfMesh to various file formats...
Definition: MeshedSurface.H:73
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
virtual bool read(const fileName &)
Read from file.
static void write(const fileName &, const MeshedSurfaceProxy< Face > &)
Write surface mesh components by proxy.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
virtual ~VTKsurfaceFormat()
Destructor.
Namespace for OpenFOAM.