VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPExodusIIReader Class Reference

Read Exodus II files (.exii) More...

#include <vtkPExodusIIReader.h>

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

Public Types

typedef vtkExodusIIReader Superclass
 
- Public Types inherited from vtkExodusIIReader
typedef vtkMultiBlockDataSetAlgorithm Superclass
 
enum  {
  SEARCH_TYPE_ELEMENT = 0 , SEARCH_TYPE_NODE , SEARCH_TYPE_ELEMENT_THEN_NODE , SEARCH_TYPE_NODE_THEN_ELEMENT ,
  ID_NOT_FOUND = -234121312
}
 Extra cell data array that can be generated. More...
 
enum  ObjectType {
  EDGE_BLOCK = 6 , FACE_BLOCK = 8 , ELEM_BLOCK = 1 , NODE_SET = 2 ,
  EDGE_SET = 7 , FACE_SET = 9 , SIDE_SET = 3 , ELEM_SET = 10 ,
  NODE_MAP = 5 , EDGE_MAP = 11 , FACE_MAP = 12 , ELEM_MAP = 4 ,
  GLOBAL = 13 , NODAL = 14 , ASSEMBLY = 60 , PART = 61 ,
  MATERIAL = 62 , HIERARCHY = 63 , QA_RECORDS = 103 , INFO_RECORDS = 104 ,
  GLOBAL_TEMPORAL = 102 , NODAL_TEMPORAL = 101 , ELEM_BLOCK_TEMPORAL = 100 , GLOBAL_CONN = 99 ,
  ELEM_BLOCK_ELEM_CONN = 98 , ELEM_BLOCK_FACE_CONN , ELEM_BLOCK_EDGE_CONN , FACE_BLOCK_CONN = 95 ,
  EDGE_BLOCK_CONN = 94 , ELEM_SET_CONN = 93 , SIDE_SET_CONN = 92 , FACE_SET_CONN = 91 ,
  EDGE_SET_CONN = 90 , NODE_SET_CONN = 89 , NODAL_COORDS = 88 , OBJECT_ID = 87 ,
  IMPLICIT_ELEMENT_ID = 108 , IMPLICIT_NODE_ID = 107 , GLOBAL_ELEMENT_ID , GLOBAL_NODE_ID ,
  ELEMENT_ID = 84 , NODE_ID = 83 , NODAL_SQUEEZEMAP = 82 , ELEM_BLOCK_ATTRIB = 81 ,
  FACE_BLOCK_ATTRIB = 80 , EDGE_BLOCK_ATTRIB = 79 , FACE_ID = 105 , EDGE_ID = 106 ,
  ENTITY_COUNTS = 109
}
 Extra cell data array that can be generated. More...
 
- Public Types inherited from vtkMultiBlockDataSetAlgorithm
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.
 
vtkPExodusIIReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void SetFileNames (int nfiles, const char **names)
 Provide an arbitrary list of file names instead of a prefix, pattern and range.
 
void SetFileName (VTK_FILEPATH const char *name) override
 Specify file name of the Exodus file.
 
char ** GetFileNames ()
 Return pointer to list of file names set in SetFileNames.
 
int GetNumberOfFileNames ()
 Return number of file names set in SetFileNames.
 
vtkIdType GetTotalNumberOfElements () override
 
vtkIdType GetTotalNumberOfNodes () override
 
virtual void Broadcast (vtkMultiProcessController *ctrl)
 Sends metadata (that read from the input file, not settings modified through this API) from the rank 0 node to all other processes in a job.
 
void SetController (vtkMultiProcessController *c)
 Set/get the communication object used to relay a list of files from the rank 0 process to all others.
 
virtual vtkMultiProcessControllerGetController ()
 Set/get the communication object used to relay a list of files from the rank 0 process to all others.
 
 vtkSetFilePathMacro (FilePattern)
 These methods tell the reader that the data is distributed across multiple files.
 
 vtkGetFilePathMacro (FilePattern)
 These methods tell the reader that the data is distributed across multiple files.
 
 vtkSetFilePathMacro (FilePrefix)
 These methods tell the reader that the data is distributed across multiple files.
 
 vtkGetFilePathMacro (FilePrefix)
 These methods tell the reader that the data is distributed across multiple files.
 
void SetFileRange (int, int)
 Set the range of files that are being loaded.
 
void SetFileRange (int *r)
 Set the range of files that are being loaded.
 
virtual int * GetFileRange ()
 Set the range of files that are being loaded.
 
virtual void GetFileRange (int &, int &)
 Set the range of files that are being loaded.
 
virtual void GetFileRange (int[2])
 Set the range of files that are being loaded.
 
virtual int GetNumberOfFiles ()
 Return the number of files to be read.
 
virtual double GetVariableCacheSize ()
 The size of the variable cache in MegaByes.
 
virtual void SetVariableCacheSize (double)
 The size of the variable cache in MegaByes.
 
- Public Member Functions inherited from vtkExodusIIReader
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkExodusIIReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual int CanReadFile (VTK_FILEPATH const char *fname)
 Determine if the file can be read with this reader.
 
vtkMTimeType GetMTime () override
 Return the object's MTime.
 
