VTK  9.1.20211019
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkIOSSReader Class Reference

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

#include <vtkIOSSReader.h>

Inheritance diagram for vtkIOSSReader:
[legend]
Collaboration diagram for vtkIOSSReader:
[legend]

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. More...
 
vtkIOSSReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetFileName (VTK_FILEPATH const char *fname)
 Set a single filename. More...
 
vtkDataArraySelectionGetEntitySelection (int type)
 
vtkDataArraySelectionGetNodeBlockSelection ()
 
vtkDataArraySelectionGetEdgeBlockSelection ()
 
vtkDataArraySelectionGetFaceBlockSelection ()
 
vtkDataArraySelectionGetElementBlockSelection ()
 
vtkDataArraySelectionGetStructuredBlockSelection ()
 
vtkDataArraySelectionGetNodeSetSelection ()
 
vtkDataArraySelectionGetEdgeSetSelection ()
 
vtkDataArraySelectionGetFaceSetSelection ()
 
vtkDataArraySelectionGetElementSetSelection ()
 
vtkDataArraySelectionGetSideSetSelection ()
 
vtkDataArraySelectionGetFieldSelection (int type)
 
vtkDataArraySelectionGetNodeBlockFieldSelection ()
 
vtkDataArraySelectionGetEdgeBlockFieldSelection ()
 
vtkDataArraySelectionGetFaceBlockFieldSelection ()
 
vtkDataArraySelectionGetElementBlockFieldSelection ()
 
vtkDataArraySelectionGetStructuredBlockFieldSelection ()
 
vtkDataArraySelectionGetNodeSetFieldSelection ()
 
vtkDataArraySelectionGetEdgeSetFieldSelection ()
 
vtkDataArraySelectionGetFaceSetFieldSelection ()
 
vtkDataArraySelectionGetElementSetFieldSelection ()
 
vtkDataArraySelectionGetSideSetFieldSelection ()
 
void RemoveAllEntitySelections ()
 
void RemoveAllFieldSelections ()
 
void RemoveAllSelections ()
 
virtual int GetAssemblyTag ()
 Whenever the assembly is changed, this tag gets changed. More...
 
vtkMTimeType GetMTime () override
 Overridden to take into account mtimes for vtkDataArraySelection instances. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) override
 Overridden to release handles at the end of each pass. More...
 
void AddFileName (VTK_FILEPATH const char *fname)
 API to set the filenames. More...
 
void ClearFileNames ()
 API to set the filenames. More...
 
VTK_FILEPATH const char * GetFileName (int index) const
 API to set the filenames. More...
 
int GetNumberOfFileNames () const
 API to set the filenames. More...
 
virtual void SetDatabaseTypeOverride (const char *)
 Get/Set the IOSS database name to use for reading the file. More...
 
virtual char * GetDatabaseTypeOverride ()
 Get/Set the IOSS database name to use for reading the file. More...
 
void SetScanForRelatedFiles (bool value)
 When set to true, the reader can automatically locate and load additional files that are part of the collection. More...
 
virtual bool GetScanForRelatedFiles ()
 When set to true, the reader can automatically locate and load additional files that are part of the collection. More...
 
virtual void ScanForRelatedFilesOn ()
 When set to true, the reader can automatically locate and load additional files that are part of the collection. More...
 
virtual void ScanForRelatedFilesOff ()
 When set to true, the reader can automatically locate and load additional files that are part of the collection. More...
 
virtual void SetFileRange (int, int)
 This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series. More...
 
void SetFileRange (int[2])
 This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series. More...
 
virtual int * GetFileRange ()
 This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series. More...
 
virtual void GetFileRange (int &, int &)
 This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series. More...
 
virtual void GetFileRange (int[2])
 This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series. More...
 
virtual void SetFileStride (int)
 This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series. More...
 
virtual int GetFileStride ()
 This provides a mechanism to limit to reading to certain files in a spatially partitioned file-series. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void SetReadIds (bool)
 When set to true (default), the reader will read ids associated with elements. More...
 
virtual bool GetReadIds ()
 When set to true (default), the reader will read ids associated with elements. More...
 
virtual void ReadIdsOn ()
 When set to true (default), the reader will read ids associated with elements. More...
 
virtual void ReadIdsOff ()
 When set to true (default), the reader will read ids associated with elements. More...
 
void SetRemoveUnusedPoints (bool)
 Node related data, including point coordinates, point field data etc. More...
 
virtual bool GetRemoveUnusedPoints ()
 Node related data, including point coordinates, point field data etc. More...
 
virtual void RemoveUnusedPointsOn ()
 Node related data, including point coordinates, point field data etc. More...
 
virtual void RemoveUnusedPointsOff ()
 Node related data, including point coordinates, point field data etc. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void SetReadGlobalFields (bool)
 When set to true (default), the reader will read global fields. More...
 
virtual bool GetReadGlobalFields ()
 When set to true (default), the reader will read global fields. More...
 
virtual void ReadGlobalFieldsOn ()
 When set to true (default), the reader will read global fields. More...
 
virtual void ReadGlobalFieldsOff ()
 When set to true (default), the reader will read global fields. More...
 
virtual void SetReadQAAndInformationRecords (bool)
 When set to true (default), the reader will read quality assurance and information fields. More...
 
virtual bool GetReadQAAndInformationRecords ()
 When set to true (default), the reader will read quality assurance and information fields. More...
 
virtual void ReadQAAndInformationRecordsOn ()
 When set to true (default), the reader will read quality assurance and information fields. More...
 
virtual void ReadQAAndInformationRecordsOff ()
 When set to true (default), the reader will read quality assurance and information fields. More...
 
void SetController (vtkMultiProcessController *controller)
 Get/Set the controller to use when working in parallel. More...
 
virtual vtkMultiProcessControllerGetController ()
 Get/Set the controller to use when working in parallel. More...
 
void AddProperty (const char *name, int value)
 IOSS databases support various properties that affect how the database is read. More...
 
void AddProperty (const char *name, double value)
 IOSS databases support various properties that affect how the database is read. More...
 
void AddProperty (const char *name, void *value)
 IOSS databases support various properties that affect how the database is read. More...
 
void AddProperty (const char *name, const char *value)
 IOSS databases support various properties that affect how the database is read. More...
 
void RemoveProperty (const char *name)
 IOSS databases support various properties that affect how the database is read. More...
 
void ClearProperties ()
 IOSS databases support various properties that affect how the database is read. More...
 
vtkDataAssemblyGetAssembly ()
 Assemblies provide yet another way of selection blocks/sets to load, if available in the dataset. More...
 
bool AddSelector (const char *selector)
 API to specify selectors that indicate which branches on the assembly are chosen. More...
 
void ClearSelectors ()
 API to specify selectors that indicate which branches on the assembly are chosen. More...
 
void SetSelector (const char *selector)
 API to specify selectors that indicate which branches on the assembly are chosen. More...
 
int GetNumberOfSelectors () const
 API to access selectors. More...
 
const char * GetSelector (int index) const
 API to access selectors. More...
 
int ReadMetaData (vtkInformation *metadata) override
 Implementation for vtkReaderAlgorithm API. More...
 
int ReadMesh (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output) override
 Implementation for vtkReaderAlgorithm API. More...
 
int ReadPoints (int, int, int, int, vtkDataObject *) override
 Implementation for vtkReaderAlgorithm API. More...
 
int ReadArrays (int, int, int, int, vtkDataObject *) override
 Implementation for vtkReaderAlgorithm API. More...
 
- Public Member Functions inherited from vtkReaderAlgorithm
vtkReaderAlgorithmNewInstance () const
 
virtual vtkDataObjectCreateOutput (vtkDataObject *currentOutput)
 This can be overridden by a subclass to create an output that is determined by the file being read. More...
 
virtual int ReadTimeDependentMetaData (int, vtkInformation *)
 Provide meta-data for the pipeline. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
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). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
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. More...
 
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. More...
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
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. More...
 
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. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkIOSSReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkIOSSReaderSafeDownCast (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. More...
 
- Static Public Member Functions inherited from vtkReaderAlgorithm
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkReaderAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkIOSSReader ()
 
 ~vtkIOSSReader () override
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkReaderAlgorithm
 vtkReaderAlgorithm ()
 
 ~vtkReaderAlgorithm () override
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
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. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
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. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (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. More...
 
vtkDataArrayGetInputArrayToProcess (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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 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 vtkInformationIntegerKeyPORT_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
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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 vtkExecutiveDefaultExecutivePrototype
 

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:

reader->SetFileName(...);
reader->UpdateInformation();
reader->GetElementBlockSelection()->EnableArray("Block0");
reader->GetEntitySelection(vtkIOSSReader::SIDESET)->DisableAllArrays();
Allocate and hold a VTK object.
Definition: vtkNew.h:165

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:

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

Definition at line 182 of file vtkIOSSReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 186 of file vtkIOSSReader.h.

Member Enumeration Documentation

◆ 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.

If the range is invalid, i.e. FileRange[0] >= FileRange[1], it's assumed that no file-range overrides have been specified and both FileRange and FileStride will be ignored. When valid, only the chosen subset of files will be processed.

◆ SetFileRange() [2/2]

void vtkIOSSReader::SetFileRange ( int  [2])

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.

If the range is invalid, i.e. FileRange[0] >= FileRange[1], it's assumed that no file-range overrides have been specified and both FileRange and FileStride will be ignored. When valid, only the chosen subset of files will be processed.

◆ GetFileRange() [1/3]

virtual int* vtkIOSSReader::GetFileRange ( )
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.

If the range is invalid, i.e. FileRange[0] >= FileRange[1], it's assumed that no file-range overrides have been specified and both FileRange and FileStride will be ignored. When valid, only the chosen subset of files will be processed.

◆ GetFileRange() [2/3]

virtual void vtkIOSSReader::GetFileRange ( 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.

If the range is invalid, i.e. FileRange[0] >= FileRange[1], it's assumed that no file-range overrides have been specified and both FileRange and FileStride will be ignored. When valid, only the chosen subset of files will be processed.

◆ GetFileRange() [3/3]

virtual void vtkIOSSReader::GetFileRange ( int  [2])
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.

If the range is invalid, i.e. FileRange[0] >= FileRange[1], it's assumed that no file-range overrides have been specified and both FileRange and FileStride will be ignored. When valid, only the chosen subset of files will be processed.

◆ SetFileStride()

virtual void vtkIOSSReader::SetFileStride ( 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.

If the range is invalid, i.e. FileRange[0] >= FileRange[1], it's assumed that no file-range overrides have been specified and both FileRange and FileStride will be ignored. When valid, only the chosen subset of files will be processed.

◆ GetFileStride()

virtual int vtkIOSSReader::GetFileStride ( )
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.

If the range is invalid, i.e. FileRange[0] >= FileRange[1], it's assumed that no file-range overrides have been specified and both FileRange and FileStride will be ignored. When valid, only the chosen subset of files will be processed.

◆ SetGenerateFileId()

virtual void vtkIOSSReader::SetGenerateFileId ( bool  )
virtual

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.

Default is false.

◆ GetGenerateFileId()

virtual bool vtkIOSSReader::GetGenerateFileId ( )
virtual

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.

Default is false.

◆ GenerateFileIdOn()

virtual void vtkIOSSReader::GenerateFileIdOn ( )
virtual

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.

Default is false.

◆ GenerateFileIdOff()

virtual void vtkIOSSReader::GenerateFileIdOff ( )
virtual

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.

Default is false.

◆ SetReadIds()

virtual void vtkIOSSReader::SetReadIds ( bool  )
virtual

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

◆ GetReadIds()

virtual bool vtkIOSSReader::GetReadIds ( )
virtual

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

◆ ReadIdsOn()

virtual void vtkIOSSReader::ReadIdsOn ( )
virtual

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

◆ ReadIdsOff()

virtual void vtkIOSSReader::ReadIdsOff ( )
virtual

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

◆ SetRemoveUnusedPoints()

void vtkIOSSReader::SetRemoveUnusedPoints ( bool  )

Node related data, including point coordinates, point field data etc.

is typically shared between all blocks and sets. By default, the reader will remove unused points for each block or set. To avoid this, set this flag to false.

Default is true, unused points are removed.

◆ GetRemoveUnusedPoints()

virtual bool vtkIOSSReader::GetRemoveUnusedPoints ( )
virtual

Node related data, including point coordinates, point field data etc.

is typically shared between all blocks and sets. By default, the reader will remove unused points for each block or set. To avoid this, set this flag to false.

Default is true, unused points are removed.

◆ RemoveUnusedPointsOn()

virtual void vtkIOSSReader::RemoveUnusedPointsOn ( )
virtual

Node related data, including point coordinates, point field data etc.

is typically shared between all blocks and sets. By default, the reader will remove unused points for each block or set. To avoid this, set this flag to false.

Default is true, unused points are removed.

◆ RemoveUnusedPointsOff()

virtual void vtkIOSSReader::RemoveUnusedPointsOff ( )
virtual

Node related data, including point coordinates, point field data etc.

is typically shared between all blocks and sets. By default, the reader will remove unused points for each block or set. To avoid this, set this flag to false.

Default is true, unused points are removed.

◆ SetApplyDisplacements()

virtual void vtkIOSSReader::SetApplyDisplacements ( bool  )
virtual

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.

◆ GetApplyDisplacements()

virtual bool vtkIOSSReader::GetApplyDisplacements ( )
virtual

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.

◆ ApplyDisplacementsOn()

virtual void vtkIOSSReader::ApplyDisplacementsOn ( )
virtual

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.

◆ ApplyDisplacementsOff()

virtual void vtkIOSSReader::ApplyDisplacementsOff ( )
virtual

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.

◆ SetReadGlobalFields()

virtual void vtkIOSSReader::SetReadGlobalFields ( bool  )
virtual

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

◆ GetReadGlobalFields()

virtual bool vtkIOSSReader::GetReadGlobalFields ( )
virtual

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

◆ ReadGlobalFieldsOn()

virtual void vtkIOSSReader::ReadGlobalFieldsOn ( )
virtual

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

◆ ReadGlobalFieldsOff()

virtual void vtkIOSSReader::ReadGlobalFieldsOff ( )
virtual

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

◆ SetReadQAAndInformationRecords()

virtual void vtkIOSSReader::SetReadQAAndInformationRecords ( bool  )
virtual

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

◆ GetReadQAAndInformationRecords()

virtual bool vtkIOSSReader::GetReadQAAndInformationRecords ( )
virtual

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

◆ ReadQAAndInformationRecordsOn()

virtual void vtkIOSSReader::ReadQAAndInformationRecordsOn ( )
virtual

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

◆ ReadQAAndInformationRecordsOff()

virtual void vtkIOSSReader::ReadQAAndInformationRecordsOff ( )
virtual

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

◆ SetController()

void vtkIOSSReader::SetController ( vtkMultiProcessController controller)

Get/Set the controller to use when working in parallel.

Initialized to vtkMultiProcessController::GetGlobalController in the constructor.

The controller is used to using ReadMetaData stage to distribute the work of gathering meta-data from multiple files, if any, across ranks and then exchanging that information between all ranks.

The actual reading of data is controlled by piece requests sent by the pipeline e.g. using vtkAlgorithm::UpdatePiece.

◆ GetController()

virtual vtkMultiProcessController* vtkIOSSReader::GetController ( )
virtual

Get/Set the controller to use when working in parallel.

Initialized to vtkMultiProcessController::GetGlobalController in the constructor.

The controller is used to using ReadMetaData stage to distribute the work of gathering meta-data from multiple files, if any, across ranks and then exchanging that information between all ranks.

The actual reading of data is controlled by piece requests sent by the pipeline e.g. using vtkAlgorithm::UpdatePiece.

◆ AddProperty() [1/4]

void vtkIOSSReader::AddProperty ( const char *  name,
int  value 
)

IOSS databases support various properties that affect how the database is read.

These properties can be set using this API. Note, it's best to call this before the first update to the reader since any change and the reader will flush all caches and close all open databases etc.

◆ AddProperty() [2/4]

void vtkIOSSReader::AddProperty ( const char *  name,
double  value 
)

IOSS databases support various properties that affect how the database is read.

These properties can be set using this API. Note, it's best to call this before the first update to the reader since any change and the reader will flush all caches and close all open databases etc.

◆ AddProperty() [3/4]

void vtkIOSSReader::AddProperty ( const char *  name,
void *  value 
)

IOSS databases support various properties that affect how the database is read.

These properties can be set using this API. Note, it's best to call this before the first update to the reader since any change and the reader will flush all caches and close all open databases etc.

◆ AddProperty() [4/4]

void vtkIOSSReader::AddProperty ( const char *  name,
const char *  value 
)

IOSS databases support various properties that affect how the database is read.

These properties can be set using this API. Note, it's best to call this before the first update to the reader since any change and the reader will flush all caches and close all open databases etc.

◆ RemoveProperty()

void vtkIOSSReader::RemoveProperty ( const char *  name)

IOSS databases support various properties that affect how the database is read.

These properties can be set using this API. Note, it's best to call this before the first update to the reader since any change and the reader will flush all caches and close all open databases etc.

◆ ClearProperties()

void vtkIOSSReader::ClearProperties ( )

IOSS databases support various properties that affect how the database is read.

These properties can be set using this API. Note, it's best to call this before the first update to the reader since any change and the reader will flush all caches and close all open databases etc.

◆ GetEntityTypeIsBlock()

static bool vtkIOSSReader::GetEntityTypeIsBlock ( int  type)
inlinestatic

Definition at line 362 of file vtkIOSSReader.h.

◆ GetEntityTypeIsSet()

static bool vtkIOSSReader::GetEntityTypeIsSet ( int  type)
inlinestatic

Definition at line 363 of file vtkIOSSReader.h.

◆ GetDataAssemblyNodeNameForEntityType()

static const char* vtkIOSSReader::GetDataAssemblyNodeNameForEntityType ( int  type)
static

◆ GetEntitySelection()

vtkDataArraySelection* vtkIOSSReader::GetEntitySelection ( int  type)

◆ GetNodeBlockSelection()

vtkDataArraySelection* vtkIOSSReader::GetNodeBlockSelection ( )
inline

Definition at line 367 of file vtkIOSSReader.h.

◆ GetEdgeBlockSelection()

vtkDataArraySelection* vtkIOSSReader::GetEdgeBlockSelection ( )
inline

Definition at line 368 of file vtkIOSSReader.h.

◆ GetFaceBlockSelection()

vtkDataArraySelection* vtkIOSSReader::GetFaceBlockSelection ( )
inline

Definition at line 369 of file vtkIOSSReader.h.

◆ GetElementBlockSelection()

vtkDataArraySelection* vtkIOSSReader::GetElementBlockSelection ( )
inline

Definition at line 370 of file vtkIOSSReader.h.

◆ GetStructuredBlockSelection()

vtkDataArraySelection* vtkIOSSReader::GetStructuredBlockSelection ( )
inline

Definition at line 374 of file vtkIOSSReader.h.

◆ GetNodeSetSelection()

vtkDataArraySelection* vtkIOSSReader::GetNodeSetSelection ( )
inline

Definition at line 378 of file vtkIOSSReader.h.

◆ GetEdgeSetSelection()

vtkDataArraySelection* vtkIOSSReader::GetEdgeSetSelection ( )
inline

Definition at line 379 of file vtkIOSSReader.h.

◆ GetFaceSetSelection()

vtkDataArraySelection* vtkIOSSReader::GetFaceSetSelection ( )
inline

Definition at line 380 of file vtkIOSSReader.h.

◆ GetElementSetSelection()

vtkDataArraySelection* vtkIOSSReader::GetElementSetSelection ( )
inline

Definition at line 381 of file vtkIOSSReader.h.

◆ GetSideSetSelection()

vtkDataArraySelection* vtkIOSSReader::GetSideSetSelection ( )
inline

Definition at line 382 of file vtkIOSSReader.h.

◆ GetFieldSelection()

vtkDataArraySelection* vtkIOSSReader::GetFieldSelection ( int  type)

◆ GetNodeBlockFieldSelection()

vtkDataArraySelection* vtkIOSSReader::GetNodeBlockFieldSelection ( )
inline

Definition at line 385 of file vtkIOSSReader.h.

◆ GetEdgeBlockFieldSelection()

vtkDataArraySelection* vtkIOSSReader::GetEdgeBlockFieldSelection ( )
inline

Definition at line 386 of file vtkIOSSReader.h.

◆ GetFaceBlockFieldSelection()

vtkDataArraySelection* vtkIOSSReader::GetFaceBlockFieldSelection ( )
inline

Definition at line 387 of file vtkIOSSReader.h.

◆ GetElementBlockFieldSelection()

vtkDataArraySelection* vtkIOSSReader::GetElementBlockFieldSelection ( )
inline

Definition at line 388 of file vtkIOSSReader.h.

◆ GetStructuredBlockFieldSelection()

vtkDataArraySelection* vtkIOSSReader::GetStructuredBlockFieldSelection ( )
inline

Definition at line 392 of file vtkIOSSReader.h.

◆ GetNodeSetFieldSelection()

vtkDataArraySelection* vtkIOSSReader::GetNodeSetFieldSelection ( )
inline

Definition at line 396 of file vtkIOSSReader.h.

◆ GetEdgeSetFieldSelection()

vtkDataArraySelection* vtkIOSSReader::GetEdgeSetFieldSelection ( )
inline

Definition at line 397 of file vtkIOSSReader.h.

◆ GetFaceSetFieldSelection()

vtkDataArraySelection* vtkIOSSReader::GetFaceSetFieldSelection ( )
inline

Definition at line 398 of file vtkIOSSReader.h.

◆ GetElementSetFieldSelection()

vtkDataArraySelection* vtkIOSSReader::GetElementSetFieldSelection ( )
inline

Definition at line 399 of file vtkIOSSReader.h.

◆ GetSideSetFieldSelection()

vtkDataArraySelection* vtkIOSSReader::GetSideSetFieldSelection ( )
inline

Definition at line 403 of file vtkIOSSReader.h.

◆ RemoveAllEntitySelections()

void vtkIOSSReader::RemoveAllEntitySelections ( )

◆ RemoveAllFieldSelections()

void vtkIOSSReader::RemoveAllFieldSelections ( )

◆ RemoveAllSelections()

void vtkIOSSReader::RemoveAllSelections ( )
inline

Definition at line 407 of file vtkIOSSReader.h.

◆ GetAssembly()

vtkDataAssembly* vtkIOSSReader::GetAssembly ( )

Assemblies provide yet another way of selection blocks/sets to load, if available in the dataset.

If a block (or set) is enabled either in the block (or set) selection or using assembly selector then it is treated as enabled and will be read.

This method returns the vtkDataAssembly. Since IOSS can have multiple assemblies, all are nested under the root "Assemblies" node.

If the file has no assemblies, this will return nullptr.

◆ GetAssemblyTag()

virtual int vtkIOSSReader::GetAssemblyTag ( )
virtual

Whenever the assembly is changed, this tag gets changed.

Note, users should not assume that this is monotonically increasing but instead simply rely on its value to determine if the assembly may have changed since last time.

It is set to 0 whenever there's no valid assembly available.

◆ AddSelector()

bool vtkIOSSReader::AddSelector ( const char *  selector)

API to specify selectors that indicate which branches on the assembly are chosen.

◆ ClearSelectors()

void vtkIOSSReader::ClearSelectors ( )

API to specify selectors that indicate which branches on the assembly are chosen.

◆ SetSelector()

void vtkIOSSReader::SetSelector ( const char *  selector)

API to specify selectors that indicate which branches on the assembly are chosen.

◆ GetNumberOfSelectors()

int vtkIOSSReader::GetNumberOfSelectors ( ) const

API to access selectors.

◆ GetSelector()

const char* vtkIOSSReader::GetSelector ( int  index) const

API to access selectors.

◆ ReadMetaData()

int vtkIOSSReader::ReadMetaData ( vtkInformation metadata)
overridevirtual

Implementation for vtkReaderAlgorithm API.

Implements vtkReaderAlgorithm.

◆ ReadMesh()

int vtkIOSSReader::ReadMesh ( int  piece,
int  npieces,
int  nghosts,
int  timestep,
vtkDataObject output 
)
overridevirtual

Implementation for vtkReaderAlgorithm API.

Implements vtkReaderAlgorithm.

◆ ReadPoints()

int vtkIOSSReader::ReadPoints ( int  ,
int  ,
int  ,
int  ,
vtkDataObject  
)
inlineoverridevirtual

Implementation for vtkReaderAlgorithm API.

Implements vtkReaderAlgorithm.

Definition at line 461 of file vtkIOSSReader.h.

◆ ReadArrays()

int vtkIOSSReader::ReadArrays ( int  ,
int  ,
int  ,
int  ,
vtkDataObject  
)
inlineoverridevirtual

Implementation for vtkReaderAlgorithm API.

Implements vtkReaderAlgorithm.

Definition at line 462 of file vtkIOSSReader.h.

◆ GetMTime()

vtkMTimeType vtkIOSSReader::GetMTime ( )
overridevirtual

Overridden to take into account mtimes for vtkDataArraySelection instances.

Reimplemented from vtkObject.

◆ DoTestFilePatternMatching()

static bool vtkIOSSReader::DoTestFilePatternMatching ( )
static

Runs a bunch of tests for file pattern matching.

◆ ProcessRequest()

vtkTypeBool vtkIOSSReader::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inInfo,
vtkInformationVector outInfo 
)
overridevirtual

Overridden to release handles at the end of each pass.

Reimplemented from vtkReaderAlgorithm.

◆ FillOutputPortInformation()

int vtkIOSSReader::FillOutputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the output port information objects for this algorithm.

This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.


The documentation for this class was generated from the following file: