vtkXdmf3DataSet.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkXdmf3DataSet_h
#define vtkXdmf3DataSet_h
 
#include "vtkIOXdmf3Module.h" // For export macro
 
// clang-format off
#include "vtk_xdmf3.h"
#include VTKXDMF3_HEADER(core/XdmfSharedPtr.hpp)
// clang-format on
 
#include <string> //Needed only for XdmfArray::getName :(
 
class XdmfArray;
class XdmfAttribute;
class XdmfGrid;
class XdmfSet;
class XdmfTopologyType;
class XdmfRegularGrid;
class XdmfRectilinearGrid;
class XdmfCurvilinearGrid;
class XdmfUnstructuredGrid;
class XdmfGraph;
class XdmfDomain;
 
VTK_ABI_NAMESPACE_BEGIN
class vtkXdmf3ArraySelection;
class vtkXdmf3ArrayKeeper;
class vtkDataArray;
class vtkDataObject;
class vtkDataSet;
class vtkImageData;
class vtkRectilinearGrid;
class vtkStructuredGrid;
class vtkUnstructuredGrid;
class vtkPointSet;
class vtkMutableDirectedGraph;
class vtkDirectedGraph;
 
class VTKIOXDMF3_EXPORT vtkXdmf3DataSet
{
public:
  // Common
 
  static vtkDataArray* XdmfToVTKArray(XdmfArray* xArray,
    std::string attrName, // TODO: needed because XdmfArray::getName() misbehaves
    unsigned int preferredComponents = 0, vtkXdmf3ArrayKeeper* keeper = nullptr);
 
  static bool VTKToXdmfArray(
    vtkDataArray* vArray, XdmfArray* xArray, unsigned int rank = 0, unsigned int* dims = nullptr);
 
  static void XdmfToVTKAttributes(vtkXdmf3ArraySelection* fselection,
    vtkXdmf3ArraySelection* cselection, vtkXdmf3ArraySelection* pselection, XdmfGrid* grid,
    vtkDataObject* dObject, vtkXdmf3ArrayKeeper* keeper = nullptr);
 
  static void VTKToXdmfAttributes(vtkDataObject* dObject, XdmfGrid* grid);
 
 
  static unsigned int GetNumberOfPointsPerCell(int vtk_cell_type, bool& fail);
  static int GetVTKCellType(shared_ptr<const XdmfTopologyType> topologyType);
  static int GetXdmfCellType(int vtkType);
 
 
  static void SetTime(XdmfGrid* grid, double hasTime, double time);
  static void SetTime(XdmfGraph* graph, double hasTime, double time);
 
  // vtkXdmf3RegularGrid
 
  static void XdmfToVTK(vtkXdmf3ArraySelection* fselection, vtkXdmf3ArraySelection* cselection,
    vtkXdmf3ArraySelection* pselection, XdmfRegularGrid* grid, vtkImageData* dataSet,
    vtkXdmf3ArrayKeeper* keeper = nullptr);
 
  static void CopyShape(
    XdmfRegularGrid* grid, vtkImageData* dataSet, vtkXdmf3ArrayKeeper* keeper = nullptr);
 
  static void VTKToXdmf(vtkImageData* dataSet, XdmfDomain* domain, bool hasTime, double time,
    const char* name = nullptr);
 
  // vtkXdmf3RectilinearGrid
  static void XdmfToVTK(vtkXdmf3ArraySelection* fselection, vtkXdmf3ArraySelection* cselection,
    vtkXdmf3ArraySelection* pselection, XdmfRectilinearGrid* grid, vtkRectilinearGrid* dataSet,
    vtkXdmf3ArrayKeeper* keeper = nullptr);
 
  static void CopyShape(
    XdmfRectilinearGrid* grid, vtkRectilinearGrid* dataSet, vtkXdmf3ArrayKeeper* keeper = nullptr);
 
  static void VTKToXdmf(vtkRectilinearGrid* dataSet, XdmfDomain* domain, bool hasTime, double time,
    const char* name = nullptr);
 
  // vtkXdmf3CurvilinearGrid
  static void XdmfToVTK(vtkXdmf3ArraySelection* fselection, vtkXdmf3ArraySelection* cselection,
    vtkXdmf3ArraySelection* pselection, XdmfCurvilinearGrid* grid, vtkStructuredGrid* dataSet,
    vtkXdmf3ArrayKeeper* keeper = nullptr);
 
  static void CopyShape(
    XdmfCurvilinearGrid* grid, vtkStructuredGrid* dataSet, vtkXdmf3ArrayKeeper* keeper = nullptr);
 
  static void VTKToXdmf(vtkStructuredGrid* dataSet, XdmfDomain* domain, bool hasTime, double time,
    const char* name = nullptr);
 
  // vtkXdmf3UnstructuredGrid
  static void XdmfToVTK(vtkXdmf3ArraySelection* fselection, vtkXdmf3ArraySelection* cselection,
    vtkXdmf3ArraySelection* pselection, XdmfUnstructuredGrid* grid, vtkUnstructuredGrid* dataSet,
    vtkXdmf3ArrayKeeper* keeper = nullptr);
 
  static void CopyShape(XdmfUnstructuredGrid* grid, vtkUnstructuredGrid* dataSet,
    vtkXdmf3ArrayKeeper* keeper = nullptr);
 
  static void VTKToXdmf(vtkPointSet* dataSet, XdmfDomain* domain, bool hasTime, double time,
    const char* name = nullptr);
 
  // vtkXdmf3Graph
  static void XdmfToVTK(vtkXdmf3ArraySelection* fselection, vtkXdmf3ArraySelection* cselection,
    vtkXdmf3ArraySelection* pselection, XdmfGraph* grid, vtkMutableDirectedGraph* dataSet,
    vtkXdmf3ArrayKeeper* keeper = nullptr);
 
  static void VTKToXdmf(vtkDirectedGraph* dataSet, XdmfDomain* domain, bool hasTime, double time,
    const char* name = nullptr);
 
  // Side Sets
 
  static void XdmfToVTKAttributes(
    /*
        vtkXdmf3ArraySelection *fselection,
        vtkXdmf3ArraySelection *cselection,
        vtkXdmf3ArraySelection *pselection,
    */
    XdmfSet* grid, vtkDataObject* dObject, vtkXdmf3ArrayKeeper* keeper = nullptr);
 
  static void XdmfSubsetToVTK(XdmfGrid* grid, unsigned int setnum, vtkDataSet* dataSet,
    vtkUnstructuredGrid* subSet, vtkXdmf3ArrayKeeper* keeper = nullptr);
 
  static int GetVTKFiniteElementCellType(unsigned int element_degree,
    const std::string& element_family, shared_ptr<const XdmfTopologyType> topologyType);
 
  static void ParseFiniteElementFunction(vtkDataObject* dObject,
    shared_ptr<XdmfAttribute> xmfAttribute, vtkDataArray* array, XdmfGrid* grid,
    vtkXdmf3ArrayKeeper* keeper = nullptr);
};
 
VTK_ABI_NAMESPACE_END
#endif
// VTK-HeaderTest-Exclude: vtkXdmf3DataSet.h