virtual vtkMTimeType GetMetadataMTime ()
 Return the MTime of the internal data structure.
 
void SetModeShape (int val)
 Convenience method to set the mode-shape which is same as this->SetTimeStep(val-1);.
 
virtual void SetGenerateGlobalElementIdArray (vtkTypeBool g)
 
vtkTypeBool GetGenerateGlobalElementIdArray ()
 
virtual void GenerateGlobalElementIdArrayOn ()
 
virtual void GenerateGlobalElementIdArrayOff ()
 
virtual void SetGenerateGlobalNodeIdArray (vtkTypeBool g)
 
vtkTypeBool GetGenerateGlobalNodeIdArray ()
 
virtual void GenerateGlobalNodeIdArrayOn ()
 
virtual void GenerateGlobalNodeIdArrayOff ()
 
virtual void SetGenerateImplicitElementIdArray (vtkTypeBool g)
 
vtkTypeBool GetGenerateImplicitElementIdArray ()
 
virtual void GenerateImplicitElementIdArrayOn ()
 
virtual void GenerateImplicitElementIdArrayOff ()
 
virtual void SetGenerateImplicitNodeIdArray (vtkTypeBool g)
 
vtkTypeBool GetGenerateImplicitNodeIdArray ()
 
virtual void GenerateImplicitNodeIdArrayOn ()
 
virtual void GenerateImplicitNodeIdArrayOff ()
 
virtual void SetGenerateFileIdArray (vtkTypeBool f)
 
vtkTypeBool GetGenerateFileIdArray ()
 
virtual void GenerateFileIdArrayOn ()
 
virtual void GenerateFileIdArrayOff ()
 
virtual void SetFileId (int f)
 
int GetFileId ()
 
int GetNumberOfNodesInFile ()
 
int GetNumberOfEdgesInFile ()
 
int GetNumberOfFacesInFile ()
 
int GetNumberOfElementsInFile ()
 
int GetObjectTypeFromName (const char *name)
 
const char * GetObjectTypeName (int)
 
int GetNumberOfNodes ()
 
int GetNumberOfObjects (int objectType)
 
int GetNumberOfEntriesInObject (int objectType, int objectIndex)
 
int GetObjectId (int objectType, int objectIndex)
 
const char * GetObjectName (int objectType, int objectIndex)
 
int GetObjectIndex (int objectType, const char *objectName)
 
int GetObjectIndex (int objectType, int id)
 
int GetObjectStatus (int objectType, int objectIndex)
 
int GetObjectStatus (int objectType, const char *objectName)
 
void SetObjectStatus (int objectType, int objectIndex, int status)
 
void SetObjectStatus (int objectType, const char *objectName, int status)
 
virtual vtkIdType GetTotalNumberOfNodes ()
 
virtual vtkIdType GetTotalNumberOfEdges ()
 
virtual vtkIdType GetTotalNumberOfFaces ()
 
virtual vtkIdType GetTotalNumberOfElements ()
 
virtual int GetDisplayType ()
 
virtual void SetDisplayType (int type)
 
int IsValidVariable (const char *type, const char *name)
 return boolean indicating whether the type,name is a valid variable
 
int GetVariableID (const char *type, const char *name)
 Return the id of the type,name variable.
 
void SetAllArrayStatus (int otype, int status)
 
int GetTimeSeriesData (int ID, const char *vName, const char *vType, vtkFloatArray *result)
 
int GetNumberOfEdgeBlockArrays ()
 
const char * GetEdgeBlockArrayName (int index)
 
int GetEdgeBlockArrayStatus (const char *name)
 
void SetEdgeBlockArrayStatus (const char *name, int flag)
 
int GetNumberOfFaceBlockArrays ()
 
const char * GetFaceBlockArrayName (int index)
 
int GetFaceBlockArrayStatus (const char *name)
 
void SetFaceBlockArrayStatus (const char *name, int flag)
 
int GetNumberOfElementBlockArrays ()
 
const char * GetElementBlockArrayName (int index)
 
int GetElementBlockArrayStatus (const char *name)
 
void SetElementBlockArrayStatus (const char *name, int flag)
 
int GetNumberOfGlobalResultArrays ()
 
const char * GetGlobalResultArrayName (int index)
 
int GetGlobalResultArrayStatus (const char *name)
 
void SetGlobalResultArrayStatus (const char *name, int flag)
 
int GetNumberOfPointResultArrays ()
 
const char * GetPointResultArrayName (int index)
 
int GetPointResultArrayStatus (const char *name)
 
void SetPointResultArrayStatus (const char *name, int flag)
 
int GetNumberOfEdgeResultArrays ()
 
const char * GetEdgeResultArrayName (int index)
 
int GetEdgeResultArrayStatus (const char *name)
 
void SetEdgeResultArrayStatus (const char *name, int flag)
 
int GetNumberOfFaceResultArrays ()
 
const char * GetFaceResultArrayName (int index)
 
int GetFaceResultArrayStatus (const char *name)
 
void SetFaceResultArrayStatus (const char *name, int flag)
 
int GetNumberOfElementResultArrays ()
 
const char * GetElementResultArrayName (int index)
 
int GetElementResultArrayStatus (const char *name)
 
