VTK  9.3.20240327
VTXHelper.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
3 
4 /*
5  * VTXHelper.h : collection of helper function needed by VTK::IOADIOS2 module
6  *
7  * Created on: May 3, 2019
8  * Author: William F Godoy godoywf@ornl.gov
9  */
10 
11 #ifndef VTK_IO_ADIOS2_VTX_COMMON_VTXHelper_h
12 #define VTK_IO_ADIOS2_VTX_COMMON_VTXHelper_h
13 
14 #include "VTXTypes.h"
15 
16 #include <cstddef> //std::size_t
17 #include <set>
18 #include <string>
19 #include <utility> // std::pair
20 #include <vector>
21 
22 #if VTK_MODULE_ENABLE_VTK_ParallelMPI
23 #include <vtk_mpi.h>
24 #endif
25 
26 #include "vtkDataArray.h"
27 #include "vtkIdTypeArray.h"
28 #include "vtkSmartPointer.h"
29 
30 #include <vtk_pugixml.h>
31 
32 #include <adios2.h>
33 
34 namespace vtx
35 {
36 namespace helper
37 {
38 VTK_ABI_NAMESPACE_BEGIN
39 
40 #if VTK_MODULE_ENABLE_VTK_ParallelMPI
42 MPI_Comm MPIGetComm();
43 #endif
44 
46 int MPIGetRank();
47 
49 int MPIGetSize();
50 
60 pugi::xml_document XMLDocument(const std::string& input, bool debugMode, const std::string& hint);
61 
73 pugi::xml_node XMLNode(std::string nodeName, const pugi::xml_document& xmlDocument, bool debugMode,
74  const std::string& hint, bool isMandatory = true, bool isUnique = false);
75 
88 pugi::xml_node XMLNode(std::string nodeName, const pugi::xml_node& upperNode, bool debugMode,
89  const std::string& hint, bool isMandatory = true, bool isUnique = false);
90 
97 
108 pugi::xml_attribute XMLAttribute(std::string attributeName, const pugi::xml_node& node,
109  bool debugMode, const std::string& hint, bool isMandatory = true);
110 
116 std::string SetToCSV(const std::set<std::string>& input) noexcept;
117 
124 template <class T>
125 std::vector<T> StringToVector(const std::string& input) noexcept;
126 
132 std::size_t TotalElements(const std::vector<std::size_t>& dimensions) noexcept;
133 
143 types::DataSet XMLInitDataSet(const pugi::xml_node& dataSetNode,
144  const std::set<std::string>& specialNames, bool persist = false);
145 
150 template <class T>
152 
158 
164 adios2::Box<adios2::Dims> PartitionCart1D(const adios2::Dims& shape);
165 
171 template <class T, class U>
172 std::vector<T> MapKeysToVector(const std::map<T, U>& input) noexcept;
173 
179 template <class T>
180 void Print(const std::vector<T>& input, const std::string& name);
181 
188 size_t LinearizePoint(const adios2::Dims& shape, const adios2::Dims& point) noexcept;
189 
195 std::string GetFileName(const std::string& fileName) noexcept;
196 
202 std::string GetEngineType(const std::string& fileName) noexcept;
203 
210 bool EndsWith(const std::string& input, const std::string& ends) noexcept;
211 
212 VTK_ABI_NAMESPACE_END
213 } // end namespace helper
214 } // end namespace vtx
215 
216 #include "VTXHelper.inl"
217 
218 #endif /* VTK_IO_ADIOS2_VTX_COMMON_VTXHelper_h */
@ point
Definition: vtkX3D.h:236
@ name
Definition: vtkX3D.h:219
@ string
Definition: vtkX3D.h:490
types::DataSet XMLInitDataSet(const pugi::xml_node &dataSetNode, const std::set< std::string > &specialNames, bool persist=false)
Initialize DataSet structure from parsing a pugi::xml_node, loops through DataArray nodes.
vtkSmartPointer< vtkDataArray > NewDataArray()
Return a derived class of vtkDataArray specialized for supported types.
bool EndsWith(const std::string &input, const std::string &ends) noexcept
Check if input ends with a certain (ends) string.
std::string GetEngineType(const std::string &fileName) noexcept
Set the appropriate engine type based on recognized user input.
std::string FileToString(const std::string &fileName)
Translate file contents to string.
pugi::xml_attribute XMLAttribute(std::string attributeName, const pugi::xml_node &node, bool debugMode, const std::string &hint, bool isMandatory=true)
Get a node attribute identified by its key.
vtkSmartPointer< vtkIdTypeArray > NewDataArrayIdType()
Special type for vtkIdTypeArray.
std::size_t TotalElements(const std::vector< std::size_t > &dimensions) noexcept
Return product of all dimensions components to get the total number of elements.
adios2::Box< adios2::Dims > PartitionCart1D(const adios2::Dims &shape)
Simple partition to load balance shape across viz processes.
std::vector< T > MapKeysToVector(const std::map< T, U > &input) noexcept
Map's keys to a vector.
size_t LinearizePoint(const adios2::Dims &shape, const adios2::Dims &point) noexcept
Linear index for a point within a box with shape dimensions from zero origin.
std::vector< T > StringToVector(const std::string &input) noexcept
Converts a single string "s1 s2 s3" list to a vector vector ={ "s1", "s2", "s3" };.
int MPIGetSize()
Get current MPI size from MPIGetComm.
pugi::xml_document XMLDocument(const std::string &input, bool debugMode, const std::string &hint)
Get safely a pugi::xml_document from XML as a string.
std::string GetFileName(const std::string &fileName) noexcept
Set the appropriate file name based on recognized user input.
void Print(const std::vector< T > &input, const std::string &name)
Print a vector with an associated name.
pugi::xml_node XMLNode(std::string nodeName, const pugi::xml_document &xmlDocument, bool debugMode, const std::string &hint, bool isMandatory=true, bool isUnique=false)
Get safely a pugi::xml_document from a pugmi::xml_document.
std::string SetToCSV(const std::set< std::string > &input) noexcept
Convert a set of strings into a csv "string1,string2,string3" string.
int MPIGetRank()
Get current MPI rank from MPIGetComm.
std::map< std::string, DataArray > DataSet
key: variable name, value: DataArray
Definition: VTXTypes.h:28