Reader for IOSS (Sierra IO System) More...

#include <vtkIOSSReader.h>

Inheritance diagram for vtkIOSSReader:

Collaboration diagram for vtkIOSSReader:

Public Types
enum	EntityType { NODEBLOCK , EDGEBLOCK , FACEBLOCK , ELEMENTBLOCK , STRUCTUREDBLOCK , NODESET , EDGESET , FACESET , ELEMENTSET , SIDESET , NUMBER_OF_ENTITY_TYPES , BLOCK_START = NODEBLOCK , BLOCK_END = NODESET , SET_START = NODESET , SET_END = NUMBER_OF_ENTITY_TYPES , ENTITY_START = NODEBLOCK , ENTITY_END = NUMBER_OF_ENTITY_TYPES }

typedef vtkReaderAlgorithm	Superclass

Public Types inherited from vtkReaderAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkIOSSReader *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	SetFileName (VTK_FILEPATH const char *fname)
	Set a single filename.

vtkDataArraySelection *	GetEntitySelection (int type)

vtkDataArraySelection *	GetNodeBlockSelection ()

vtkDataArraySelection *	GetEdgeBlockSelection ()

vtkDataArraySelection *	GetFaceBlockSelection ()

vtkDataArraySelection *	GetElementBlockSelection ()

vtkDataArraySelection *	GetStructuredBlockSelection ()

vtkDataArraySelection *	GetNodeSetSelection ()

vtkDataArraySelection *	GetEdgeSetSelection ()

vtkDataArraySelection *	GetFaceSetSelection ()

vtkDataArraySelection *	GetElementSetSelection ()

vtkDataArraySelection *	GetSideSetSelection ()

vtkDataArraySelection *	GetFieldSelection (int type)

vtkDataArraySelection *	GetNodeBlockFieldSelection ()

vtkDataArraySelection *	GetEdgeBlockFieldSelection ()

vtkDataArraySelection *	GetFaceBlockFieldSelection ()

vtkDataArraySelection *	GetElementBlockFieldSelection ()

vtkDataArraySelection *	GetStructuredBlockFieldSelection ()

vtkDataArraySelection *	GetNodeSetFieldSelection ()

vtkDataArraySelection *	GetEdgeSetFieldSelection ()

vtkDataArraySelection *	GetFaceSetFieldSelection ()

vtkDataArraySelection *	GetElementSetFieldSelection ()

vtkDataArraySelection *	GetSideSetFieldSelection ()

void	RemoveAllEntitySelections ()

void	RemoveAllFieldSelections ()

void	RemoveAllSelections ()

virtual int	GetAssemblyTag ()
	Whenever the assembly is changed, this tag gets changed.

vtkMTimeType	GetMTime () override
	Overridden to take into account mtimes for vtkDataArraySelection instances.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo) override
	Overridden to release handles at the end of each pass.


void	AddFileName (VTK_FILEPATH const char *fname)
	API to set the filenames.

void	ClearFileNames ()
	API to set the filenames.

VTK_FILEPATH const char *	GetFileName (int index) const
	API to set the filenames.

int	GetNumberOfFileNames () const
	API to set the filenames.


virtual void	SetDatabaseTypeOverride (const char *)
	Get/Set the IOSS database name to use for reading the file.

virtual char *	GetDatabaseTypeOverride ()
	Get/Set the IOSS database name to use for reading the file.


void	SetScanForRelatedFiles (bool value)
	When set to true, the reader can automatically locate and load additional files that are part of the collection.

virtual bool	GetScanForRelatedFiles ()
	When set to true, the reader can automatically locate and load additional files that are part of the collection.

virtual void	ScanForRelatedFilesOn ()
	When set to true, the reader can automatically locate and load additional files that are part of the collection.

virtual void	ScanForRelatedFilesOff ()
	When set to true, the reader can automatically locate and load additional files that are part of the collection.


virtual void	SetFileRange (int, int)
	This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series.