void SetElementResultArrayStatus (const char *name, int flag)
 
int GetNumberOfNodeMapArrays ()
 
const char * GetNodeMapArrayName (int index)
 
int GetNodeMapArrayStatus (const char *name)
 
void SetNodeMapArrayStatus (const char *name, int flag)
 
int GetNumberOfEdgeMapArrays ()
 
const char * GetEdgeMapArrayName (int index)
 
int GetEdgeMapArrayStatus (const char *name)
 
void SetEdgeMapArrayStatus (const char *name, int flag)
 
int GetNumberOfFaceMapArrays ()
 
const char * GetFaceMapArrayName (int index)
 
int GetFaceMapArrayStatus (const char *name)
 
void SetFaceMapArrayStatus (const char *name, int flag)
 
int GetNumberOfElementMapArrays ()
 
const char * GetElementMapArrayName (int index)
 
int GetElementMapArrayStatus (const char *name)
 
void SetElementMapArrayStatus (const char *name, int flag)
 
int GetNumberOfNodeSetArrays ()
 
const char * GetNodeSetArrayName (int index)
 
int GetNodeSetArrayStatus (const char *name)
 
void SetNodeSetArrayStatus (const char *name, int flag)
 
int GetNumberOfSideSetArrays ()
 
const char * GetSideSetArrayName (int index)
 
int GetSideSetArrayStatus (const char *name)
 
void SetSideSetArrayStatus (const char *name, int flag)
 
int GetNumberOfEdgeSetArrays ()
 
const char * GetEdgeSetArrayName (int index)
 
int GetEdgeSetArrayStatus (const char *name)
 
void SetEdgeSetArrayStatus (const char *name, int flag)
 
int GetNumberOfFaceSetArrays ()
 
const char * GetFaceSetArrayName (int index)
 
int GetFaceSetArrayStatus (const char *name)
 
void SetFaceSetArrayStatus (const char *name, int flag)
 
int GetNumberOfElementSetArrays ()
 
const char * GetElementSetArrayName (int index)
 
int GetElementSetArrayStatus (const char *name)
 
void SetElementSetArrayStatus (const char *name, int flag)
 
int GetNumberOfNodeSetResultArrays ()
 
const char * GetNodeSetResultArrayName (int index)
 
int GetNodeSetResultArrayStatus (const char *name)
 
void SetNodeSetResultArrayStatus (const char *name, int flag)
 
int GetNumberOfSideSetResultArrays ()
 
const char * GetSideSetResultArrayName (int index)
 
int GetSideSetResultArrayStatus (const char *name)
 
void SetSideSetResultArrayStatus (const char *name, int flag)
 
int GetNumberOfEdgeSetResultArrays ()
 
const char * GetEdgeSetResultArrayName (int index)
 
int GetEdgeSetResultArrayStatus (const char *name)
 
void SetEdgeSetResultArrayStatus (const char *name, int flag)
 
int GetNumberOfFaceSetResultArrays ()
 
const char * GetFaceSetResultArrayName (int index)
 
int GetFaceSetResultArrayStatus (const char *name)
 
void SetFaceSetResultArrayStatus (const char *name, int flag)
 
int GetNumberOfElementSetResultArrays ()
 
const char * GetElementSetResultArrayName (int index)
 
int GetElementSetResultArrayStatus (const char *name)
 
void SetElementSetResultArrayStatus (const char *name, int flag)
 
void Reset ()
 Reset the user-specified parameters and flush internal arrays so that the reader state is just as it was after the reader was instantiated.
 
void ResetSettings ()
 Reset the user-specified parameters to their default values.
 
void ResetCache ()
 Clears out the cache entries.
 
void SetCacheSize (double CacheSize)
 Set the size of the cache in MiB.
 
double GetCacheSize ()
 Get the size of the cache in MiB.
 
virtual void Dump ()
 
vtkGraphGetSIL ()
 SIL describes organization of/relationships between classifications eg.
 
 vtkGetFilePathMacro (FileName)
 Specify file name of the Exodus file.
 
virtual void SetXMLFileName (VTK_FILEPATH const char *fname)
 Specify file name of the xml file.
 
 vtkGetFilePathMacro (XMLFileName)
 Specify file name of the xml file.
 
virtual void SetTimeStep (int)
 Which TimeStep to read.
 
virtual int GetTimeStep ()
 Which TimeStep to read.
 
virtual int * GetModeShapesRange ()
 Since ModeShapes are expected to run from [1,N] rather than [0, N-1], this method will return the TimeStepRange offset by 1.
 
virtual void GetModeShapesRange (int &, int &)
 Since ModeShapes are expected to run from [1,N] rather than [0, N-1], this method will return the TimeStepRange offset by 1.
 
virtual void GetModeShapesRange (int[2])
 Since ModeShapes are expected to run from [1,N] rather than [0, N-1], this method will return the TimeStepRange offset by 1.
 
virtual int * GetTimeStepRange ()
 Returns the available range of valid integer time steps.
 
virtual void GetTimeStepRange (int &, int &)
 Returns the available range of valid integer time steps.
 
virtual void GetTimeStepRange (int[2])
 Returns the available range of valid integer time steps.
 
