VTXHelper.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
/*
 * VTXHelper.h : collection of helper function needed by VTK::IOADIOS2 module
 *
 *  Created on: May 3, 2019
 *      Author: William F Godoy godoywf@ornl.gov
 */
 
#ifndef VTK_IO_ADIOS2_VTX_COMMON_VTXHelper_h
#define VTK_IO_ADIOS2_VTX_COMMON_VTXHelper_h
 
#include "VTXTypes.h"
 
#include <cstddef> //std::size_t
#include <set>
#include <string>
#include <utility> // std::pair
#include <vector>
 
#if VTK_MODULE_ENABLE_VTK_ParallelMPI
#include <vtk_mpi.h>
#endif
 
#include "vtkDataArray.h"
#include "vtkIdTypeArray.h"
#include "vtkSmartPointer.h"
 
#include <vtk_pugixml.h>
 
#include <adios2.h>
 
namespace vtx
{
namespace helper
{
VTK_ABI_NAMESPACE_BEGIN
 
#if VTK_MODULE_ENABLE_VTK_ParallelMPI
MPI_Comm MPIGetComm();
#endif
 
int MPIGetRank();
 
int MPIGetSize();
 
pugi::xml_document XMLDocument(const std::string& input, bool debugMode, const std::string& hint);
 
pugi::xml_node XMLNode(std::string nodeName, const pugi::xml_document& xmlDocument, bool debugMode,
  const std::string& hint, bool isMandatory = true, bool isUnique = false);
 
pugi::xml_node XMLNode(std::string nodeName, const pugi::xml_node& upperNode, bool debugMode,
  const std::string& hint, bool isMandatory = true, bool isUnique = false);
 
std::string FileToString(const std::string& fileName);
 
pugi::xml_attribute XMLAttribute(std::string attributeName, const pugi::xml_node& node,
  bool debugMode, const std::string& hint, bool isMandatory = true);
 
std::string SetToCSV(const std::set<std::string>& input) noexcept;
 
template <class T>
std::vector<T> StringToVector(const std::string& input) noexcept;
 
std::size_t TotalElements(const std::vector<std::size_t>& dimensions) noexcept;
 
types::DataSet XMLInitDataSet(
  const pugi::xml_node& dataSetNode, const std::set<std::string>& specialNames);
 
template <class T>
vtkSmartPointer<vtkDataArray> NewDataArray();
 
vtkSmartPointer<vtkIdTypeArray> NewDataArrayIdType();
 
adios2::Box<adios2::Dims> PartitionCart1D(const adios2::Dims& shape);
 
template <class T, class U>
std::vector<T> MapKeysToVector(const std::map<T, U>& input) noexcept;
 
template <class T>
void Print(const std::vector<T>& input, const std::string& name);
 
size_t LinearizePoint(const adios2::Dims& shape, const adios2::Dims& point) noexcept;
 
std::string GetFileName(const std::string& fileName) noexcept;
 
std::string GetEngineType(const std::string& fileName) noexcept;
 
bool EndsWith(const std::string& input, const std::string& ends) noexcept;
 
VTK_ABI_NAMESPACE_END
} // end namespace helper
} // end namespace vtx
 
#include "VTXHelper.inl"
 
#endif /* VTK_IO_ADIOS2_VTX_COMMON_VTXHelper_h */