vtkExodusIIReaderPrivate Class Reference

#include <vtkExodusIIReaderPrivate.h>

Inheritance diagram for vtkExodusIIReaderPrivate:

[legend]Collaboration diagram for vtkExodusIIReaderPrivate:

Detailed Description

This class holds metadata for an Exodus file.

Definition at line 28 of file vtkExodusIIReaderPrivate.h.

Public Types

typedef vtkObject Superclass

Scalar = 0

The array is a scalar.

Vector2 = 1

The array is a 2-D vector.

Vector3 = 2

The array is a 3-D vector.

SymmetricTensor = 3

The array is a symmetric tensor.

IntegrationPoint = 4

The array is a set of integration point values.

Result = 0

The array is composed of results variables.

Attribute = 1

The array is composed of attributes.

Map = 2

The array has a corresponding entry in MapInfo.

Generated = 3

The array is procedurally generated (e.g., BlockId).

enum GlomTypes {
Scalar = 0, Vector2 = 1, Vector3 = 2, SymmetricTensor = 3,
IntegrationPoint = 4
}

Tags to indicate how single-component Exodus arrays are glommed (aggregated) into multi-component VTK arrays. More...

enum ArraySourceTypes { Result = 0, Attribute = 1, Map = 2, Generated = 3 }

Tags to indicate the source of values for an array. More...

Public Member Functions

void PrintData (ostream &os, vtkIndent indent)

virtual const char * GetClassName ()

virtual int IsA (const char *type)

int OpenFile (const char *filename)

Open an ExodusII file for reading. Returns 0 on success.

int CloseFile ()

Close any ExodusII file currently open for reading. Returns 0 on success.

int RequestInformation ()

Get metadata for an open file with handle exoid.

vtkMutableDirectedGraph * GetSIL ()

Returns the SIL. This valid only after BuildSIL() has been called.

void Broadcast (vtkMultiProcessController *controller)

Send metadata to other processes in a parallel job.

void Receive (vtkMultiProcessController *controller)

Receive metadata from the rank 0 process in a parallel job.

int RequestData (vtkIdType timeStep, vtkMultiBlockDataSet *output)

Read requested data and store in unstructured grid.

int SetUpEmptyGrid (vtkMultiBlockDataSet *output)

void Reset ()

Reset the class so that another file may be read.

void ResetSettings ()

Return user-specified variables to their default values.

void ResetCache ()

Clears out any data in the cache and restores it to its initial state.

int GetNumberOfTimeSteps ()

Return the number of time steps in the open file.

virtual int GetTimeStep ()

Return the current time step.

virtual void SetTimeStep (int)

Set the current time step for subsequent calls to RequestData().

virtual int GetSqueezePoints ()

Return whether subsequent RequestData() calls will produce the minimal point set required to represent the output.

void SetSqueezePoints (int sp)

Set whether subsequent RequestData() calls will produce the minimal point set required to represent the output.

virtual void SqueezePointsOn ()

Convenience routines that for producing (or not) the minimal point set required to represent the output.

virtual void SqueezePointsOff ()

int GetNumberOfNodes ()

Return the number of nodes in the output (depends on SqueezePoints).

int GetNumberOfObjectsOfType (int otype)

