vtkConduitArrayUtilities.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 vtkConduitArrayUtilities_h
#define vtkConduitArrayUtilities_h
 
#include "vtkDeprecation.h"             // for VTK_DEPRECATED_IN_9_5_0
#include "vtkIOCatalystConduitModule.h" // for exports
#include "vtkObject.h"
#include "vtkSmartPointer.h" // for vtkSmartPointer
 
#include "conduit.h" // for conduit_node
 
#include <string> // for std::string
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCellArray;
class vtkDataArray;
 
class VTKIOCATALYSTCONDUIT_EXPORT vtkConduitArrayUtilities : public vtkObject
{
public:
  static vtkConduitArrayUtilities* New();
  vtkTypeMacro(vtkConduitArrayUtilities, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static bool IsDevicePointer(const void* p, int8_t& id, bool& working);


  static vtkSmartPointer<vtkDataArray> MCArrayToVTKArray(const conduit_node* mcarray);
  static vtkSmartPointer<vtkDataArray> MCArrayToVTKArray(
    const conduit_node* mcarray, const std::string& arrayname);


  VTK_DEPRECATED_IN_9_5_0("This function is deprecated, because in the future "
                          "state/metadata/vtk_fields will only be used.")
  static vtkSmartPointer<vtkDataArray> MCGhostArrayToVTKGhostArray(
    const conduit_node* mcarray, bool is_cell_data);

  VTK_DEPRECATED_IN_9_4_0("Version with additional `numberOfPoints` parameter needed with "
                          "zero-copy arrays stored on acceleration devices such as CUDA")
  static vtkSmartPointer<vtkCellArray> MCArrayToVTKCellArray(
    int cellType, vtkIdType cellSize, const conduit_node* mcarray);
  static vtkSmartPointer<vtkCellArray> MCArrayToVTKCellArray(
    vtkIdType numberOfPoints, int cellType, vtkIdType cellSize, const conduit_node* mcarray);

  static vtkSmartPointer<vtkDataArray> SetNumberOfComponents(
    vtkDataArray* array, int num_components);

  VTK_DEPRECATED_IN_9_4_0("Version with additional `numberOfPoints` parameter needed with "
                          "zero-copy arrays stored on acceleration devices such as CUDA. "
                          "`leafname` is always connectivity, so it is removed in the new version.")
  static vtkSmartPointer<vtkCellArray> O2MRelationToVTKCellArray(
    const conduit_node* o2mrelation, const std::string& leafname);
  static vtkSmartPointer<vtkCellArray> O2MRelationToVTKCellArray(
    vtkIdType numberOfPoints, const conduit_node* o2mrelation);
 
protected:
  vtkConduitArrayUtilities();
  ~vtkConduitArrayUtilities() override;
 
  static bool IsDevicePointer(const void* p, int8_t& id);
  static vtkSmartPointer<vtkDataArray> MCArrayToVTKArrayImpl(
    const conduit_node* mcarray, bool force_signed);
  static vtkSmartPointer<vtkDataArray> MCArrayToVTKAOSArray(
    const conduit_node* mcarray, bool force_signed);
  static vtkSmartPointer<vtkDataArray> MCArrayToVTKSOAArray(
    const conduit_node* mcarray, bool force_signed);
 
private:
  vtkConduitArrayUtilities(const vtkConduitArrayUtilities&) = delete;
  void operator=(const vtkConduitArrayUtilities&) = delete;
};
 
VTK_ABI_NAMESPACE_END
 
#endif