Transferred copyright to the OpenFOAM Foundation
[OpenFOAM-2.0.x.git] / src / surfMesh / surfaceFormats / vtk / VTKsurfaceFormat.H
blobc0a038f0c9e4333dc7e3f5bc592d61cea059b88e
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
24 Class
25     Foam::fileFormats::VTKsurfaceFormat
27 Description
28     Provide a means of writing VTK legacy format.
29     The output is never sorted by zone.
31 SourceFiles
32     VTKsurfaceFormat.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef VTKsurfaceFormat_H
37 #define VTKsurfaceFormat_H
39 #include "MeshedSurface.H"
40 #include "MeshedSurfaceProxy.H"
41 #include "UnsortedMeshedSurface.H"
42 #include "VTKsurfaceFormatCore.H"
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 namespace Foam
48 namespace fileFormats
51 /*---------------------------------------------------------------------------*\
52                      Class VTKsurfaceFormat Declaration
53 \*---------------------------------------------------------------------------*/
55 template<class Face>
56 class VTKsurfaceFormat
58     public MeshedSurface<Face>,
59     public VTKsurfaceFormatCore
61     // Private Member Functions
63         //- Write header information about number of polygon points
64         static void writeHeaderPolygons(Ostream&, const UList<Face>&);
66         //- Disallow default bitwise copy construct
67         VTKsurfaceFormat(const VTKsurfaceFormat<Face>&);
69         //- Disallow default bitwise assignment
70         void operator=(const VTKsurfaceFormat<Face>&);
73 public:
75     // Constructors
77         //- Construct null
78         VTKsurfaceFormat();
81     //- Destructor
82     virtual ~VTKsurfaceFormat()
83     {}
86     // Member Functions
88         // Write
90             //- Write surface mesh components by proxy
91             static void write
92             (
93                 const fileName&, const MeshedSurfaceProxy<Face>&
94             );
96             //- Write UnsortedMeshedSurface, the output remains unsorted
97             static void write
98             (
99                 const fileName&, const UnsortedMeshedSurface<Face>&
100             );
103             //- Write object
104             virtual void write(Ostream& os) const
105             {
106                 write(os, MeshedSurfaceProxy<Face>(*this));
107             }
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 } // End namespace fileFormats
114 } // End namespace Foam
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 #ifdef NoRepository
119 #   include "VTKsurfaceFormat.C"
120 #endif
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 #endif
126 // ************************************************************************* //