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

class to read EnSight Gold files More...

#include <vtkEnSightGoldReader.h>

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

Public Types

typedef vtkEnSightReader Superclass
 
- Public Types inherited from vtkEnSightReader
enum  ElementTypesList {
  POINT = 0, BAR2 = 1, BAR3 = 2, NSIDED = 3,
  TRIA3 = 4, TRIA6 = 5, QUAD4 = 6, QUAD8 = 7,
  NFACED = 8, TETRA4 = 9, TETRA10 = 10, PYRAMID5 = 11,
  PYRAMID13 = 12, HEXA8 = 13, HEXA20 = 14, PENTA6 = 15,
  PENTA15 = 16, NUMBER_OF_ELEMENT_TYPES = 17
}
 
enum  VariableTypesList {
  SCALAR_PER_NODE = 0, VECTOR_PER_NODE = 1, TENSOR_SYMM_PER_NODE = 2, SCALAR_PER_ELEMENT = 3,
  VECTOR_PER_ELEMENT = 4, TENSOR_SYMM_PER_ELEMENT = 5, SCALAR_PER_MEASURED_NODE = 6, VECTOR_PER_MEASURED_NODE = 7,
  COMPLEX_SCALAR_PER_NODE = 8, COMPLEX_VECTOR_PER_NODE = 9, COMPLEX_SCALAR_PER_ELEMENT = 10, COMPLEX_VECTOR_PER_ELEMENT = 11
}
 
enum  SectionTypeList { COORDINATES = 0, BLOCK = 1, ELEMENT = 2 }
 
typedef vtkGenericEnSightReader Superclass
 
- Public Types inherited from vtkGenericEnSightReader
enum  FileTypes {
  ENSIGHT_6 = 0, ENSIGHT_6_BINARY = 1, ENSIGHT_GOLD = 2, ENSIGHT_GOLD_BINARY = 3,
  ENSIGHT_MASTER_SERVER = 4
}
 
enum  { FILE_BIG_ENDIAN =0, FILE_LITTLE_ENDIAN =1, FILE_UNKNOWN_ENDIAN =2 }
 
typedef vtkMultiBlockDataSetAlgorithm Superclass
 
- 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. More...
 
vtkEnSightGoldReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
- Public Member Functions inherited from vtkEnSightReader
vtkEnSightReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual char * GetMeasuredFileName ()
 Get the Measured file name. More...
 
virtual char * GetMatchFileName ()
 Get the Match file name. More...
 
- Public Member Functions inherited from vtkGenericEnSightReader
vtkGenericEnSightReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetCaseFileName (const char *fileName)
 Set/Get the Case file name. More...
 
virtual char * GetCaseFileName ()
 
virtual void SetFilePath (const char *)
 Set/Get the file path. More...
 
virtual char * GetFilePath ()
 
virtual int GetEnSightVersion ()
 Get the EnSight file version being read. More...
 
virtual int GetNumberOfVariables ()
 Get the number of variables listed in the case file. More...
 
virtual int GetNumberOfComplexVariables ()
 
int GetNumberOfVariables (int type)
 Get the number of variables of a particular type. More...
 
virtual int GetNumberOfScalarsPerNode ()
 
virtual int GetNumberOfVectorsPerNode ()
 
virtual int GetNumberOfTensorsSymmPerNode ()
 
virtual int GetNumberOfScalarsPerElement ()
 
virtual int GetNumberOfVectorsPerElement ()
 
virtual int GetNumberOfTensorsSymmPerElement ()
 
virtual int GetNumberOfScalarsPerMeasuredNode ()
 
virtual int GetNumberOfVectorsPerMeasuredNode ()
 
virtual int GetNumberOfComplexScalarsPerNode ()
 
virtual int GetNumberOfComplexVectorsPerNode ()
 
virtual int GetNumberOfComplexScalarsPerElement ()
 
virtual int GetNumberOfComplexVectorsPerElement ()
 
const char * GetDescription (int n)
 Get the nth description for a non-complex variable. More...
 
const char * GetComplexDescription (int n)
 Get the nth description for a complex variable. More...
 
const char * GetDescription (int n, int type)
 Get the nth description of a particular variable type. More...
 
int GetVariableType (int n)
 Get the variable type of variable n. More...
 
int GetComplexVariableType (int n)
 
virtual void SetTimeValue (float value)
 Set/Get the time value at which to get the value. More...
 
virtual float GetTimeValue ()
 
virtual float GetMinimumTimeValue ()
 Get the minimum or maximum time value for this data set. More...
 
virtual float GetMaximumTimeValue ()
 
virtual vtkDataArrayCollectionGetTimeSets ()
 Get the time values per time set. More...
 
int DetermineEnSightVersion (int quiet=0)
 Reads the FORMAT part of the case file to determine whether this is an EnSight6 or EnSightGold data set. More...
 
virtual void ReadAllVariablesOn ()
 Set/get the flag for whether to read all the variables. More...
 
virtual void ReadAllVariablesOff ()
 
virtual void SetReadAllVariables (vtkTypeBool)
 
virtual vtkTypeBool GetReadAllVariables ()
 
virtual vtkDataArraySelectionGetPointDataArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader. More...
 
virtual vtkDataArraySelectionGetCellDataArraySelection ()
 
int GetNumberOfPointArrays ()
 Get the number of point or cell arrays available in the input. More...
 
int GetNumberOfCellArrays ()
 
const char * GetPointArrayName (int index)
 Get the name of the point or cell array with the given index in the input. More...
 
const char * GetCellArrayName (int index)
 
int GetPointArrayStatus (const char *name)
 Get/Set whether the point or cell array with the given name is to be read. More...
 
int GetCellArrayStatus (const char *name)
 
void SetPointArrayStatus (const char *name, int status)
 
void SetCellArrayStatus (const char *name, int status)
 
void SetByteOrderToBigEndian ()
 Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian). More...
 
void SetByteOrderToLittleEndian ()
 
virtual void SetByteOrder (int)
 
virtual int GetByteOrder ()
 
const char * GetByteOrderAsString ()
 
virtual char * GetGeometryFileName ()
 Get the Geometry file name. More...
 
virtual void SetParticleCoordinatesByIndex (vtkTypeBool)
 The MeasuredGeometryFile should list particle coordinates from 0->N-1. More...
 
virtual vtkTypeBool GetParticleCoordinatesByIndex ()
 
virtual void ParticleCoordinatesByIndexOn ()
 
virtual void ParticleCoordinatesByIndexOff ()
 
virtual int CanReadFile (const char *casefilename)
 Returns IsEnSightFile() by default, but can be overridden. More...
 
vtkGenericEnSightReaderGetReader ()
 
- Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
vtkMultiBlockDataSetAlgorithmNewInstance () const
 
vtkMultiBlockDataSetGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkMultiBlockDataSetGetOutput (int)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details 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...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
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 Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the 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 ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
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)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
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 SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
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 void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
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 void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- 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...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkEnSightGoldReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkEnSightGoldReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkEnSightReader
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkEnSightReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkGenericEnSightReader
static vtkGenericEnSightReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGenericEnSightReaderSafeDownCast (vtkObjectBase *o)
 
static bool IsEnSightFile (const char *casefilename)
 Returns true if the file pointed to by casefilename appears to be a valid EnSight case file. More...
 
- 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. 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkEnSightGoldReader ()
 
 ~vtkEnSightGoldReader () override
 
int ReadGeometryFile (const char *fileName, int timeStep, vtkMultiBlockDataSet *output) override
 Read the geometry file. More...
 
int ReadMeasuredGeometryFile (const char *fileName, int timeStep, vtkMultiBlockDataSet *output) override
 Read the measured geometry file. More...
 
int ReadScalarsPerNode (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output, int measured=0, int numberOfComponents=1, int component=0) override
 Read scalars per node for this dataset. More...
 
int ReadVectorsPerNode (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output, int measured=0) override
 Read vectors per node for this dataset. More...
 
int ReadTensorsPerNode (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output) override
 Read tensors per node for this dataset. More...
 
