vtkExodusModel Class Reference

#include <vtkExodusModel.h>

Inheritance diagram for vtkExodusModel:

Inheritance graph
Collaboration diagram for vtkExodusModel:

Collaboration graph

List of all members.

Detailed Description

Exodus Model.

A vtkUnstructuredGrid output by vtkExodusReader or vtkPExodusReader is missing a great deal of initialization and static model data that is in an Exodus II file. (Global variables, properties, node sets, side sets, and so on.) This data can be stored in a vtkModelMetadata object, which can be initialized using this vtkExodusModel class.

This class can be initialized with a file handle for an open Exodus file, and the vtkUnstructuredGrid derived from that file. The methods used would be SetGlobalInformation, SetLocalInformation, AddUGridElementVariable and AddUGridNodeVariable. The vtkExodusReader does this.

It can also be initialized (using UnpackExodusModel) from a vtkUnstructuredGrid that has had metadata packed into it's field arrays with PackExodusModel. The vtkExodusIIWriter does this.

If you plan to write out the Exodus file (with vtkExodusIIWriter), you should direct the Exodus reader to create a vtkExodusModel object. This will be used by the Exodus writer to create a correct Exodus II file on output. In addition, the vtkDistributedDataFilter is cognizant of the ExodusModel object and will unpack, extract, merge, and pack these objects associated with the grids it is partitioning.

See also:
vtkExodusReader vtkPExodusReader vtkExodusIIWriter vtkModelMetadata vtkDistributedDataFilter

Definition at line 65 of file vtkExodusModel.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
int SetGlobalInformation (int fid, int compute_word_size)
int AddUGridElementVariable (char *ugridVarName, char *origName, int numComponents)
int RemoveUGridElementVariable (char *ugridVarName)
int AddUGridNodeVariable (char *ugridVarName, char *origName, int numComponents)
int RemoveUGridNodeVariable (char *ugridVarName)
void SetElementVariableInfo (int numOrigNames, char **origNames, int numNames, char **names, int *numComp, int *map)
void SetNodeVariableInfo (int numOrigNames, char **origNames, int numNames, char **names, int *numComp, int *map)
int SetLocalInformation (vtkUnstructuredGrid *ugrid, int fid, int timeStep, int newGeometry, int compute_word_size)
vtkModelMetadataGetModelMetadata ()
void SetModelMetadata (vtkModelMetadata *emData)
int UnpackExodusModel (vtkUnstructuredGrid *grid, int deleteIt)
int MergeExodusModel (vtkExodusModel *em)
vtkExodusModelExtractExodusModel (vtkIdTypeArray *globalCellIdList, vtkUnstructuredGrid *grid)
void PackExodusModel (vtkUnstructuredGrid *grid)
void Reset ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkExodusModelSafeDownCast (vtkObject *o)
static vtkExodusModelNew ()
static int HasMetadata (vtkUnstructuredGrid *grid)

Protected Member Functions

 vtkExodusModel ()
 ~vtkExodusModel ()

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 68 of file vtkExodusModel.h.

Constructor & Destructor Documentation

vtkExodusModel::vtkExodusModel (  )  [protected]

vtkExodusModel::~vtkExodusModel (  )  [protected]

Member Function Documentation

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

Reimplemented from vtkObject.