void	SetFileRange (int[2])
	This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series.

virtual int *	GetFileRange ()
	This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series.

virtual void	GetFileRange (int &, int &)
	This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series.

virtual void	GetFileRange (int[2])
	This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series.

virtual void	SetFileStride (int)
	This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series.

virtual int	GetFileStride ()
	This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series.


virtual void	SetGenerateFileId (bool)
	When set to true, the reader will add a cell-data array for cells named 'file_id' which identifies the file number when reading spatially partitioned files.

virtual bool	GetGenerateFileId ()
	When set to true, the reader will add a cell-data array for cells named 'file_id' which identifies the file number when reading spatially partitioned files.

virtual void	GenerateFileIdOn ()
	When set to true, the reader will add a cell-data array for cells named 'file_id' which identifies the file number when reading spatially partitioned files.

virtual void	GenerateFileIdOff ()
	When set to true, the reader will add a cell-data array for cells named 'file_id' which identifies the file number when reading spatially partitioned files.


virtual void	SetReadIds (bool)
	When set to true (default), the reader will read ids associated with elements.

virtual bool	GetReadIds ()
	When set to true (default), the reader will read ids associated with elements.

virtual void	ReadIdsOn ()
	When set to true (default), the reader will read ids associated with elements.

virtual void	ReadIdsOff ()
	When set to true (default), the reader will read ids associated with elements.


void	SetRemoveUnusedPoints (bool)
	Node related data, including point coordinates, point field data etc.

virtual bool	GetRemoveUnusedPoints ()
	Node related data, including point coordinates, point field data etc.

virtual void	RemoveUnusedPointsOn ()
	Node related data, including point coordinates, point field data etc.

virtual void	RemoveUnusedPointsOff ()
	Node related data, including point coordinates, point field data etc.


virtual void	SetApplyDisplacements (bool)
	When set to true (default), if an array named 'displacement' is present in the node field arrays, it will be used to transform the point coordinates.

virtual bool	GetApplyDisplacements ()
	When set to true (default), if an array named 'displacement' is present in the node field arrays, it will be used to transform the point coordinates.

virtual void	ApplyDisplacementsOn ()
	When set to true (default), if an array named 'displacement' is present in the node field arrays, it will be used to transform the point coordinates.

virtual void	ApplyDisplacementsOff ()
	When set to true (default), if an array named 'displacement' is present in the node field arrays, it will be used to transform the point coordinates.


virtual void	SetReadGlobalFields (bool)
	When set to true (default), the reader will read global fields.

virtual bool	GetReadGlobalFields ()
	When set to true (default), the reader will read global fields.

virtual void	ReadGlobalFieldsOn ()
	When set to true (default), the reader will read global fields.

virtual void	ReadGlobalFieldsOff ()
	When set to true (default), the reader will read global fields.


virtual void	SetReadQAAndInformationRecords (bool)
	When set to true (default), the reader will read quality assurance and information fields.

virtual bool	GetReadQAAndInformationRecords ()
	When set to true (default), the reader will read quality assurance and information fields.

virtual void	ReadQAAndInformationRecordsOn ()
	When set to true (default), the reader will read quality assurance and information fields.

virtual void	ReadQAAndInformationRecordsOff ()
	When set to true (default), the reader will read quality assurance and information fields.


void	SetController (vtkMultiProcessController *controller)
	Get/Set the controller to use when working in parallel.

virtual vtkMultiProcessController *	GetController ()
	Get/Set the controller to use when working in parallel.


void	AddProperty (const char *name, int value)
	IOSS databases support various properties that affect how the database is read.

void	AddProperty (const char *name, double value)
	IOSS databases support various properties that affect how the database is read.

void	AddProperty (const char name, void value)
	IOSS databases support various properties that affect how the database is read.

void	AddProperty (const char name, const char value)
	IOSS databases support various properties that affect how the database is read.

void	RemoveProperty (const char *name)
	IOSS databases support various properties that affect how the database is read.

