ENH: vtkUnstructuredReader: reader for unstructured-ascii-vtk data (edgeMeshes and surfMeshes)

src/fileFormats/vtk/vtkUnstructuredReader.H

@@ -0,0 +1,332 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2012 OpenFOAM Foundation
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+Class
+    Foam::vtkUnstructuredReader
+
+Description
+    Reader for vtk unstructured legacy files
+
+SourceFiles
+    vtkUnstructuredReader.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef vtkUnstructuredReader_H
+#define vtkUnstructuredReader_H
+
+#include "objectRegistry.H"
+#include "cellShapeList.H"
+#include "HashSet.H"
+#include "NamedEnum.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+
+// Forward declaration of friend functions and operators
+
+
+/*---------------------------------------------------------------------------*\
+                     Class vtkUnstructuredReader Declaration
+\*---------------------------------------------------------------------------*/
+
+class vtkUnstructuredReader
+{
+public:
+
+    // Public data types
+
+        //- Enumeration defining the vtk data types
+        enum vtkDataType
+        {
+            VTK_INT,
+            VTK_FLOAT,
+            VTK_STRING
+        };
+
+        static const NamedEnum<vtkDataType, 3> vtkDataTypeNames;
+
+
+        //- Enumeration defining the vtk dataset types
+        enum vtkDataSetType
+        {
+            VTK_FIELD,
+            VTK_SCALARS,
+            VTK_VECTORS
+        };
+
+        static const NamedEnum<vtkDataSetType, 3> vtkDataSetTypeNames;
+
+
+        //- Enumeration defining the parse mode - what type of data is being
+        //  read
+        enum parseMode
+        {
+            NOMODE,
+            UNSTRUCTURED_GRID,
+            POLYDATA,
+            CELL_DATA,
+            POINT_DATA
+        };
+
+        static const NamedEnum<parseMode, 5> parseModeNames;
+
+
+        //- Enumeration defining the cell types
+        enum vtkTypes
+        {
+            VTK_EMPTY_CELL       = 0,
+            VTK_VERTEX           = 1,
+            VTK_POLY_VERTEX      = 2,
+            VTK_LINE             = 3,
+            VTK_POLY_LINE        = 4,
+            VTK_TRIANGLE         = 5,
+            VTK_TRIANGLE_STRIP   = 6,
+            VTK_POLYGON          = 7,
+            VTK_PIXEL            = 8,
+            VTK_QUAD             = 9,
+            VTK_TETRA            = 10,
+            VTK_VOXEL            = 11,
+            VTK_HEXAHEDRON       = 12,
+            VTK_WEDGE            = 13,
+            VTK_PYRAMID          = 14,
+            VTK_PENTAGONAL_PRISM = 15,
+            VTK_HEXAGONAL_PRISM  = 16,
+        };
+
+
+private:
+
+    //- Header
+    string header_;
+
+    //- Title
+    string title_;
+
+    //- DataType
+    string dataType_;
+
+
+    // Geometry
+
+        //- Points
+        pointField points_;
+
+        //- 3D cells.
+        cellShapeList cells_;
+
+        //- 2D cells (=faces)
+        faceList faces_;
+
+        //- 1D cells (=edges)
+        labelListList lines_;
+
+
+    // Data
+
+        //- cell based fields
+        objectRegistry cellData_;
+
+        //- point based fields
+        objectRegistry pointData_;
+
+        //- other fields
+        objectRegistry otherData_;
+
+
+
+    // Private Member Functions
+
+        template<class T>
+        void readBlock
+        (
+            Istream& inFile,
+            const label n,
+            List<T>& lst
+        ) const;
+
+        void warnUnhandledType
+        (
+            Istream& inFile,
+            const label type,
+            labelHashSet& warningGiven
+        ) const;
+
+        void extractCells
+        (
+            Istream& inFile,
+            const labelList& cellTypes,
+            const labelList& cellVertData
+        );
+
+        void readField
+        (
+            ISstream& inFile,
+            objectRegistry& obj,
+            const word& arrayName,
+            const word& dataType,
+            const label size
+        ) const;
+
+        wordList readFieldArray
+        (
+            ISstream& inFile,
+            objectRegistry& obj,
+            const label wantedSize
+        ) const;
+
+        objectRegistry& selectRegistry(const parseMode readMode);
+
+        void read(ISstream& inFile);
+
+        //- Dissallow assignment
+        void operator=(const vtkUnstructuredReader&);
+
+
+public:
+
+    //- Runtime type information
+    ClassName("vtkUnstructuredReader");
+
+    // Constructors
+
+        //- Construct from Istream, read all
+        vtkUnstructuredReader(const objectRegistry& obr, ISstream&);
+
+    // Member Functions
+
+        //- Header
+        const string header() const
+        {
+            return header_;
+        }
+
+        //- Title
+        const string& title() const
+        {
+            return title_;
+        }
+
+        //- DataType
+        const string& dataType() const
+        {
+            return dataType_;
+        }
+
+
+        //- Points
+        const pointField& points() const
+        {
+            return points_;
+        }
+
+        pointField& points()
+        {
+            return points_;
+        }
+
+        //- 3D cells.
+        const cellShapeList& cells() const
+        {
+            return cells_;
+        }
+
+        cellShapeList& cells()
+        {
+            return cells_;
+        }
+
+        //- 2D cells (=faces)
+        const faceList& faces() const
+        {
+            return faces_;
+        }
+
+        faceList& faces()
+        {
+            return faces_;
+        }
+
+        //- 1D cells (=open lines)
+        const labelListList& lines() const
+        {
+            return lines_;
+        }
+
+        labelListList& lines()
+        {
+            return lines_;
+        }
+
+        //- cell based fields
+        const objectRegistry& cellData() const
+        {
+            return cellData_;
+        }
+
+        objectRegistry& cellData()
+        {
+            return cellData_;
+        }
+
+        //- point based fields
+        const objectRegistry& pointData() const
+        {
+            return pointData_;
+        }
+
+        objectRegistry& pointData()
+        {
+            return pointData_;
+        }
+
+        //- other fields
+        const objectRegistry& otherData() const
+        {
+            return otherData_;
+        }
+
+        objectRegistry& otherData()
+        {
+            return otherData_;
+        }
+
+
+        //- Debug: print contents of objectRegistry
+        template<class Type>
+        void printFieldStats(const objectRegistry&) const;
+
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //