VTKedgeFormat.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-2019 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::VTKedgeFormat
26 
27 Description
28  Provide a means of writing VTK legacy format.
29 
30 SourceFiles
31  VTKedgeFormat.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef VTKedgeFormat_H
36 #define VTKedgeFormat_H
37 
38 #include "edgeMesh.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace fileFormats
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class VTKedgeFormat Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class VTKedgeFormat
52 :
53  public edgeMesh
54 {
55 protected:
56 
57  // Protected Member Functions
58 
59  //- Write header information with points
60  static void writeHeader
61  (
62  Ostream&,
63  const pointField&
64  );
65 
66  //- Write edges
67  static void writeEdges(Ostream&, const UList<edge>&);
68 
69 
70 public:
71 
72 
73  // Constructors
74 
75  //- Construct from file name
76  VTKedgeFormat(const fileName&);
77 
78  //- Disallow default bitwise copy construction
79  VTKedgeFormat(const VTKedgeFormat&) = delete;
80 
81 
82  // Selectors
83 
84  //- Read file and return surface
85  static autoPtr<edgeMesh> New(const fileName& name)
86  {
87  return autoPtr<edgeMesh>
88  (
89  new VTKedgeFormat(name)
90  );
91  }
92 
93 
94  //- Destructor
95  virtual ~VTKedgeFormat()
96  {}
97 
98 
99  // Member Functions
100 
101  //- Write surface mesh components by proxy
102  static void write(const fileName&, const edgeMesh&);
103 
104  //- Read from file
105  virtual bool read(const fileName&);
106 
107  //- Write object file
108  virtual void write(const fileName& name) const
109  {
110  write(name, *this);
111  }
112 
113 
114  // Member Operators
115 
116  //- Disallow default bitwise assignment
117  void operator=(const VTKedgeFormat&) = delete;
118 };
119 
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 } // End namespace fileFormats
124 } // End namespace Foam
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 #endif
129 
130 // ************************************************************************* //
A class for handling file names.
Definition: fileName.H:79
static void writeEdges(Ostream &, const UList< edge > &)
Write edges.
Definition: VTKedgeFormat.C:60
virtual ~VTKedgeFormat()
Destructor.
Definition: VTKedgeFormat.H:94
static void writeHeader(Ostream &, const pointField &)
Write header information with points.
Definition: VTKedgeFormat.C:36
virtual bool read(const fileName &)
Read from file.
Definition: VTKedgeFormat.C:90
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:60
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
static autoPtr< edgeMesh > New(const fileName &name)
Read file and return surface.
Definition: VTKedgeFormat.H:84
Points connected by edges.
Definition: edgeMesh.H:69
VTKedgeFormat(const fileName &)
Construct from file name.
Definition: VTKedgeFormat.C:79
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
void operator=(const VTKedgeFormat &)=delete
Disallow default bitwise assignment.
static void write(const fileName &, const edgeMesh &)
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
Provide a means of writing VTK legacy format.
Definition: VTKedgeFormat.H:50
Namespace for OpenFOAM.