Returns the number of objects of a given type (e.g., EX_ELEM_BLOCK, EX_NODE_SET, .

int GetNumberOfObjectArraysOfType (int otype)

Returns the number of arrays defined over objects of a given type (e.g., EX_ELEM_BLOCK, EX_NODE_SET, .

const char * GetObjectName (int otype, int i)

For a given object type, returns the name of the i-th object.

int GetObjectId (int otype, int i)

For a given object type, return the user-assigned ID of the i-th object.

int GetObjectSize (int otype, int i)

For a given object type, return the size of the i-th object.

int GetObjectStatus (int otype, int i)

For a given object type, returns the status of the i-th object.

int GetUnsortedObjectStatus (int otype, int i)

For a given object type, returns the status of the i-th object, where i is an index into the unsorted object array.

void SetObjectStatus (int otype, int i, int stat)

For a given object type, sets the status of the i-th object.

void SetUnsortedObjectStatus (int otype, int i, int stat)

For a given object type, sets the status of the i-th object, where i is an index into the *unsorted* object array.

const char * GetObjectArrayName (int otype, int i)

For a given object type, returns the name of the i-th array.

int GetNumberOfObjectArrayComponents (int otype, int i)

For a given object type, returns the number of components of the i-th array.

int GetObjectArrayStatus (int otype, int i)

For a given object type, returns the status of the i-th array.

void SetObjectArrayStatus (int otype, int i, int stat)

For a given object type, sets the status of the i-th array.

int GetNumberOfObjectAttributes (int objectType, int objectIndex)

Unlike object arrays, attributes are only defined over blocks (not sets) and are defined on a per-block (not a per-block-type) basis.

const char * GetObjectAttributeName (int objectType, int objectIndex, int attributeIndex)

int GetObjectAttributeIndex (int objectType, int objectIndex, const char *attribName)

int GetObjectAttributeStatus (int objectType, int objectIndex, int attribIndex)

void SetObjectAttributeStatus (int objectType, int objectIndex, int attribIndex, int status)

virtual int GetGenerateObjectIdArray ()

Generate an array containing the block or set ID associated with each cell.

virtual void SetGenerateObjectIdArray (int)

virtual void SetGenerateGlobalElementIdArray (int)

virtual int GetGenerateGlobalElementIdArray ()

virtual void SetGenerateGlobalNodeIdArray (int)

virtual int GetGenerateGlobalNodeIdArray ()

virtual void SetGenerateFileIdArray (int)

Should we generate an array defined over all cells (whether they are members of blocks or sets) indicating the source file?

virtual int GetGenerateFileIdArray ()

virtual void SetFileId (int)

Set/get the number that identifies this file in a series of files (defaults to 0).

virtual int GetFileId ()

virtual void SetApplyDisplacements (int d)

virtual int GetApplyDisplacements ()

virtual void SetDisplacementMagnitude (double s)

virtual double GetDisplacementMagnitude ()

virtual void SetHasModeShapes (int)

virtual int GetHasModeShapes ()

virtual void SetModeShapeTime (double)

virtual double GetModeShapeTime ()

vtkDataArray * FindDisplacementVectors (int timeStep)

virtual void SetEdgeFieldDecorations (int)

virtual int GetEdgeFieldDecorations ()

virtual void SetFaceFieldDecorations (int)

virtual int GetFaceFieldDecorations ()

ex_init_params * GetModelParams () const

virtual void SetParser (vtkExodusIIReaderParser *)

virtual vtkExodusIIReaderParser * GetParser ()

int GetNumberOfParts ()

const char * GetPartName (int idx)

const char * GetPartBlockInfo (int idx)

int GetPartStatus (int idx)

int GetPartStatus (vtkStdString name)

void SetPartStatus (int idx, int on)

void SetPartStatus (vtkStdString name, int flag)

int GetNumberOfMaterials ()

const char * GetMaterialName (int idx)

int GetMaterialStatus (int idx)

int GetMaterialStatus (vtkStdString name)

void SetMaterialStatus (int idx, int on)

void SetMaterialStatus (vtkStdString name, int flag)

int GetNumberOfAssemblies ()

const char * GetAssemblyName (int idx)

int GetAssemblyStatus (int idx)

int GetAssemblyStatus (vtkStdString name)

void SetAssemblyStatus (int idx, int on)

void SetAssemblyStatus (vtkStdString name, int flag)

void SetFastPathObjectType (vtkExodusIIReader::ObjectType type)

void SetFastPathObjectId (vtkIdType id)

virtual void SetFastPathIdType (const char *)

bool IsXMLMetadataValid ()

void GetInitialObjectStatus (int otype, ObjectInfoType *info)

For a given object type, looks for an object in the collection of initial objects of the same name, or if the name is empty, then of the same id as "info".

void GetInitialObjectArrayStatus (int otype, ArrayInfoType *info)

For a given array type, looks for an object in the collection of initial objects of the same name, or if the name is empty, then of the same id as "info".

void SetInitialObjectStatus (int otype, const char *name, int stat)

For a given object type, creates and stores an ObjectInfoType object using the given name and status.

void SetInitialObjectArrayStatus (int otype, const char *name, int stat)

For a given array type, creates and stores an ArrayInfoType object using the given name and status.

int UpdateTimeInformation ()

Static Public Member Functions

static vtkExodusIIReaderPrivate * New ()

static int IsTypeOf (const char *type)

static vtkExodusIIReaderPrivate * SafeDownCast (vtkObject *o)

static const char * GetObjectIdArrayName ()

static const char * GetGlobalElementIdArrayName ()

static const char * GetGlobalNodeIdArrayName ()

static const char * GetFileIdArrayName ()

static const char * GetGlobalVariableValuesArrayName ()

static const char * GetGlobalVariableNamesArrayName ()

Public Attributes

vtkTimeStamp InformationTimeStamp

Time stamp from last time we were in RequestInformation.

Protected Member Functions

vtkExodusIIReaderPrivate ()

~vtkExodusIIReaderPrivate ()

void BuildSIL ()

Build SIL. This must be called only after RequestInformation().

int VerifyIntegrationPointGlom (int nn, char **np, vtksys::RegularExpression &re, vtkStdString &field, vtkStdString &ele)

Returns true when order and text of names are consistent with integration points.

void GlomArrayNames (int i, int num_obj, int num_vars, char **var_names, int *truth_tab)

Aggregate Exodus array names into VTK arrays with multiple components.

void PrepareGeneratedArrayInfo ()

Add generated array information to array info lists.

int AssembleOutputConnectivity (vtkIdType timeStep, int otyp, int oidx, int conntypidx, BlockSetInfoType *bsinfop, vtkUnstructuredGrid *output)

Read connectivity information and populate an unstructured grid with cells corresponding to a single block or set.

int AssembleOutputPoints (vtkIdType timeStep, BlockSetInfoType *bsinfop, vtkUnstructuredGrid *output)

Fill the output grid's point coordinates array.

int AssembleOutputPointArrays (vtkIdType timeStep, BlockSetInfoType *bsinfop, vtkUnstructuredGrid *output)

Add the requested arrays to the output grid's point data.

int AssembleOutputCellArrays (vtkIdType timeStep, int otyp, int oidx, BlockSetInfoType *bsinfop, vtkUnstructuredGrid *output)

Add the requested arrays to the output grid's cell data.

int AssembleOutputProceduralArrays (vtkIdType timeStep, int otyp, int oidx, vtkUnstructuredGrid *output)

Add procedurally generated arrays to an output mesh.

int AssembleOutputGlobalArrays (vtkIdType timeStep, int otyp, int oidx, BlockSetInfoType *bsinfop, vtkUnstructuredGrid *output)

Add mesh-global field data such as QA records to the output mesh.

int AssembleOutputPointMaps (vtkIdType timeStep, BlockSetInfoType *bsinfop, vtkUnstructuredGrid *output)

Add maps to an output mesh.

int AssembleOutputCellMaps (vtkIdType timeStep, int otyp, int oidx, BlockSetInfoType *bsinfop, vtkUnstructuredGrid *output)

int AssembleArraysOverTime (vtkMultiBlockDataSet *output)

Add fast-path time-varying data to field data of an output block or set.

void AssembleOutputEdgeDecorations ()

void AssembleOutputFaceDecorations ()

void InsertBlockCells (int otyp, int obj, int conn_type, int timeStep, BlockInfoType *binfop)

Insert cells from a specified block into a mesh.

void InsertSetCells (int otyp, int obj, int conn_type, int timeStep, SetInfoType *sinfop)

Insert cells from a specified set into a mesh.

void AddPointArray (vtkDataArray *src, BlockSetInfoType *bsinfop, vtkUnstructuredGrid *output)

Add a point array to an output grid's point data, squeezing if necessary.

void InsertSetNodeCopies (vtkIntArray *refs, int otyp, int obj, SetInfoType *sinfo)

Insert cells referenced by a node set.

void InsertSetCellCopies (vtkIntArray *refs, int otyp, int obj, SetInfoType *sinfo)

Insert cells referenced by an edge, face, or element set.

void InsertSetSides (vtkIntArray *refs, int otyp, int obj, SetInfoType *sinfo)

Insert cells referenced by a side set.

vtkDataArray * GetCacheOrRead (vtkExodusIICacheKey)

Return an array for the specified cache key.

int GetConnTypeIndexFromConnType (int ctyp)

Return the index of an object type (in a private list of all object types).

int GetObjectTypeIndexFromObjectType (int otyp)

Return the index of an object type (in a private list of all object types).

int GetNumberOfObjectsAtTypeIndex (int typeIndex)

Return the number of objects of the given type.

ObjectInfoType * GetObjectInfo (int typeIndex, int objectIndex)

Return a pointer to the ObjectInfo of the specified type and index.

ObjectInfoType * GetSortedObjectInfo (int objectType, int objectIndex)

Return a pointer to the ObjectInfo of the specified type and index, but using indices sorted by object ID.

ObjectInfoType * GetUnsortedObjectInfo (int objectType, int objectIndex)

Return a pointer to the ObjectInfo of the specified type and index, but using indices sorted by object ID.

int GetBlockIndexFromFileGlobalId (int otyp, int refId)

Get the index of the block containing the entity referenced by the specified file-global ID.

BlockInfoType * GetBlockFromFileGlobalId (int otyp, int refId)

Get the block containing the entity referenced by the specified file-global ID.

vtkIdType GetSqueezePointId (BlockSetInfoType *bsinfop, int i)

Find or create a new SqueezePoint ID (unique sequential list of points referenced by cells in blocks/sets with Status == 1).

void DetermineVtkCellType (BlockInfoType &binfo)

Determine the VTK cell type for a given edge/face/element block.

ArrayInfoType * FindArrayInfoByName (int otyp, const char *name)

Find an ArrayInfo object for a specific object type using the name as a key.

int IsObjectTypeBlock (int otyp)

Does the specified object type match? Avoid using these.

int IsObjectTypeSet (int otyp)

int IsObjectTypeMap (int otyp)

int GetObjectTypeFromMapType (int mtyp)

Given a map type (NODE_MAP, EDGE_MAP, .

int GetMapTypeFromObjectType (int otyp)

int GetTemporalTypeFromObjectType (int otyp)

int GetSetTypeFromSetConnType (int sctyp)

Given a set connectivity type (NODE_SET_CONN, .

int GetBlockConnTypeFromBlockType (int btyp)

Given a block type (EDGE_BLOCK, .

void RemoveBeginningAndTrailingSpaces (int len, char **names)

Function to trim space from names retrieved with ex_get_var_names.

void ClearConnectivityCaches ()

Delete any cached connectivity information (for all blocks and sets).

Protected Attributes

vtkstd::map< int, vtkstd::vector<
BlockInfoType > > BlockInfo

Maps a block type (EX_ELEM_BLOCK, EX_FACE_BLOCK, .

vtkstd::map< int, vtkstd::vector<
SetInfoType > > SetInfo

Maps a set type (EX_ELEM_SET, .

vtkstd::map< int, vtkstd::vector<
MapInfoType > > MapInfo

Maps a map type (EX_ELEM_MAP, .

vtkstd::vector< PartInfoType > PartInfo

vtkstd::vector< MaterialInfoType > MaterialInfo

vtkstd::vector< AssemblyInfoType > AssemblyInfo

vtkstd::map< int, vtkstd::vector<
int > > SortedObjectIndices

Maps an object type to vector of indices that reorder objects of that type by their IDs.

vtkstd::map< int, vtkstd::vector<
ArrayInfoType > > ArrayInfo

Maps an object type (EX_ELEM_BLOCK, EX_NODE_SET, ...) to a list of arrays.

vtkstd::map< int, vtkstd::vector<
ArrayInfoType > > InitialArrayInfo

Maps an object type (EX_ELEM_BLOCK, EX_NODE_SET, .

vtkstd::map< int, vtkstd::vector<
ObjectInfoType > > InitialObjectInfo

Maps an object type (EX_ELEM_BLOCK, EX_NODE_SET, .

int AppWordSize

These aren't the variables you're looking for.

int DiskWordSize

float ExodusVersion

The version of Exodus that wrote the currently open file (or a negative number otherwise).

int Exoid

The handle of the currently open file.

ex_init_params ModelParameters

Parameters describing the currently open Exodus file.

vtkstd::vector< double > Times

A list of time steps for which results variables are stored.

int TimeStep

The current time step.

double ModeShapeTime

The time value.

int GenerateObjectIdArray

int GenerateGlobalIdArray

int GenerateFileIdArray

int GenerateGlobalElementIdArray

int GenerateGlobalNodeIdArray

int FileId

Defaults to 0.

vtkExodusIICache * Cache

A least-recently-used cache to hold raw arrays.

int ApplyDisplacements

float DisplacementMagnitude

int HasModeShapes

int EdgeFieldDecorations

int FaceFieldDecorations

vtkPolyData * EdgeDecorationMesh

vtkPolyData * FaceDecorationMesh

int SqueezePoints

Should the reader output only points used by elements in the output mesh, or all the points.

vtkExodusIIReader * Parent

Pointer to owning reader.

vtkExodusIIReaderParser * Parser

vtkExodusIIReader::ObjectType FastPathObjectType

vtkIdType FastPathObjectId

char * FastPathIdType

vtkMutableDirectedGraph * SIL

Friends

class vtkExodusIIReader

Classes

struct ArrayInfoType

A struct to hold information about time-varying arrays. More...

struct AssemblyInfoType

struct BlockInfoType

A struct to hold information about Exodus blocks. More...

struct BlockSetInfoType

A struct to hold information about Exodus blocks or sets (they have some members in common). More...

struct MapInfoType

A struct to hold information about Exodus maps. More...

struct MaterialInfoType

struct ObjectInfoType

A struct to hold information about Exodus objects (blocks, sets, maps). More...

struct PartInfoType

A struct to hold information about Exodus blocks. More...

struct SetInfoType

A struct to hold information about Exodus sets. More...

Member Typedef Documentation

typedef vtkObject vtkExodusIIReaderPrivate::Superclass

Reimplemented from vtkObject.

Definition at line 33 of file vtkExodusIIReaderPrivate.h.

Member Enumeration Documentation

enum vtkExodusIIReaderPrivate::GlomTypes

Tags to indicate how single-component Exodus arrays are glommed (aggregated) into multi-component VTK arrays.

Enumerator:

Scalar	The array is a scalar.
Vector2	The array is a 2-D vector.
Vector3	The array is a 3-D vector.
SymmetricTensor	The array is a symmetric tensor.
IntegrationPoint	The array is a set of integration point values.

Definition at line 388 of file vtkExodusIIReaderPrivate.h.

enum vtkExodusIIReaderPrivate::ArraySourceTypes

Tags to indicate the source of values for an array.

Enumerator:

Result	The array is composed of results variables.
Attribute	The array is composed of attributes.
Map	The array has a corresponding entry in MapInfo.
Generated	The array is procedurally generated (e.g., BlockId).

Definition at line 398 of file vtkExodusIIReaderPrivate.h.

Constructor & Destructor Documentation

vtkExodusIIReaderPrivate::vtkExodusIIReaderPrivate ( ) [protected]

vtkExodusIIReaderPrivate::~vtkExodusIIReaderPrivate ( ) [protected]

Member Function Documentation

static vtkExodusIIReaderPrivate* vtkExodusIIReaderPrivate::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

void vtkExodusIIReaderPrivate::PrintData	(	ostream &	os,
		vtkIndent	indent
	)

virtual const char* vtkExodusIIReaderPrivate::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

static int vtkExodusIIReaderPrivate::IsTypeOf ( const char * type ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkExodusIIReaderPrivate::IsA ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkExodusIIReaderPrivate* vtkExodusIIReaderPrivate::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.

int vtkExodusIIReaderPrivate::OpenFile ( const char * filename )

Open an ExodusII file for reading. Returns 0 on success.

int vtkExodusIIReaderPrivate::CloseFile ( )

Close any ExodusII file currently open for reading. Returns 0 on success.

int vtkExodusIIReaderPrivate::RequestInformation ( )

Get metadata for an open file with handle exoid.

vtkMutableDirectedGraph* vtkExodusIIReaderPrivate::GetSIL ( ) [inline]

Returns the SIL. This valid only after BuildSIL() has been called.

Definition at line 46 of file vtkExodusIIReaderPrivate.h.

References SIL.

void vtkExodusIIReaderPrivate::Broadcast ( vtkMultiProcessController * controller )

Send metadata to other processes in a parallel job.

void vtkExodusIIReaderPrivate::Receive ( vtkMultiProcessController * controller )

Receive metadata from the rank 0 process in a parallel job.

int vtkExodusIIReaderPrivate::RequestData	(	vtkIdType	timeStep,
		vtkMultiBlockDataSet *	output
	)

Read requested data and store in unstructured grid.

int vtkExodusIIReaderPrivate::SetUpEmptyGrid ( vtkMultiBlockDataSet * output )

void vtkExodusIIReaderPrivate::Reset ( )

Reset the class so that another file may be read.

This does not change any user-specified parameters, such as which generated arrays should be present, whether there are mode shapes or time steps, etc. Note that which arrays should be loaded is a more delicate issue; if you set these after RequestInformation has been called, these will not be saved. Any settings you make before RequestInformation is called will be saved because they are stored in InitialArrayInfo and InitialObjectInfo.

void vtkExodusIIReaderPrivate::ResetSettings ( )

Return user-specified variables to their default values.

Calling ResetSettings() and then Reset() will return the class to a state just like it was after New() was called.

void vtkExodusIIReaderPrivate::ResetCache ( )

Clears out any data in the cache and restores it to its initial state.

int vtkExodusIIReaderPrivate::GetNumberOfTimeSteps ( ) [inline]

Return the number of time steps in the open file.

You must have called RequestInformation() before invoking this member function.

Definition at line 89 of file vtkExodusIIReaderPrivate.h.

References Times.

virtual int vtkExodusIIReaderPrivate::GetTimeStep ( ) [virtual]

Return the current time step.

virtual void vtkExodusIIReaderPrivate::SetTimeStep ( int ) [virtual]

Set the current time step for subsequent calls to RequestData().

virtual int vtkExodusIIReaderPrivate::GetSqueezePoints ( ) [virtual]

Return whether subsequent RequestData() calls will produce the minimal point set required to represent the output.

void vtkExodusIIReaderPrivate::SetSqueezePoints ( int sp )

Set whether subsequent RequestData() calls will produce the minimal point set required to represent the output.

virtual void vtkExodusIIReaderPrivate::SqueezePointsOn ( ) [virtual]

Convenience routines that for producing (or not) the minimal point set required to represent the output.

virtual void vtkExodusIIReaderPrivate::SqueezePointsOff ( ) [virtual]

int vtkExodusIIReaderPrivate::GetNumberOfNodes ( )

Return the number of nodes in the output (depends on SqueezePoints).

int vtkExodusIIReaderPrivate::GetNumberOfObjectsOfType ( int otype )

Returns the number of objects of a given type (e.g., EX_ELEM_BLOCK, EX_NODE_SET, .

..). You must have called RequestInformation before invoking this member function.

int vtkExodusIIReaderPrivate::GetNumberOfObjectArraysOfType ( int otype )

Returns the number of arrays defined over objects of a given type (e.g., EX_ELEM_BLOCK, EX_NODE_SET, .

..). You must have called RequestInformation before invoking this member function.

N.B.: This method will eventually disappear. Really, what we should be providing is an interface to query the arrays defined on a particular object, not a class of objects. However, until the reader outputs multiblock datasets, we can't be that specific.

const char* vtkExodusIIReaderPrivate::GetObjectName	(	int	otype,
		int	i
	)

For a given object type, returns the name of the i-th object.