static int vtkExodusModel::IsTypeOf ( const char *  name  )  [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 vtkExodusModel::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

virtual void vtkExodusModel::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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

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

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

Reimplemented from vtkObject.

int vtkExodusModel::SetGlobalInformation ( int  fid,
int  compute_word_size 

In order to write a correct Exodus file from a vtkUnstructuredGrid, we need to know the global data which does not get represented in the UGrid. Initialize, with an open Exodus file, all the global fields of the ExodusModel object. fid is the file handle of the opened Exodus file. compute_word_size is the size of floating point values exchanged with the the Exodus library. (It's set in ex_open or ex_create.) The global fields are those which don't depend on which cells or field arrays are being read from the file.

int vtkExodusModel::AddUGridElementVariable ( char *  ugridVarName,
char *  origName,
int  numComponents 

In order to write Exodus files from vtkUnstructuredGrid objects that were read from Exodus files, we need to know the mapping from variable names in the UGrid to variable names in the Exodus file. (The Exodus reader combines scalar variables with similar names into vectors in the UGrid.) When building the UGrid to which this ExodusModel refers, add each element and node variable name with this call, including the name of original variable that yielded it's first component, and the number of components. If a variable is removed from the UGrid, remove it from the ExodusModel. (If this information is missing or incomplete, the ExodusIIWriter can still do something sensible in creating names for variables.)

int vtkExodusModel::RemoveUGridElementVariable ( char *  ugridVarName  ) 

int vtkExodusModel::AddUGridNodeVariable ( char *  ugridVarName,
char *  origName,
int  numComponents 

int vtkExodusModel::RemoveUGridNodeVariable ( char *  ugridVarName  ) 

void vtkExodusModel::SetElementVariableInfo ( int  numOrigNames,
char **  origNames,
int  numNames,
char **  names,
int *  numComp,
int *  map 

void vtkExodusModel::SetNodeVariableInfo ( int  numOrigNames,
char **  origNames,
int  numNames,
char **  names,
int *  numComp,
int *  map 

int vtkExodusModel::SetLocalInformation ( vtkUnstructuredGrid ugrid,
int  fid,
int  timeStep,
int  newGeometry,
int  compute_word_size 

Set the local information in the ExodusModel. This is information which depends on which blocks were read in, and which time step was read in. (Example - count of cells in each block, values of global variables, node IDs for nodes in each node set.) Provide the ugrid, the time step (the first time step is 0), the handle of an open Exodus file, and the size of floating point values exchanged with the Exodus library. Also indicate with a 1 if the geometry has changed (new blocks or blocks removed) since the last call. (When in doubt set to 1.) Please call SetGlobalInformation once before calling SetLocalInformation. SetLocalInformation may be called many times if different subsets of an Exodus file are read. Each call replaces the previous local values.

static int vtkExodusModel::HasMetadata ( vtkUnstructuredGrid grid  )  [static]

Static function that returns 1 if the vtkUnstructuredGrid has metadata packed into it's field arrays, 0 otherwise.

vtkModelMetadata* vtkExodusModel::GetModelMetadata (  ) 

Set or get the underlying vtkModelMetadata object.

void vtkExodusModel::SetModelMetadata ( vtkModelMetadata emData  ) 

int vtkExodusModel::UnpackExodusModel ( vtkUnstructuredGrid grid,
int  deleteIt 

One way to initialize an ExodusModel object is to use SetGlobalInformation, SetLocalInformation, and the Add/Remove Variable calls to initialize it from an open Exodus file. Another way is to initialize it with the ExodusModel which has been packed into field arrays of a vtkUnstructuredGrid. Set the second argument to 1 if you would like the packed field arrays to be deleted after this ExodusModel is initialized. Returns 1 if there is no ExodusModel object associated with the grid, 0 otherwise.

int vtkExodusModel::MergeExodusModel ( vtkExodusModel em  ) 

Merge the supplied vtkExodusModel object into this one. It is assumed the two objects represent portions of the same distributed data set. (So the list of block IDs is the same, and so on.)

vtkExodusModel* vtkExodusModel::ExtractExodusModel ( vtkIdTypeArray globalCellIdList,
vtkUnstructuredGrid grid 

Create a new vtkExodusModel object representing a subset of the cells of this vtkExodusModel object. We need a list of the global IDs of the cells to be extracted, the grid which generated the Exodus Model (so we can find the points associated with each cell), and the name of the grid's global cell ID array, and the name of the grid's global node ID array.

void vtkExodusModel::PackExodusModel ( vtkUnstructuredGrid grid  ) 

The metadata encapsulated in a vtkExodusModel object can be written to field arrays which are then stored in the vtkUnstructuredGrid itself. PackExodusModel creates these field arrays and attaches them to the supplied grid.

void vtkExodusModel::Reset (  ) 

Reset all fields to their initial value.

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

Generated on Wed Jun 3 19:02:03 2009 for VTK by  doxygen 1.5.6