int ReadScalarsPerElement (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output, int numberOfComponents=1, int component=0) override
 Read scalars per element for this dataset. More...
 
int ReadVectorsPerElement (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output) override
 Read vectors per element for this dataset. More...
 
int ReadTensorsPerElement (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output) override
 Read tensors per element for this dataset. More...
 
int CreateUnstructuredGridOutput (int partId, char line[256], const char *name, vtkMultiBlockDataSet *output) override
 Read an unstructured part (partId) from the geometry file and create a vtkUnstructuredGrid output. More...
 
int CreateStructuredGridOutput (int partId, char line[256], const char *name, vtkMultiBlockDataSet *output) override
 Read a structured part from the geometry file and create a vtkStructuredGrid output. More...
 
int CreateRectilinearGridOutput (int partId, char line[256], const char *name, vtkMultiBlockDataSet *output)
 Read a structured part from the geometry file and create a vtkRectilinearGrid output. More...
 
int CreateImageDataOutput (int partId, char line[256], const char *name, vtkMultiBlockDataSet *output)
 Read a structured part from the geometry file and create a vtkImageData output. More...
 
int CheckForUndefOrPartial (const char *line)
 Skip next line in file if the 'undef' or 'partial' keyword was specified after a sectional keyword. More...
 
- Protected Member Functions inherited from vtkEnSightReader
 vtkEnSightReader ()
 
 ~vtkEnSightReader () override
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
void ClearForNewCaseFileName () override
 Clear data structures such that setting a new case file name works. More...
 
virtual void SetMeasuredFileName (const char *)
 Set the Measured file name. More...
 
virtual void SetMatchFileName (const char *)
 Set the Match file name. More...
 
int ReadCaseFile ()
 Read the case file. More...
 
int ReadCaseFileGeometry (char *line)
 
int ReadCaseFileVariable (char *line)
 
int ReadCaseFileTime (char *line)
 
int ReadCaseFileFile (char *line)
 
int ReadVariableFiles (vtkMultiBlockDataSet *output)
 Read the variable files. More...
 
virtual int CreateUnstructuredGridOutput (int partId, char line[80], const char *name, vtkMultiBlockDataSet *output)=0
 Read an unstructured part (partId) from the geometry file and create a vtkUnstructuredGrid output. More...
 
virtual int CreateStructuredGridOutput (int partId, char line[80], const char *name, vtkMultiBlockDataSet *output)=0
 Read a structured part from the geometry file and create a vtkStructuredGridOutput. More...
 
void AddVariableFileName (const char *fileName1, const char *fileName2=nullptr)
 Add another file name to the list for a particular variable type. More...
 
void AddVariableDescription (const char *description)
 Add another description to the list for a particular variable type. More...
 
void AddVariableType ()
 Record the variable type for the variable line just read. More...
 
int GetElementType (const char *line)
 Determine the element type from a line read a file. More...
 
int GetSectionType (const char *line)
 Determine the section type from a line read a file. More...
 
void ReplaceWildcards (char *filename, int num)
 Replace the *'s in the filename with the given filename number. More...
 
void RemoveLeadingBlanks (char *line)
 Remove leading blank spaces from a string. More...
 
vtkIdListGetCellIds (int index, int cellType)
 
void AddToBlock (vtkMultiBlockDataSet *output, unsigned int blockNo, vtkDataSet *dataset)
 Convenience method use to convert the readers from VTK 5 multiblock API to the current composite data infrastructure. More...
 
vtkDataSetGetDataSetFromBlock (vtkMultiBlockDataSet *output, unsigned int blockNo)
 Convenience method use to convert the readers from VTK 5 multiblock API to the current composite data infrastructure. More...
 
void SetBlockName (vtkMultiBlockDataSet *output, unsigned int blockNo, const char *name)
 Set the name of a block. More...
 
virtual void SetUseTimeSets (vtkTypeBool)
 
virtual vtkTypeBool GetUseTimeSets ()
 
virtual void UseTimeSetsOn ()
 
virtual void UseTimeSetsOff ()
 
virtual void SetUseFileSets (vtkTypeBool)
 
virtual vtkTypeBool GetUseFileSets ()
 
virtual void UseFileSetsOn ()
 
virtual void UseFileSetsOff ()
 
int CheckOutputConsistency ()
 
- Protected Member Functions inherited from vtkGenericEnSightReader
 vtkGenericEnSightReader ()
 
 ~vtkGenericEnSightReader () override
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int ReadLine (char result[256])
 Internal function to read in a line up to 256 characters. More...
 
int ReadBinaryLine (char result[80])
 Internal function to read up to 80 characters from a binary file. More...
 
int ReadNextDataLine (char result[256])
 
virtual void SetGeometryFileName (const char *)
 Set the geometry file name. More...
 
void AddVariableDescription (const char *description)
 Add a variable description to the appropriate array. More...
 
void AddComplexVariableDescription (const char *description)
 
void AddVariableType (int variableType)
 Add a variable type to the appropriate array. More...
 
void AddComplexVariableType (int variableType)
 
int ReplaceWildcards (char *fileName, int timeSet, int fileSet)
 Replace the wildcards in the geometry file name with appropriate filename numbers as specified in the time set or file set. More...
 
void ReplaceWildcardsHelper (char *fileName, int num)
 
void SelectionModified ()
 
char ** CreateStringArray (int numStrings)
 
void DestroyStringArray (int numStrings, char **strings)
 
void SetDataArraySelectionSetsFromVariables ()
 
void SetDataArraySelectionSetsFromReader ()
 
void SetReaderDataArraySelectionSetsFromSelf ()
 
virtual void SetTimeSets (vtkDataArrayCollection *)
 
int InsertNewPartId (int partId)
 
- Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
 vtkMultiBlockDataSetAlgorithm ()
 
 ~vtkMultiBlockDataSetAlgorithm () override
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
vtkDataObjectGetInput (int port)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
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...
 
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)
 
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)
 
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)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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)
 
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)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. 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)
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int NodeIdsListed
 
int ElementIdsListed
 
UndefPartialInternal * UndefPartial
 Handle the undef / partial support for EnSight gold. More...
 
FileOffsetMapInternal * FileOffsets
 
- Protected Attributes inherited from vtkEnSightReader
int CaseFileRead
 
char * MeasuredFileName
 
char * MatchFileName
 
vtkEnSightReaderCellIdsType * CellIds
 
vtkIdListUnstructuredPartIds
 
int VariableMode
 
char ** VariableFileNames
 
char ** ComplexVariableFileNames
 
vtkIdListVariableTimeSetIds
 
vtkIdListComplexVariableTimeSetIds
 
vtkIdListVariableFileSetIds
 
vtkIdListComplexVariableFileSetIds
 
vtkIdListCollectionTimeSetFileNameNumbers
 
vtkIdListTimeSetsWithFilenameNumbers
 
vtkIdListCollectionFileSetFileNameNumbers
 
vtkIdListFileSetsWithFilenameNumbers
 
vtkIdListCollectionFileSetNumberOfSteps
 
vtkIdListTimeSetIds
 
vtkIdListFileSets
 
int GeometryTimeSet
 
int GeometryFileSet
 
int MeasuredTimeSet
 
int MeasuredFileSet
 
float GeometryTimeValue
 
float MeasuredTimeValue
 
vtkTypeBool UseTimeSets
 
vtkTypeBool UseFileSets
 
int NumberOfGeometryParts
 
int NumberOfMeasuredPoints
 
int NumberOfNewOutputs
 
int InitialRead
 
double ActualTimeValue
 
- Protected Attributes inherited from vtkGenericEnSightReader
istream * IS
 
FILE * IFile
 
vtkGenericEnSightReaderReader
 
char * CaseFileName
 
char * GeometryFileName
 
char * FilePath
 
intVariableTypes
 
intComplexVariableTypes
 
char ** VariableDescriptions
 
char ** ComplexVariableDescriptions
 
int NumberOfVariables
 
int NumberOfComplexVariables
 
int NumberOfScalarsPerNode
 
int NumberOfVectorsPerNode
 
int NumberOfTensorsSymmPerNode
 
int NumberOfScalarsPerElement
 
int NumberOfVectorsPerElement
 