virtual void SetApplyDisplacements (vtkTypeBool d)
 Geometric locations can include displacements.
 
vtkTypeBool GetApplyDisplacements ()
 Geometric locations can include displacements.
 
virtual void ApplyDisplacementsOn ()
 Geometric locations can include displacements.
 
virtual void ApplyDisplacementsOff ()
 Geometric locations can include displacements.
 
virtual void SetDisplacementMagnitude (float s)
 Geometric locations can include displacements.
 
float GetDisplacementMagnitude ()
 Geometric locations can include displacements.
 
virtual void SetHasModeShapes (vtkTypeBool ms)
 Set/Get whether the Exodus sequence number corresponds to time steps or mode shapes.
 
vtkTypeBool GetHasModeShapes ()
 Set/Get whether the Exodus sequence number corresponds to time steps or mode shapes.
 
virtual void HasModeShapesOn ()
 Set/Get whether the Exodus sequence number corresponds to time steps or mode shapes.
 
virtual void HasModeShapesOff ()
 Set/Get whether the Exodus sequence number corresponds to time steps or mode shapes.
 
virtual void SetModeShapeTime (double phase)
 Set/Get the time used to animate mode shapes.
 
double GetModeShapeTime ()
 Set/Get the time used to animate mode shapes.
 
virtual void SetAnimateModeShapes (vtkTypeBool flag)
 If this flag is on (the default) and HasModeShapes is also on, then this reader will report a continuous time range [0,1] and animate the displacements in a periodic sinusoid.
 
vtkTypeBool GetAnimateModeShapes ()
 If this flag is on (the default) and HasModeShapes is also on, then this reader will report a continuous time range [0,1] and animate the displacements in a periodic sinusoid.
 
virtual void AnimateModeShapesOn ()
 If this flag is on (the default) and HasModeShapes is also on, then this reader will report a continuous time range [0,1] and animate the displacements in a periodic sinusoid.
 
virtual void AnimateModeShapesOff ()
 If this flag is on (the default) and HasModeShapes is also on, then this reader will report a continuous time range [0,1] and animate the displacements in a periodic sinusoid.
 
virtual void SetIgnoreFileTime (bool flag)
 When on, this option ignores the time values assigned to each time step in the file.
 
bool GetIgnoreFileTime ()
 When on, this option ignores the time values assigned to each time step in the file.
 
virtual void IgnoreFileTimeOn ()
 When on, this option ignores the time values assigned to each time step in the file.
 
virtual void IgnoreFileTimeOff ()
 When on, this option ignores the time values assigned to each time step in the file.
 
const char * GetTitle ()
 Access to meta data generated by UpdateInformation.
 
int GetDimensionality ()
 Access to meta data generated by UpdateInformation.
 
int GetNumberOfTimeSteps ()
 Access to meta data generated by UpdateInformation.
 
int GetNumberOfObjectArrays (int objectType)
 By default arrays are not loaded.
 
const char * GetObjectArrayName (int objectType, int arrayIndex)
 By default arrays are not loaded.
 
int GetObjectArrayIndex (int objectType, const char *arrayName)
 By default arrays are not loaded.
 
int GetNumberOfObjectArrayComponents (int objectType, int arrayIndex)
 By default arrays are not loaded.
 
int GetObjectArrayStatus (int objectType, int arrayIndex)
 By default arrays are not loaded.
 
int GetObjectArrayStatus (int objectType, const char *arrayName)
 By default arrays are not loaded.
 
void SetObjectArrayStatus (int objectType, int arrayIndex, int status)
 By default arrays are not loaded.
 
void SetObjectArrayStatus (int objectType, const char *arrayName, int status)
 By default arrays are not loaded.
 
int GetNumberOfObjectAttributes (int objectType, int objectIndex)
 By default attributes are not loaded.
 
const char * GetObjectAttributeName (int objectType, int objectIndex, int attribIndex)
 By default attributes are not loaded.
 
int GetObjectAttributeIndex (int objectType, int objectIndex, const char *attribName)
 By default attributes are not loaded.
 
int GetObjectAttributeStatus (int objectType, int objectIndex, int attribIndex)
 By default attributes are not loaded.
 
int GetObjectAttributeStatus (int objectType, int objectIndex, const char *attribName)
 By default attributes are not loaded.
 
void SetObjectAttributeStatus (int objectType, int objectIndex, int attribIndex, int status)
 By default attributes are not loaded.
 
void SetObjectAttributeStatus (int objectType, int objectIndex, const char *attribName, int status)
 By default attributes are not loaded.
 
int GetNumberOfPartArrays ()
 By default all parts are loaded.
 
const char * GetPartArrayName (int arrayIdx)
 By default all parts are loaded.
 
int GetPartArrayID (const char *name)
 By default all parts are loaded.
 
const char * GetPartBlockInfo (int arrayIdx)
 By default all parts are loaded.
 
void SetPartArrayStatus (int index, int flag)
 By default all parts are loaded.
 
void SetPartArrayStatus (const char *, int flag)
 By default all parts are loaded.
 
int GetPartArrayStatus (int index)
 By default all parts are loaded.
 
