ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkExodusModel Class Reference

vtkExodusModel - Exodus Model More...

Inheritance diagram for Kitware.VTK.vtkExodusModel:
[legend]
Collaboration diagram for Kitware.VTK.vtkExodusModel:
[legend]

List of all members.

Public Member Functions

 vtkExodusModel (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkExodusModel ()
 Undocumented Block.
int AddUGridElementVariable (string ugridVarName, string 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 AddUGridNodeVariable (string ugridVarName, string 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.)
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.
vtkModelMetadata GetModelMetadata ()
 Set or get the underlying vtkModelMetadata object.
override int IsA (string type)
 Undocumented Block.
int 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.)
new vtkExodusModel NewInstance ()
 Undocumented Block.
void 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.
int RemoveUGridElementVariable (string ugridVarName)
 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 RemoveUGridNodeVariable (string ugridVarName)
 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.)
void Reset ()
 Reset all fields to their initial value.
int 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 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.
void SetModelMetadata (vtkModelMetadata emData)
 Set or get the underlying vtkModelMetadata object.
int 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.

Static Public Member Functions

static new vtkExodusModel New ()
 Undocumented Block.
static int HasMetadata (vtkUnstructuredGrid grid)
 Static function that returns 1 if the vtkUnstructuredGrid has metadata packed into it's field arrays, 0 otherwise.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkExodusModel SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkExodusModel"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "14vtkExodusModel"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkExodusModel_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkExodusModel_AddUGridElementVariable_01 (HandleRef pThis, string ugridVarName, string origName, int numComponents)
static internal int vtkExodusModel_AddUGridNodeVariable_02 (HandleRef pThis, string ugridVarName, string origName, int numComponents)
static internal IntPtr vtkExodusModel_ExtractExodusModel_03 (HandleRef pThis, HandleRef globalCellIdList, HandleRef grid, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkExodusModel_GetModelMetadata_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkExodusModel_HasMetadata_05 (HandleRef grid)
static internal int vtkExodusModel_IsA_06 (HandleRef pThis, string type)
static internal int vtkExodusModel_IsTypeOf_07 (string type)
static internal int vtkExodusModel_MergeExodusModel_08 (HandleRef pThis, HandleRef em)
static internal IntPtr vtkExodusModel_NewInstance_10 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkExodusModel_PackExodusModel_11 (HandleRef pThis, HandleRef grid)
static internal int vtkExodusModel_RemoveUGridElementVariable_12 (HandleRef pThis, string ugridVarName)
static internal int vtkExodusModel_RemoveUGridNodeVariable_13 (HandleRef pThis, string ugridVarName)
static internal void vtkExodusModel_Reset_14 (HandleRef pThis)
static internal IntPtr vtkExodusModel_SafeDownCast_15 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkExodusModel_SetGlobalInformation_16 (HandleRef pThis, int fid, int compute_word_size)
static internal int vtkExodusModel_SetLocalInformation_17 (HandleRef pThis, HandleRef ugrid, int fid, int timeStep, int newGeometry, int compute_word_size)
static internal void vtkExodusModel_SetModelMetadata_18 (HandleRef pThis, HandleRef emData)
static internal int vtkExodusModel_UnpackExodusModel_19 (HandleRef pThis, HandleRef grid, int deleteIt)

Static Private Member Functions

static vtkExodusModel ()
 Automatically generated type registration mechanics.

Detailed Description

vtkExodusModel - Exodus Model

Description

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.

vtkExodusReader vtkPExodusReader vtkExodusIIWriter vtkModelMetadata vtkDistributedDataFilter


Constructor & Destructor Documentation

static Kitware.VTK.vtkExodusModel.vtkExodusModel ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkExodusModel.vtkExodusModel ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

int Kitware.VTK.vtkExodusModel.AddUGridElementVariable ( string  ugridVarName,
string  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 Kitware.VTK.vtkExodusModel.AddUGridNodeVariable ( string  ugridVarName,
string  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.)

override void Kitware.VTK.vtkExodusModel.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

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.

Here is the call graph for this function:

Set or get the underlying vtkModelMetadata object.

Here is the call graph for this function:

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

override int Kitware.VTK.vtkExodusModel.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static new int Kitware.VTK.vtkExodusModel.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

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.

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

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

Reset all fields to their initial value.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

int Kitware.VTK.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 Kitware.VTK.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.

Set or get the underlying vtkModelMetadata object.

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.

static internal int Kitware.VTK.vtkExodusModel.vtkExodusModel_AddUGridElementVariable_01 ( HandleRef  pThis,
string  ugridVarName,
string  origName,
int  numComponents 
) [private]
static internal int Kitware.VTK.vtkExodusModel.vtkExodusModel_AddUGridNodeVariable_02 ( HandleRef  pThis,
string  ugridVarName,
string  origName,
int  numComponents 
) [private]
static internal IntPtr Kitware.VTK.vtkExodusModel.vtkExodusModel_ExtractExodusModel_03 ( HandleRef  pThis,
HandleRef  globalCellIdList,
HandleRef  grid,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkExodusModel.vtkExodusModel_GetModelMetadata_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkExodusModel.vtkExodusModel_HasMetadata_05 ( HandleRef  grid) [private]
static internal int Kitware.VTK.vtkExodusModel.vtkExodusModel_IsA_06 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkExodusModel.vtkExodusModel_IsTypeOf_07 ( string  type) [private]
static internal int Kitware.VTK.vtkExodusModel.vtkExodusModel_MergeExodusModel_08 ( HandleRef  pThis,
HandleRef  em 
) [private]
static internal IntPtr Kitware.VTK.vtkExodusModel.vtkExodusModel_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkExodusModel.vtkExodusModel_NewInstance_10 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkExodusModel.vtkExodusModel_PackExodusModel_11 ( HandleRef  pThis,
HandleRef  grid 
) [private]
static internal int Kitware.VTK.vtkExodusModel.vtkExodusModel_RemoveUGridElementVariable_12 ( HandleRef  pThis,
string  ugridVarName 
) [private]
static internal int Kitware.VTK.vtkExodusModel.vtkExodusModel_RemoveUGridNodeVariable_13 ( HandleRef  pThis,
string  ugridVarName 
) [private]
static internal void Kitware.VTK.vtkExodusModel.vtkExodusModel_Reset_14 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkExodusModel.vtkExodusModel_SafeDownCast_15 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkExodusModel.vtkExodusModel_SetGlobalInformation_16 ( HandleRef  pThis,
int  fid,
int  compute_word_size 
) [private]
static internal int Kitware.VTK.vtkExodusModel.vtkExodusModel_SetLocalInformation_17 ( HandleRef  pThis,
HandleRef  ugrid,
int  fid,
int  timeStep,
int  newGeometry,
int  compute_word_size 
) [private]
static internal void Kitware.VTK.vtkExodusModel.vtkExodusModel_SetModelMetadata_18 ( HandleRef  pThis,
HandleRef  emData 
) [private]
static internal int Kitware.VTK.vtkExodusModel.vtkExodusModel_UnpackExodusModel_19 ( HandleRef  pThis,
HandleRef  grid,
int  deleteIt 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkExodusModel.MRClassNameKey = "14vtkExodusModel" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkExodusModel.MRFullTypeName = "Kitware.VTK.vtkExodusModel"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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