void	ClearProperties ()
	IOSS databases support various properties that affect how the database is read.


vtkDataAssembly *	GetAssembly ()
	Assemblies provide yet another way of selection blocks/sets to load, if available in the dataset.


bool	AddSelector (const char *selector)
	API to specify selectors that indicate which branches on the assembly are chosen.

void	ClearSelectors ()
	API to specify selectors that indicate which branches on the assembly are chosen.

void	SetSelector (const char *selector)
	API to specify selectors that indicate which branches on the assembly are chosen.


int	GetNumberOfSelectors () const
	API to access selectors.

const char *	GetSelector (int index) const
	API to access selectors.


int	ReadMetaData (vtkInformation *metadata) override
	Implementation for vtkReaderAlgorithm API.

int	ReadMesh (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output) override
	Implementation for vtkReaderAlgorithm API.

int	ReadPoints (int, int, int, int, vtkDataObject *) override
	Implementation for vtkReaderAlgorithm API.

int	ReadArrays (int, int, int, int, vtkDataObject *) override
	Implementation for vtkReaderAlgorithm API.

Public Member Functions inherited from vtkReaderAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkReaderAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo) override
	Overridden to call appropriate handle pipeline request from executive.

virtual vtkDataObject *	CreateOutput (vtkDataObject *currentOutput)
	This can be overridden by a subclass to create an output that is determined by the file being read.

virtual int	ReadMetaData (vtkInformation *metadata)=0
	Provide meta-data for the pipeline.

virtual int	ReadTimeDependentMetaData (int, vtkInformation *)
	Provide meta-data for the pipeline.

virtual int	ReadMesh (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output)=0
	Read the mesh (connectivity) for a given set of data partitioning, number of ghost levels and time step (index).

virtual int	ReadPoints (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output)=0
	Read the points.

virtual int	ReadArrays (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output)=0
	Read all the arrays (point, cell, field etc.).

Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

int	HasExecutive ()
	Check whether this algorithm has an assigned executive.

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.

void	SetProgress (double)
	`SetProgress` is deprecated.

void	UpdateProgress (double amount)
	Update the progress of the process object.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess().

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.

void	RemoveAllInputs ()
	Remove all the input data.

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.

virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date.

virtual void	UpdateDataObject ()
	Create output object(s).

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.

void	Register (vtkObjectBase *o) override
	Participate in garbage collection.

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection.

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.

virtual double	GetProgress ()
	Get the execution progress of a process object.

void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date.

virtual void	Update ()
	Bring this algorithm's outputs up-to-date.

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports.

virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkIOSSReader *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkIOSSReader *	SafeDownCast (vtkObjectBase *o)

static bool	GetEntityTypeIsBlock (int type)

static bool	GetEntityTypeIsSet (int type)

static const char *	GetDataAssemblyNodeNameForEntityType (int type)

static bool	DoTestFilePatternMatching ()
	Runs a bunch of tests for file pattern matching.

Static Public Member Functions inherited from vtkReaderAlgorithm
static vtkTypeBool	IsTypeOf (const char *type)

static vtkReaderAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkIOSSReader ()

	~vtkIOSSReader () override

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm.

Protected Member Functions inherited from vtkReaderAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkReaderAlgorithm ()

	~vtkReaderAlgorithm () override

Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Reader for IOSS (Sierra IO System)

vtkIOSSReader is reader that uses the IOSS (Sierra IO System) library to read files. Currently, this reader support Exodus and CGNS file formats. IOSS imposes certain restrictions on these file formats and hence it may not be possible to open every Exodus or CGNS file using this reader. This is true especially for CGNS, more so than Exodus. In that case vtkCGNSReader may be more appropriate.

Specifying Files

One can select a single file to read using vtkIOSSReader::SetFileName. With IOSS, however, it is not uncommon to have a collection of files named using standard patterns (described in Section IOSS Naming Conventions). To support this use-case, the reader automatically scans for additionally files internally. To disable this behaviour, call vtkIOSSReader::ScanForRelatedFilesOff.

