VTXHelper.h File Reference

#include "VTXTypes.h"
#include <cstddef>
#include <set>
#include <string>
#include <utility>
#include <vector>
#include <vtk_mpi.h>
#include "vtkDataArray.h"
#include "vtkIdTypeArray.h"
#include "vtkSmartPointer.h"
#include <vtk_pugixml.h>
#include <adios2.h>
#include "VTXHelper.inl"

Include dependency graph for VTXHelper.h:

Go to the source code of this file.

Namespaces
namespace	vtx
namespace	vtx::helper

Functions
MPI_Comm	vtx::helper::MPIGetComm ()
	Get current MPI global communicator from VTK.
int	vtx::helper::MPIGetRank ()
	Get current MPI rank from MPIGetComm.
int	vtx::helper::MPIGetSize ()
	Get current MPI size from MPIGetComm.
pugi::xml_document	vtx::helper::XMLDocument (const std::string &input, bool debugMode, const std::string &hint)
	Get safely a pugi::xml_document from XML as a string.
pugi::xml_node	vtx::helper::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.
pugi::xml_node	vtx::helper::XMLNode (std::string nodeName, const pugi::xml_node &upperNode, bool debugMode, const std::string &hint, bool isMandatory=true, bool isUnique=false)
	Overloaded version that gets a XML node from inside another node called upperNode.
std::string	vtx::helper::FileToString (const std::string &fileName)
	Translate file contents to string.
pugi::xml_attribute	vtx::helper::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.
std::string	vtx::helper::SetToCSV (const std::set< std::string > &input) noexcept
	Convert a set of strings into a csv "string1,string2,string3" string.
template<class T >
std::vector< T >	vtx::helper::StringToVector (const std::string &input) noexcept
	Converts a single string "s1 s2 s3" list to a vector vector ={ "s1", "s2", "s3" };.
std::size_t	vtx::helper::TotalElements (const std::vector< std::size_t > &dimensions) noexcept
	Return product of all dimensions components to get the total number of elements.
types::DataSet	vtx::helper::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.
template<class T >
vtkSmartPointer< vtkDataArray >	vtx::helper::NewDataArray ()
	Return a derived class of vtkDataArray specialized for supported types.
vtkSmartPointer< vtkIdTypeArray >	vtx::helper::NewDataArrayIdType ()
	Special type for vtkIdTypeArray.
adios2::Box< adios2::Dims >	vtx::helper::PartitionCart1D (const adios2::Dims &shape)
	Simple partition to load balance shape across viz processes.
template<class T , class U >
std::vector< T >	vtx::helper::MapKeysToVector (const std::map< T, U > &input) noexcept
	Map's keys to a vector.
template<class T >
void	vtx::helper::Print (const std::vector< T > &input, const std::string &name)
	Print a vector with an associated name.
size_t	vtx::helper::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::string	vtx::helper::GetFileName (const std::string &fileName) noexcept
	Set the appropriate file name based on recognized user input.
std::string	vtx::helper::GetEngineType (const std::string &fileName) noexcept
	Set the appropriate engine type based on recognized user input.
bool	vtx::helper::EndsWith (const std::string &input, const std::string &ends) noexcept
	Check if input ends with a certain (ends) string.