int NumberOfTensorsSymmPerElement
 
int NumberOfScalarsPerMeasuredNode
 
int NumberOfVectorsPerMeasuredNode
 
int NumberOfComplexScalarsPerNode
 
int NumberOfComplexVectorsPerNode
 
int NumberOfComplexScalarsPerElement
 
int NumberOfComplexVectorsPerElement
 
float TimeValue
 
float MinimumTimeValue
 
float MaximumTimeValue
 
int TimeValueInitialized
 
vtkDataArrayCollectionTimeSets
 
vtkTypeBool ReadAllVariables
 
int ByteOrder
 
vtkTypeBool ParticleCoordinatesByIndex
 
int EnSightVersion
 
vtkDataArraySelectionPointDataArraySelection
 
vtkDataArraySelectionCellDataArraySelection
 
vtkCallbackCommandSelectionObserver
 
int SelectionModifiedDoNotCallModified
 
TranslationTableType * TranslationTable
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkGenericEnSightReader
static void SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

class to read EnSight Gold files

vtkEnSightGoldReader is a class to read EnSight Gold files into vtk. Because the different parts of the EnSight data can be of various data types, this reader produces multiple outputs, one per part in the input file. All variable information is being stored in field data. The descriptions listed in the case file are used as the array names in the field data. For complex vector variables, the description is appended with _r (for the array of real values) and _i (for the array if imaginary values). Complex scalar variables are stored as a single array with 2 components, real and imaginary, listed in that order.

Warning
You must manually call Update on this reader and then connect the rest of the pipeline because (due to the nature of the file format) it is not possible to know ahead of time how many outputs you will have or what types they will be. This reader can only handle static EnSight datasets (both static geometry and variables).
Thanks:
Thanks to Yvan Fournier for providing the code to support nfaced elements.
Tests:
vtkEnSightGoldReader (Tests)

Definition at line 52 of file vtkEnSightGoldReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 56 of file vtkEnSightGoldReader.h.

Constructor & Destructor Documentation

◆ vtkEnSightGoldReader()

vtkEnSightGoldReader::vtkEnSightGoldReader ( )
protected

◆ ~vtkEnSightGoldReader()

vtkEnSightGoldReader::~vtkEnSightGoldReader ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkEnSightGoldReader* vtkEnSightGoldReader::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkEnSightGoldReader::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 vtkEnSightReader.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkEnSightGoldReader::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkEnSightReader.

◆ NewInstance()

vtkEnSightGoldReader* vtkEnSightGoldReader::NewInstance ( ) const

◆ PrintSelf()

void vtkEnSightGoldReader::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 vtkMultiBlockDataSetAlgorithm.

◆ ReadGeometryFile()

int vtkEnSightGoldReader::ReadGeometryFile ( const char *  fileName,
int  timeStep,
vtkMultiBlockDataSet output 
)
overrideprotectedvirtual

Read the geometry file.

If an error occurred, 0 is returned; otherwise 1.

Implements vtkEnSightReader.

◆ ReadMeasuredGeometryFile()

int vtkEnSightGoldReader::ReadMeasuredGeometryFile ( const char *  fileName,
int  timeStep,
vtkMultiBlockDataSet output 
)
overrideprotectedvirtual

Read the measured geometry file.

If an error occurred, 0 is returned; otherwise 1.

Implements vtkEnSightReader.

◆ ReadScalarsPerNode()

int vtkEnSightGoldReader::ReadScalarsPerNode ( const char *  fileName,
const char *  description,
int  timeStep,
vtkMultiBlockDataSet output,
int  measured = 0,
int  numberOfComponents = 1,
int  component = 0 
)
overrideprotectedvirtual

Read scalars per node for this dataset.

If an error occurred, 0 is returned; otherwise 1. If there will be more than one component in the data array, it is assumed that 0 is the first component added.

Implements vtkEnSightReader.

◆ ReadVectorsPerNode()

int vtkEnSightGoldReader::ReadVectorsPerNode ( const char *  fileName,
const char *  description,
int  timeStep,
vtkMultiBlockDataSet output,
int  measured = 0 
)
overrideprotectedvirtual