Alternatively, the list of files to be read can be explicitly specified using vtkIOSSReader::AddFileName. Then too, if ScanForRelatedFiles is true, the reader will search for related files for each of the files specified.

Additionally, FileRange and FileStride may be used to limit to reading a subset of files.

Selecting blocks and sets to read

An IOSS file comprises of blocks and sets of various types. These are described by the enum vtkIOSSReader::EntityType.

vtkIOSSReader::GetEntitySelection returns a vtkDataArraySelection instance for each of the entity types. This vtkDataArraySelection can be used to query the names for available blocks or sets and also select which ones to read.

Typical usage is as follows:

vtkNew<vtkIOSSReader> reader;
reader->SetFileName(...);
reader->UpdateInformation();
reader->GetElementBlockSelection()->EnableArray("Block0");
reader->GetEntitySelection(vtkIOSSReader::SIDESET)->DisableAllArrays();

By default, all blocks are enabled, while all sets are disabled.

In additional to selecting blocks and sets by name, if the file defines assemblies that organize these blocks and sets, then one can use selector expressions to enable blocks/sets as defined in the assemblies.

A block (or set) is treated as enabled if it is either explicitly enabled using the block selection or implicitly enabled due to a selector specified on over the assemblies.

Typical usage to select blocks by assembly alone is as follows:

vtkNew<vtkIOSSReader> reader;
reader->SetFileName(...);
reader->UpdateInformation();
reader->GetElementBlockSelection()->DisableAllArrays();
...
reader->AddSelector("//Low");
reader->AddSelector("//High");

Selecting arrays to read

Similar to the block and set selection, arrays (or fields as IOSS refers to them) to read from each of the blocks or sets can be specified using the vtkDataArraySelection instance returned using vtkIOSSReader::GetFieldSelection (or one of its convenience variants).

By default all arrays are enabled.

IOSS Naming Conventions

An IOSS complete dataset is referred to as a database. There can be multiple multiple timesteps in a single database. A single database may split among multiple files. When a database is split among multiple files, this is strictly spatial partitioning with each file storing part of the data for a specific partition. In this case, the files are named with suffix .{NP}.{RANK} where {NP} is the total number of partitions and {RANK} is the partition number. For example, if database named can.e is split among four files representing 4 partitions, it will be named as follows:

*  can.e.4.0
*  can.e.4.1
*  can.e.4.2
*  can.e.4.3
*

In this example, the database name is can.e while the .4.[0-4] suffix provides the partition information.

Note, the database need not be split into multiple files. Thus, a writer may generate a single can.e file that has all the timesteps and paritions and still provide all information available when the database is split among multiple files.

Multiple databases (with each stored in a single file or spatially split among files) can form a temporal sequence. This done by using another file naming convention. If the database name is followed by -s.{RS}, where {RS} is some number sequence), then the databases are treated as a temporal sequence with {RS} (called restart numbers) representing the temporal sequence order.

The follow represents a temporal sequence:

*  mysimoutput.e-s.000
*  mysimoutput.e-s.001
*  mysimoutput.e-s.002
*

You can use any number of digits for the restart number, but by convention the number used should be the same for all files. Also by convention, you can leave off the -s.{RS} suffix for the first file. The following sequence is internally the same as that above:

*  mysimoutput.e-s
*  mysimoutput.e-s.001
*  mysimoutput.e-s.002
*

When a database in the temporal sequence is spatially split in multiple files, the corresponding filename is suffixed by the partition information. For example:

*  mysimoutput.e-s.2.0
*  mysimoutput.e-s.2.1
*  mysimoutput.e-s.001.2.0
*  mysimoutput.e-s.001.2.1
*  mysimoutput.e-s.002.2.0
*  mysimoutput.e-s.002.2.1
*

