vtkIOSSUtilities Namespace Reference

internal utilities for vtkIOSSReader More...

Classes
class	Cache
	Cache. More...
class	CaptureNonErrorMessages
	A helper to instantiate on stack to temporarily redirect non-critical messages emanating from IOSS. More...

Typedefs
using	EntityNameType = std::pair<vtkTypeUInt64, std::string>
using	ArrayList
	List of possible ArrayTypes that are produced by vtkIOSSUtilities.

Enumerations
enum	DatabaseFormatType { UNKNOWN , EXODUS , CGNS , CATALYST }

Functions
std::vector< std::pair< int, double > >	GetTime (const Ioss::Region *region)
	Reads time / timestep information from a region.
std::string	GetSanitizedBlockName (const Ioss::Region *region, const std::string &name)
	This is primarily intended for CGNS.
template<typename EntityType>
void	GetEntityAndFieldNames (const Ioss::Region *region, const std::vector< EntityType * > &entities, std::set< EntityNameType > &entity_names, std::set< std::string > &field_names)
	Populates entitySelection with available entity block (or set) names and populates fieldSelection with transient and attribute fields on the chosen entity block (or set).
void	GetGlobalFieldNames (const Ioss::Region *region, std::set< std::string > &field_names)
	Reads global fields from the region and populates field_names.
template<>
void	GetEntityAndFieldNames< Ioss::SideSet > (const Ioss::Region *region, const std::vector< Ioss::SideSet * > &entities, std::set< EntityNameType > &entity_names, std::set< std::string > &field_names)
	Specialization for Ioss::SideSet (see paraview/paraview#21231).
Ioss::EntityType	GetIOSSEntityType (vtkIOSSReader::EntityType vtk_type)
	For the given vtkIOSSReader::EntityType return the corresponding Ioss::EntityType.
vtkSmartPointer< vtkDataArray >	CreateArray (const Ioss::Field &field)
	Create an array for the given field.
vtkSmartPointer< vtkDataArray >	GetData (const Ioss::GroupingEntity *entity, const std::string &fieldname, Ioss::Transform *transform=nullptr, Cache *cache=nullptr, const std::string &cachekey=std::string())
	Returns a VTK array for a given field (fieldname) on the chosen block (or set) entity.
int	GetCellType (const Ioss::ElementTopology *topology)
	Returns VTK celltype for a Ioss topology element.
const Ioss::ElementTopology *	GetElementTopology (int vtk_cell_type)
	Returns an Ioss topology element, if possible, given a VTK cell type.
vtkSmartPointer< vtkCellArray >	GetConnectivity (Ioss::GroupingEntity *group_entity, int &vtk_topology_type, Cache *cache=nullptr)
	Read connectivity information from the group_entity.
vtkSmartPointer< vtkPoints >	GetMeshModelCoordinates (const Ioss::GroupingEntity *group_entity, Cache *cache=nullptr)
	Read points from the group_entity.
bool	IsFieldTransient (const Ioss::GroupingEntity *entity, const std::string &fieldname)
	Returns true if the field is transient.
void	InitializeEnvironmentForIOSS ()
	Must be called before using any Ioss library functions.
DatabaseFormatType	DetectType (const std::string &dbaseName)
	Given a filename determines and returns the database type.
DatabaseFormatType	GetFormat (const Ioss::GroupingEntity *entity)
	Given any GroupingEntity pointer, returns the format that the associated database is in.
std::vector< Ioss::StructuredBlock * >	GetMatchingStructuredBlocks (Ioss::Region *region, const std::string &blockname)
	Returns collection of StructuredBlock's matching the selected blockname.
std::string	GetDisplacementFieldName (Ioss::GroupingEntity *nodeblock)
	Finds a displacement field name.
std::string	GetDisplacementFieldName (vtkDataSet *dataset)
	Finds a displacement field name.

Detailed Description

internal utilities for vtkIOSSReader

vtkIOSSReader provides some helper functions to go between VTK and Ioss. Not intended for public consumption. API likely to change without notice.

Developer Notes

We limit this namespace for utility functions that go between Ioss and VTK or vice-versa. Thus, methods that are not straddling that fence should be not be added here.

Typedef Documentation

EntityNameType

using vtkIOSSUtilities::EntityNameType = std::pair<vtkTypeUInt64, std::string>

Definition at line 116 of file vtkIOSSUtilities.h.

ArrayList

using vtkIOSSUtilities::ArrayList

Initial value:

 typename vtkTypeList::Unique<
  vtkTypeList::Create<vtkDoubleArray, vtkTypeInt32Array, vtkTypeInt64Array>>::Result

List of possible ArrayTypes that are produced by vtkIOSSUtilities.

This can be used with vtkArrayDispatch::DispatchByArray, etc. when dealing with arrays read from Ioss.

Definition at line 124 of file vtkIOSSUtilities.h.

Enumeration Type Documentation

DatabaseFormatType

enum vtkIOSSUtilities::DatabaseFormatType

Enumerator
UNKNOWN
EXODUS
CGNS
CATALYST

Definition at line 51 of file vtkIOSSUtilities.h.

Function Documentation

GetTime()

std::vector< std::pair< int, double > > vtkIOSSUtilities::GetTime

(

const Ioss::Region *

region

)

Reads time / timestep information from a region.

Returns an empty vector if no time information in available in the Ioss::Region.

GetSanitizedBlockName()

std::string vtkIOSSUtilities::GetSanitizedBlockName

(