Read vectors per node for this dataset.

If an error occurred, 0 is returned; otherwise 1.

Implements vtkEnSightReader.

◆ ReadTensorsPerNode()

int vtkEnSightGoldReader::ReadTensorsPerNode ( const char *  fileName,
const char *  description,
int  timeStep,
vtkMultiBlockDataSet output 
)
overrideprotectedvirtual

Read tensors per node for this dataset.

If an error occurred, 0 is returned; otherwise 1.

Implements vtkEnSightReader.

◆ ReadScalarsPerElement()

int vtkEnSightGoldReader::ReadScalarsPerElement ( const char *  fileName,
const char *  description,
int  timeStep,
vtkMultiBlockDataSet output,
int  numberOfComponents = 1,
int  component = 0 
)
overrideprotectedvirtual

Read scalars per element for this dataset.

If an error occurred, 0 is returned; otherwise 1. If there will be more than one componenet in the data array, it is assumed that 0 is the first component added.

Implements vtkEnSightReader.

◆ ReadVectorsPerElement()

int vtkEnSightGoldReader::ReadVectorsPerElement ( const char *  fileName,
const char *  description,
int  timeStep,
vtkMultiBlockDataSet output 
)
overrideprotectedvirtual

Read vectors per element for this dataset.

If an error occurred, 0 is returned; otherwise 1.

Implements vtkEnSightReader.

◆ ReadTensorsPerElement()

int vtkEnSightGoldReader::ReadTensorsPerElement ( const char *  fileName,
const char *  description,
int  timeStep,
vtkMultiBlockDataSet output 
)
overrideprotectedvirtual

Read tensors per element for this dataset.

If an error occurred, 0 is returned; otherwise 1.

Implements vtkEnSightReader.

◆ CreateUnstructuredGridOutput()

int vtkEnSightGoldReader::CreateUnstructuredGridOutput ( int  partId,
char  line[256],
const char *  name,
vtkMultiBlockDataSet output 
)
overrideprotected

Read an unstructured part (partId) from the geometry file and create a vtkUnstructuredGrid output.

Return 0 if EOF reached. Return -1 if an error occurred.

◆ CreateStructuredGridOutput()

int vtkEnSightGoldReader::CreateStructuredGridOutput ( int  partId,
char  line[256],
const char *  name,
vtkMultiBlockDataSet output 
)
overrideprotected

Read a structured part from the geometry file and create a vtkStructuredGrid output.

Return 0 if EOF reached.

◆ CreateRectilinearGridOutput()

int vtkEnSightGoldReader::CreateRectilinearGridOutput ( int  partId,
char  line[256],
const char *  name,
vtkMultiBlockDataSet output 
)
protected

Read a structured part from the geometry file and create a vtkRectilinearGrid output.

Return 0 if EOF reached.

◆ CreateImageDataOutput()

int vtkEnSightGoldReader::CreateImageDataOutput ( int  partId,
char  line[256],
const char *  name,
vtkMultiBlockDataSet output 
)
protected

Read a structured part from the geometry file and create a vtkImageData output.

Return 0 if EOF reached.

◆ CheckForUndefOrPartial()

int vtkEnSightGoldReader::CheckForUndefOrPartial ( const char *  line)
protected

Skip next line in file if the 'undef' or 'partial' keyword was specified after a sectional keyword.

Member Data Documentation

◆ NodeIdsListed

int vtkEnSightGoldReader::NodeIdsListed
protected

Definition at line 165 of file vtkEnSightGoldReader.h.

◆ ElementIdsListed

int vtkEnSightGoldReader::ElementIdsListed
protected

Definition at line 166 of file vtkEnSightGoldReader.h.

◆ UndefPartial

UndefPartialInternal* vtkEnSightGoldReader::UndefPartial
protected

Handle the undef / partial support for EnSight gold.

Definition at line 168 of file vtkEnSightGoldReader.h.

◆ FileOffsets

FileOffsetMapInternal* vtkEnSightGoldReader::FileOffsets
protected

Definition at line 174 of file vtkEnSightGoldReader.h.


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