In this case, the filenames take the form {DBNAME}-s.{RS}.{NP}.{RANK}, where {DBNAME} is the database name, {RS} is the restart number, {NP} is the number of spatial partitions and {RANK} is the spatial partition number.

References

Sierra IO System

Definition at line 182 of file vtkIOSSReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkReaderAlgorithm vtkIOSSReader::Superclass

Definition at line 186 of file vtkIOSSReader.h.

Member Enumeration Documentation

◆ EntityType

enum vtkIOSSReader::EntityType

Enumerator
NODEBLOCK
EDGEBLOCK
FACEBLOCK
ELEMENTBLOCK
STRUCTUREDBLOCK
NODESET
EDGESET
FACESET
ELEMENTSET
SIDESET
NUMBER_OF_ENTITY_TYPES
BLOCK_START
BLOCK_END
SET_START
SET_END
ENTITY_START
ENTITY_END

Definition at line 340 of file vtkIOSSReader.h.

Constructor & Destructor Documentation

◆ vtkIOSSReader()

vtkIOSSReader::vtkIOSSReader ( )

protected

◆ ~vtkIOSSReader()

vtkIOSSReader::~vtkIOSSReader ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkIOSSReader * vtkIOSSReader::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkIOSSReader::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkIOSSReader::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkReaderAlgorithm.

◆ SafeDownCast()

static vtkIOSSReader * vtkIOSSReader::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkIOSSReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkReaderAlgorithm.

◆ NewInstance()

vtkIOSSReader * vtkIOSSReader::NewInstance ( ) const

◆ PrintSelf()

void vtkIOSSReader::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkReaderAlgorithm.

◆ AddFileName()

void vtkIOSSReader::AddFileName ( VTK_FILEPATH const char * fname )

API to set the filenames.

◆ ClearFileNames()

void vtkIOSSReader::ClearFileNames ( )

API to set the filenames.

◆ GetFileName()

VTK_FILEPATH const char * vtkIOSSReader::GetFileName ( int index ) const

API to set the filenames.

◆ GetNumberOfFileNames()

int vtkIOSSReader::GetNumberOfFileNames ( ) const

API to set the filenames.

◆ SetFileName()

void vtkIOSSReader::SetFileName ( VTK_FILEPATH const char * fname )

Set a single filename.

Note, this will clear all existing filenames.

◆ SetDatabaseTypeOverride()

virtual void vtkIOSSReader::SetDatabaseTypeOverride ( const char * )

virtual

Get/Set the IOSS database name to use for reading the file.

If not specified (default), the reader will determine based on the file extension.

◆ GetDatabaseTypeOverride()

virtual char * vtkIOSSReader::GetDatabaseTypeOverride ( )

virtual

Get/Set the IOSS database name to use for reading the file.

If not specified (default), the reader will determine based on the file extension.

◆ SetScanForRelatedFiles()

void vtkIOSSReader::SetScanForRelatedFiles ( bool value )

When set to true, the reader can automatically locate and load additional files that are part of the collection.

◆ GetScanForRelatedFiles()

virtual bool vtkIOSSReader::GetScanForRelatedFiles ( )

virtual

When set to true, the reader can automatically locate and load additional files that are part of the collection.

◆ ScanForRelatedFilesOn()

virtual void vtkIOSSReader::ScanForRelatedFilesOn ( )

virtual

When set to true, the reader can automatically locate and load additional files that are part of the collection.

◆ ScanForRelatedFilesOff()

virtual void vtkIOSSReader::ScanForRelatedFilesOff ( )

virtual

When set to true, the reader can automatically locate and load additional files that are part of the collection.

◆ SetFileRange() [1/2]

virtual void vtkIOSSReader::SetFileRange	(	int	,
		int
	)

virtual

This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series.

To just specific subset of files, one can always simply specify those files using AddFileName and then set ScanForRelatedFiles to false. Another way is to let the reader scan for all related files and then use FileRange and FileStride to limit which files are read.