int GetPartArrayStatus (const char *)
 By default all parts are loaded.
 
int GetNumberOfMaterialArrays ()
 By default all materials are loaded.
 
const char * GetMaterialArrayName (int arrayIdx)
 By default all materials are loaded.
 
int GetMaterialArrayID (const char *name)
 By default all materials are loaded.
 
void SetMaterialArrayStatus (int index, int flag)
 By default all materials are loaded.
 
void SetMaterialArrayStatus (const char *, int flag)
 By default all materials are loaded.
 
int GetMaterialArrayStatus (int index)
 By default all materials are loaded.
 
int GetMaterialArrayStatus (const char *)
 By default all materials are loaded.
 
int GetNumberOfAssemblyArrays ()
 By default all assemblies are loaded.
 
const char * GetAssemblyArrayName (int arrayIdx)
 By default all assemblies are loaded.
 
int GetAssemblyArrayID (const char *name)
 By default all assemblies are loaded.
 
void SetAssemblyArrayStatus (int index, int flag)
 By default all assemblies are loaded.
 
void SetAssemblyArrayStatus (const char *, int flag)
 By default all assemblies are loaded.
 
int GetAssemblyArrayStatus (int index)
 By default all assemblies are loaded.
 
int GetAssemblyArrayStatus (const char *)
 By default all assemblies are loaded.
 
int GetNumberOfHierarchyArrays ()
 By default all hierarchy entries are loaded.
 
const char * GetHierarchyArrayName (int arrayIdx)
 By default all hierarchy entries are loaded.
 
void SetHierarchyArrayStatus (int index, int flag)
 By default all hierarchy entries are loaded.
 
void SetHierarchyArrayStatus (const char *, int flag)
 By default all hierarchy entries are loaded.
 
int GetHierarchyArrayStatus (int index)
 By default all hierarchy entries are loaded.
 
int GetHierarchyArrayStatus (const char *)
 By default all hierarchy entries are loaded.
 
void SetSqueezePoints (bool sp)
 Should the reader output only points used by elements in the output mesh, or all the points.
 
bool GetSqueezePoints ()
 Should the reader output only points used by elements in the output mesh, or all the points.
 
virtual int GetSILUpdateStamp ()
 Every time the SIL is updated a this will return a different value.
 
int GetMaxNameLength ()
 Get the max_name_length in the file.
 
virtual void SetUseLegacyBlockNames (bool)
 In previous versions, the reader added the type of elements in the block to the block name when no name was provided for the block.
 
virtual bool GetUseLegacyBlockNames ()
 In previous versions, the reader added the type of elements in the block to the block name when no name was provided for the block.
 
virtual void UseLegacyBlockNamesOn ()
 In previous versions, the reader added the type of elements in the block to the block name when no name was provided for the block.
 
virtual void UseLegacyBlockNamesOff ()
 In previous versions, the reader added the type of elements in the block to the block name when no name was provided for the block.
 
virtual void SetGenerateObjectIdCellArray (vtkTypeBool g)
 Extra cell data array that can be generated.
 
vtkTypeBool GetGenerateObjectIdCellArray ()
 Extra cell data array that can be generated.
 
virtual void GenerateObjectIdCellArrayOn ()
 Extra cell data array that can be generated.
 
virtual void GenerateObjectIdCellArrayOff ()
 Extra cell data array that can be generated.
 
- Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkMultiBlockDataSetAlgorithmNewInstance () 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 **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details
 
vtkMultiBlockDataSetGetOutput ()
 Get the output data object for a port on this algorithm.
 
vtkMultiBlockDataSetGetOutput (int)
 Get the output data object for a port on this algorithm.
 
void SetInputData (vtkDataObject *)
 Assign a data object as input.
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input.
 
- 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.
 
vtkAlgorithmNewInstance () 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.
 
vtkExecutiveGetExecutive ()
 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.
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
 
vtkInformationGetOutputPortInformation (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().
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
 
void RemoveAllInputs ()
 Remove all the input data.
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
 
vtkDataObjectGetInputDataObject (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
 
vtkAlgorithmOutputGetOutputPort ()
 
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.
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
 
vtkInformationGetOutputInformation (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 vtkInformationGetInformation ()
 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 vtkProgressObserverGetProgressObserver ()
 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.
 
vtkCommandGetCommand (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 vtkPExodusIIReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPExodusIIReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkExodusIIReader
static vtkExodusIIReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkExodusIIReaderSafeDownCast (vtkObjectBase *o)
 
static const char * GetGlobalElementIdArrayName ()
 
static const char * GetPedigreeElementIdArrayName ()
 
static int GetGlobalElementID (vtkDataSet *data, int localID)
 
static int GetGlobalElementID (vtkDataSet *data, int localID, int searchType)
 
static const char * GetImplicitElementIdArrayName ()
 
static const char * GetGlobalFaceIdArrayName ()
 
static const char * GetPedigreeFaceIdArrayName ()
 
static int GetGlobalFaceID (vtkDataSet *data, int localID)
 
static int GetGlobalFaceID (vtkDataSet *data, int localID, int searchType)
 
static const char * GetImplicitFaceIdArrayName ()
 
static const char * GetGlobalEdgeIdArrayName ()
 
static const char * GetPedigreeEdgeIdArrayName ()
 
static int GetGlobalEdgeID (vtkDataSet *data, int localID)
 
static int GetGlobalEdgeID (vtkDataSet *data, int localID, int searchType)
 
static const char * GetImplicitEdgeIdArrayName ()
 
static const char * GetSideSetSourceElementIdArrayName ()
 Get the name of the array that stores the mapping from side set cells back to the global id of the elements they bound.
 
static const char * GetSideSetSourceElementSideArrayName ()
 Get the name of the array that stores the mapping from side set cells back to the canonical side of the elements they bound.
 
static const char * GetGlobalNodeIdArrayName ()
 Extra point data array that can be generated.
 
static const char * GetPedigreeNodeIdArrayName ()
 Extra point data array that can be generated.
 
static int GetGlobalNodeID (vtkDataSet *data, int localID)
 Extra point data array that can be generated.
 
static int GetGlobalNodeID (vtkDataSet *data, int localID, int searchType)
 Extra point data array that can be generated.
 
static const char * GetImplicitNodeIdArrayName ()
 Extra point data array that can be generated.
 
static vtkInformationIntegerKeyGLOBAL_VARIABLE ()
 Exodus reader outputs global variables and global temporal variables, together with some other variables as FieldData.
 
static vtkInformationIntegerKeyGLOBAL_TEMPORAL_VARIABLE ()
 Exodus reader outputs global variables and global temporal variables, together with some other variables as FieldData.
 
static const char * GetObjectIdArrayName ()
 Extra cell data array that can be generated.
 
- Static Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
static vtkMultiBlockDataSetAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMultiBlockDataSetAlgorithmSafeDownCast (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.
 
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.
 
static vtkInformationIntegerKeyCAN_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 vtkObjectNew ()
 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkPExodusIIReader ()
 
 ~vtkPExodusIIReader () override
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass.
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass.
 
- Protected Member Functions inherited from vtkExodusIIReader
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkExodusIIReader ()
 
 ~vtkExodusIIReader () override
 
virtual void SetMetadata (vtkExodusIIReaderPrivate *)
 
virtual vtkExodusIIReaderPrivateGetMetadata ()
 
bool FindXMLFile ()
 Returns true if the file given by XMLFileName exists.
 
void GetAllTimes (vtkInformationVector *)
 
void AdvertiseTimeSteps (vtkInformation *outputInfo)
 Populates the TIME_STEPS and TIME_RANGE keys based on file metadata.
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass.
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass.
 
- Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkMultiBlockDataSetAlgorithm ()
 
 ~vtkMultiBlockDataSetAlgorithm () override=default
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass.
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass.
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass.
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive.
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm.
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm.
 
vtkDataObjectGetInput (int port)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass.
 
- Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBaseNewInstanceInternal () 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.
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
 
virtual vtkExecutiveCreateDefaultExecutive ()
 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.
 
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.
 
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.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
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.
 
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.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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 &)
 

Protected Attributes

double VariableCacheSize
 
vtkMultiProcessControllerController
 
vtkIdType ProcRank
 
vtkIdType ProcSize
 
char * FilePattern
 
char * CurrentFilePattern
 
char * FilePrefix
 
char * CurrentFilePrefix
 
char * MultiFileName
 
int FileRange [2]
 
int CurrentFileRange [2]
 
int NumberOfFiles
 
char ** FileNames
 
int NumberOfFileNames
 
std::vector< vtkExodusIIReader * > ReaderList
 
std::vector< int > NumberOfPointsPerFile
 
std::vector< int > NumberOfCellsPerFile
 
int LastCommonTimeStep
 
int Timing
 
vtkTimerLogTimerLog
 
- Protected Attributes inherited from vtkExodusIIReader
char * FileName
 
char * XMLFileName
 
int TimeStep
 
int TimeStepRange [2]
 
vtkTimeStamp FileNameMTime
 
vtkTimeStamp XMLFileNameMTime
 
int DisplayType
 
vtkExodusIIReaderPrivateMetadata
 
int SILUpdateStamp
 
- 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.
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
int DeterminePattern (const char *file)
 Try to "guess" the pattern of files.
 
static int DetermineFileId (const char *file)
 Try to "guess" the pattern of files.
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkExodusIIReader
static int GetIDHelper (const char *arrayName, vtkDataSet *data, int localID, int searchType)
 
static int GetGlobalID (const char *arrayName, vtkDataSet *data, int localID, int searchType)
 
- 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 ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Read Exodus II files (.exii)

vtkPExodusIIReader is a unstructured grid source object that reads ExodusII files. Most of the meta data associated with the file is loaded when UpdateInformation is called. This includes information like Title, number of blocks, number and names of arrays. This data can be retrieved from methods in this reader. Separate arrays that are meant to be a single vector, are combined internally for convenience. To be combined, the array names have to be identical except for a trailing X,Y and Z (or x,y,z). By default all cell and point arrays are loaded. However, the user can flag arrays not to load with the methods "SetPointDataArrayLoadFlag" and "SetCellDataArrayLoadFlag". The reader responds to piece requests by loading only a range of the possible blocks. Unused points are filtered out internally.

Definition at line 50 of file vtkPExodusIIReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 54 of file vtkPExodusIIReader.h.

Constructor & Destructor Documentation

◆ vtkPExodusIIReader()

vtkPExodusIIReader::vtkPExodusIIReader ( )
protected

◆ ~vtkPExodusIIReader()

vtkPExodusIIReader::~vtkPExodusIIReader ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPExodusIIReader * vtkPExodusIIReader::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPExodusIIReader::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 vtkExodusIIReader.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPExodusIIReader::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkExodusIIReader.

◆ NewInstance()

vtkPExodusIIReader * vtkPExodusIIReader::NewInstance ( ) const

◆ PrintSelf()

void vtkPExodusIIReader::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 vtkExodusIIReader.

◆ SetController()

void vtkPExodusIIReader::SetController ( vtkMultiProcessController c)

Set/get the communication object used to relay a list of files from the rank 0 process to all others.

This is the only interprocess communication required by vtkPExodusIIReader.

◆ GetController()

virtual vtkMultiProcessController * vtkPExodusIIReader::GetController ( )
virtual

Set/get the communication object used to relay a list of files from the rank 0 process to all others.

This is the only interprocess communication required by vtkPExodusIIReader.

◆ vtkSetFilePathMacro() [1/2]

vtkPExodusIIReader::vtkSetFilePathMacro ( FilePattern  )

These methods tell the reader that the data is distributed across multiple files.

This is for distributed execution. It this case, pieces are mapped to files. The pattern should have one d to format the file number. FileNumberRange is used to generate file numbers. I was thinking of having an arbitrary list of file numbers. This may happen in the future. (That is why there is no GetFileNumberRange method.

◆ vtkGetFilePathMacro() [1/2]

vtkPExodusIIReader::vtkGetFilePathMacro ( FilePattern  )

These methods tell the reader that the data is distributed across multiple files.

This is for distributed execution. It this case, pieces are mapped to files. The pattern should have one d to format the file number. FileNumberRange is used to generate file numbers. I was thinking of having an arbitrary list of file numbers. This may happen in the future. (That is why there is no GetFileNumberRange method.

◆ vtkSetFilePathMacro() [2/2]

vtkPExodusIIReader::vtkSetFilePathMacro ( FilePrefix  )

These methods tell the reader that the data is distributed across multiple files.

This is for distributed execution. It this case, pieces are mapped to files. The pattern should have one d to format the file number. FileNumberRange is used to generate file numbers. I was thinking of having an arbitrary list of file numbers. This may happen in the future. (That is why there is no GetFileNumberRange method.

◆ vtkGetFilePathMacro() [2/2]

vtkPExodusIIReader::vtkGetFilePathMacro ( FilePrefix  )

These methods tell the reader that the data is distributed across multiple files.

This is for distributed execution. It this case, pieces are mapped to files. The pattern should have one d to format the file number. FileNumberRange is used to generate file numbers. I was thinking of having an arbitrary list of file numbers. This may happen in the future. (That is why there is no GetFileNumberRange method.

◆ SetFileRange() [1/2]

void vtkPExodusIIReader::SetFileRange ( int  ,
int   
)

Set the range of files that are being loaded.

The range for single file should add to 0.

◆ SetFileRange() [2/2]

void vtkPExodusIIReader::SetFileRange ( int *  r)
inline

Set the range of files that are being loaded.

The range for single file should add to 0.

Definition at line 89 of file vtkPExodusIIReader.h.

◆ GetFileRange() [1/3]

virtual int * vtkPExodusIIReader::GetFileRange ( )
virtual

Set the range of files that are being loaded.

The range for single file should add to 0.

◆ GetFileRange() [2/3]

virtual void vtkPExodusIIReader::GetFileRange ( int &  ,
int &   
)
virtual

Set the range of files that are being loaded.

The range for single file should add to 0.

◆ GetFileRange() [3/3]

virtual void vtkPExodusIIReader::GetFileRange ( int  [2])
virtual

Set the range of files that are being loaded.

The range for single file should add to 0.

◆ SetFileNames()

void vtkPExodusIIReader::SetFileNames ( int  nfiles,
const char **  names 
)

Provide an arbitrary list of file names instead of a prefix, pattern and range.

Overrides any prefix, pattern and range that is specified. vtkPExodusIIReader makes it's own copy of your file names.

◆ SetFileName()

void vtkPExodusIIReader::SetFileName ( VTK_FILEPATH const char *  fname)
overridevirtual

Specify file name of the Exodus file.

Reimplemented from vtkExodusIIReader.

◆ GetFileNames()

char ** vtkPExodusIIReader::GetFileNames ( )
inline

Return pointer to list of file names set in SetFileNames.

Definition at line 106 of file vtkPExodusIIReader.h.

◆ GetNumberOfFileNames()

int vtkPExodusIIReader::GetNumberOfFileNames ( )
inline

Return number of file names set in SetFileNames.

Definition at line 111 of file vtkPExodusIIReader.h.

◆ GetNumberOfFiles()

virtual int vtkPExodusIIReader::GetNumberOfFiles ( )
virtual

Return the number of files to be read.

◆ GetTotalNumberOfElements()

vtkIdType vtkPExodusIIReader::GetTotalNumberOfElements ( )
overridevirtual

Reimplemented from vtkExodusIIReader.

◆ GetTotalNumberOfNodes()

vtkIdType vtkPExodusIIReader::GetTotalNumberOfNodes ( )
overridevirtual

Reimplemented from vtkExodusIIReader.

◆ Broadcast()

virtual void vtkPExodusIIReader::Broadcast ( vtkMultiProcessController ctrl)
virtual

Sends metadata (that read from the input file, not settings modified through this API) from the rank 0 node to all other processes in a job.

◆ GetVariableCacheSize()

virtual double vtkPExodusIIReader::GetVariableCacheSize ( )
virtual

The size of the variable cache in MegaByes.

This represents the maximum size of cache that a single partition reader can have while reading. When a reader is finished its cache size will be set to a fraction of this based on the number of partitions. The Default for this is 100MiB. Note that because each reader still holds a fraction of the cache size after reading the total amount of data cached can be at most twice this size.

◆ SetVariableCacheSize()

virtual void vtkPExodusIIReader::SetVariableCacheSize ( double  )
virtual

The size of the variable cache in MegaByes.

This represents the maximum size of cache that a single partition reader can have while reading. When a reader is finished its cache size will be set to a fraction of this based on the number of partitions. The Default for this is 100MiB. Note that because each reader still holds a fraction of the cache size after reading the total amount of data cached can be at most twice this size.

◆ DeterminePattern()

int vtkPExodusIIReader::DeterminePattern ( const char *  file)
protected

Try to "guess" the pattern of files.

◆ DetermineFileId()

static int vtkPExodusIIReader::DetermineFileId ( const char *  file)
staticprotected

Try to "guess" the pattern of files.

◆ RequestInformation()

int vtkPExodusIIReader::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkExodusIIReader.

◆ RequestData()

int vtkPExodusIIReader::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkExodusIIReader.

Member Data Documentation

◆ VariableCacheSize

double vtkPExodusIIReader::VariableCacheSize
protected

Definition at line 157 of file vtkPExodusIIReader.h.

◆ Controller

vtkMultiProcessController* vtkPExodusIIReader::Controller
protected

Definition at line 162 of file vtkPExodusIIReader.h.

◆ ProcRank

vtkIdType vtkPExodusIIReader::ProcRank
protected

Definition at line 163 of file vtkPExodusIIReader.h.

◆ ProcSize

vtkIdType vtkPExodusIIReader::ProcSize
protected

Definition at line 164 of file vtkPExodusIIReader.h.

◆ FilePattern

char* vtkPExodusIIReader::FilePattern
protected

Definition at line 165 of file vtkPExodusIIReader.h.

◆ CurrentFilePattern

char* vtkPExodusIIReader::CurrentFilePattern
protected

Definition at line 166 of file vtkPExodusIIReader.h.

◆ FilePrefix

char* vtkPExodusIIReader::FilePrefix
protected

Definition at line 167 of file vtkPExodusIIReader.h.

◆ CurrentFilePrefix

char* vtkPExodusIIReader::CurrentFilePrefix
protected

Definition at line 168 of file vtkPExodusIIReader.h.

◆ MultiFileName

char* vtkPExodusIIReader::MultiFileName
protected

Definition at line 169 of file vtkPExodusIIReader.h.

◆ FileRange

int vtkPExodusIIReader::FileRange[2]
protected

Definition at line 170 of file vtkPExodusIIReader.h.

◆ CurrentFileRange

int vtkPExodusIIReader::CurrentFileRange[2]
protected

Definition at line 171 of file vtkPExodusIIReader.h.

◆ NumberOfFiles

int vtkPExodusIIReader::NumberOfFiles
protected

Definition at line 172 of file vtkPExodusIIReader.h.

◆ FileNames

char** vtkPExodusIIReader::FileNames
protected

Definition at line 173 of file vtkPExodusIIReader.h.

◆ NumberOfFileNames

int vtkPExodusIIReader::NumberOfFileNames
protected

Definition at line 174 of file vtkPExodusIIReader.h.

◆ ReaderList

std::vector<vtkExodusIIReader*> vtkPExodusIIReader::ReaderList
protected

Definition at line 176 of file vtkPExodusIIReader.h.

◆ NumberOfPointsPerFile

std::vector<int> vtkPExodusIIReader::NumberOfPointsPerFile
protected

Definition at line 177 of file vtkPExodusIIReader.h.

◆ NumberOfCellsPerFile

std::vector<int> vtkPExodusIIReader::NumberOfCellsPerFile
protected

Definition at line 178 of file vtkPExodusIIReader.h.

◆ LastCommonTimeStep

int vtkPExodusIIReader::LastCommonTimeStep
protected

Definition at line 180 of file vtkPExodusIIReader.h.

◆ Timing

int vtkPExodusIIReader::Timing
protected

Definition at line 182 of file vtkPExodusIIReader.h.

◆ TimerLog

vtkTimerLog* vtkPExodusIIReader::TimerLog
protected

Definition at line 183 of file vtkPExodusIIReader.h.


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