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.vtkExodusIIWriter Class Reference

vtkExodusIIWriter - Write Exodus II files More...

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

List of all members.

Public Member Functions

 vtkExodusIIWriter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkExodusIIWriter ()
 Undocumented Block.
virtual string GetBlockIdArrayName ()
 When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.
virtual string GetFileName ()
 Name for the output file. If writing in parallel, the number of processes and the process rank will be appended to the name, so each process is writing out a separate file. If not set, this class will make up a file name.
virtual int GetGhostLevel ()
 We never write out ghost cells. This variable is here to satisfy the behavior of ParaView on invoking a parallel writer.
virtual vtkModelMetadata GetModelMetadata ()
 Specify the vtkModelMetadata object which contains the Exodus file model information (metadata) absent in the vtkUnstructuredGrid. If you have this object, you don't need to set any other values before writing. (Just the FileName and the Input.) Note that the vtkExodusReader can create and attach a vtkModelMetadata object to it's output. If this has happened, the ExodusIIWriter will find it and use it.
virtual int GetStoreDoubles ()
 If StoreDoubles is ON, the floating point fields in the Exodus file will be double precision fields. The default is determined by the max precision of the input. If the field data appears to be doubles, then StoreDoubles will be ON, otherwise StoreDoubles will be OFF.
virtual int GetWriteAllTimeSteps ()
 When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.
virtual int GetWriteOutBlockIdArray ()
 By default, the integer array containing the global Block Ids of the cells is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutBlockIdArray to ON.
virtual int GetWriteOutGlobalElementIdArray ()
 By default, the integer array containing the global Element Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalElementIdArray to ON.
virtual int GetWriteOutGlobalNodeIdArray ()
 By default, the integer array containing the global Node Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalNodeIdArray to ON.
override int IsA (string type)
 Undocumented Block.
new vtkExodusIIWriter NewInstance ()
 Undocumented Block.
virtual void SetBlockIdArrayName (string _arg)
 When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.
virtual void SetFileName (string _arg)
 Name for the output file. If writing in parallel, the number of processes and the process rank will be appended to the name, so each process is writing out a separate file. If not set, this class will make up a file name.
virtual void SetGhostLevel (int _arg)
 We never write out ghost cells. This variable is here to satisfy the behavior of ParaView on invoking a parallel writer.
void SetModelMetadata (vtkModelMetadata arg0)
 Specify the vtkModelMetadata object which contains the Exodus file model information (metadata) absent in the vtkUnstructuredGrid. If you have this object, you don't need to set any other values before writing. (Just the FileName and the Input.) Note that the vtkExodusReader can create and attach a vtkModelMetadata object to it's output. If this has happened, the ExodusIIWriter will find it and use it.
virtual void SetStoreDoubles (int _arg)
 If StoreDoubles is ON, the floating point fields in the Exodus file will be double precision fields. The default is determined by the max precision of the input. If the field data appears to be doubles, then StoreDoubles will be ON, otherwise StoreDoubles will be OFF.
virtual void SetWriteAllTimeSteps (int _arg)
 When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.
virtual void SetWriteOutBlockIdArray (int _arg)
 By default, the integer array containing the global Block Ids of the cells is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutBlockIdArray to ON.
virtual void SetWriteOutGlobalElementIdArray (int _arg)
 By default, the integer array containing the global Element Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalElementIdArray to ON.
virtual void SetWriteOutGlobalNodeIdArray (int _arg)
 By default, the integer array containing the global Node Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalNodeIdArray to ON.
virtual void WriteAllTimeStepsOff ()
 When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.
virtual void WriteAllTimeStepsOn ()
 When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.
virtual void WriteOutBlockIdArrayOff ()
 By default, the integer array containing the global Block Ids of the cells is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutBlockIdArray to ON.
virtual void WriteOutBlockIdArrayOn ()
 By default, the integer array containing the global Block Ids of the cells is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutBlockIdArray to ON.
virtual void WriteOutGlobalElementIdArrayOff ()
 By default, the integer array containing the global Element Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalElementIdArray to ON.
virtual void WriteOutGlobalElementIdArrayOn ()
 By default, the integer array containing the global Element Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalElementIdArray to ON.
virtual void WriteOutGlobalNodeIdArrayOff ()
 By default, the integer array containing the global Node Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalNodeIdArray to ON.
virtual void WriteOutGlobalNodeIdArrayOn ()
 By default, the integer array containing the global Node Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalNodeIdArray to ON.

Static Public Member Functions

static new vtkExodusIIWriter New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkExodusIIWriter SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkExodusIIWriter"
 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 vtkExodusIIWriter_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkExodusIIWriter_GetBlockIdArrayName_01 (HandleRef pThis)
static internal IntPtr vtkExodusIIWriter_GetFileName_02 (HandleRef pThis)
static internal int vtkExodusIIWriter_GetGhostLevel_03 (HandleRef pThis)
static internal IntPtr vtkExodusIIWriter_GetModelMetadata_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkExodusIIWriter_GetStoreDoubles_05 (HandleRef pThis)
static internal int vtkExodusIIWriter_GetWriteAllTimeSteps_06 (HandleRef pThis)
static internal int vtkExodusIIWriter_GetWriteOutBlockIdArray_07 (HandleRef pThis)
static internal int vtkExodusIIWriter_GetWriteOutGlobalElementIdArray_08 (HandleRef pThis)
static internal int vtkExodusIIWriter_GetWriteOutGlobalNodeIdArray_09 (HandleRef pThis)
static internal int vtkExodusIIWriter_IsA_10 (HandleRef pThis, string type)
static internal int vtkExodusIIWriter_IsTypeOf_11 (string type)
static internal IntPtr vtkExodusIIWriter_NewInstance_13 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkExodusIIWriter_SafeDownCast_14 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkExodusIIWriter_SetBlockIdArrayName_15 (HandleRef pThis, string _arg)
static internal void vtkExodusIIWriter_SetFileName_16 (HandleRef pThis, string _arg)
static internal void vtkExodusIIWriter_SetGhostLevel_17 (HandleRef pThis, int _arg)
static internal void vtkExodusIIWriter_SetModelMetadata_18 (HandleRef pThis, HandleRef arg0)
static internal void vtkExodusIIWriter_SetStoreDoubles_19 (HandleRef pThis, int _arg)
static internal void vtkExodusIIWriter_SetWriteAllTimeSteps_20 (HandleRef pThis, int _arg)
static internal void vtkExodusIIWriter_SetWriteOutBlockIdArray_21 (HandleRef pThis, int _arg)
static internal void vtkExodusIIWriter_SetWriteOutGlobalElementIdArray_22 (HandleRef pThis, int _arg)
static internal void vtkExodusIIWriter_SetWriteOutGlobalNodeIdArray_23 (HandleRef pThis, int _arg)
static internal void vtkExodusIIWriter_WriteAllTimeStepsOff_24 (HandleRef pThis)
static internal void vtkExodusIIWriter_WriteAllTimeStepsOn_25 (HandleRef pThis)
static internal void vtkExodusIIWriter_WriteOutBlockIdArrayOff_26 (HandleRef pThis)
static internal void vtkExodusIIWriter_WriteOutBlockIdArrayOn_27 (HandleRef pThis)
static internal void vtkExodusIIWriter_WriteOutGlobalElementIdArrayOff_28 (HandleRef pThis)
static internal void vtkExodusIIWriter_WriteOutGlobalElementIdArrayOn_29 (HandleRef pThis)
static internal void vtkExodusIIWriter_WriteOutGlobalNodeIdArrayOff_30 (HandleRef pThis)
static internal void vtkExodusIIWriter_WriteOutGlobalNodeIdArrayOn_31 (HandleRef pThis)

Static Private Member Functions

static vtkExodusIIWriter ()
 Automatically generated type registration mechanics.

Detailed Description

vtkExodusIIWriter - Write Exodus II files

Description This is a vtkWriter that writes it's vtkUnstructuredGrid input out to an Exodus II file. Go to http://endo.sandia.gov/SEACAS/ for more information about the Exodus II format.

Exodus files contain much information that is not captured in a vtkUnstructuredGrid, such as time steps, information lines, node sets, and side sets. This information can be stored in a vtkModelMetadata object.

The vtkExodusReader and vtkPExodusReader can create a vtkModelMetadata object and embed it in a vtkUnstructuredGrid in a series of field arrays. This writer searches for these field arrays and will use the metadata contained in them when creating the new Exodus II file.

You can also explicitly give the vtkExodusIIWriter a vtkModelMetadata object to use when writing the file.

In the absence of the information provided by vtkModelMetadata, if this writer is not part of a parallel application, we will use reasonable defaults for all the values in the output Exodus file. If you don't provide a block ID element array, we'll create a block for each cell type that appears in the unstructured grid.

However if this writer is part of a parallel application (hence writing out a distributed Exodus file), then we need at the very least a list of all the block IDs that appear in the file. And we need the element array of block IDs for the input unstructured grid.

In the absense of a vtkModelMetadata object, you can also provide time step information which we will include in the output Exodus file.

Caveats If the input floating point field arrays and point locations are all floats or all doubles, this class will operate more efficiently. Mixing floats and doubles will slow you down, because Exodus II requires that we write only floats or only doubles.

We use the terms "point" and "node" interchangeably. Also, we use the terms "element" and "cell" interchangeably.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkExodusIIWriter.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.vtkWriter.

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

virtual string Kitware.VTK.vtkExodusIIWriter.GetFileName ( ) [virtual]

Name for the output file. If writing in parallel, the number of processes and the process rank will be appended to the name, so each process is writing out a separate file. If not set, this class will make up a file name.

We never write out ghost cells. This variable is here to satisfy the behavior of ParaView on invoking a parallel writer.

Specify the vtkModelMetadata object which contains the Exodus file model information (metadata) absent in the vtkUnstructuredGrid. If you have this object, you don't need to set any other values before writing. (Just the FileName and the Input.) Note that the vtkExodusReader can create and attach a vtkModelMetadata object to it's output. If this has happened, the ExodusIIWriter will find it and use it.

Here is the call graph for this function:

If StoreDoubles is ON, the floating point fields in the Exodus file will be double precision fields. The default is determined by the max precision of the input. If the field data appears to be doubles, then StoreDoubles will be ON, otherwise StoreDoubles will be OFF.

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

By default, the integer array containing the global Block Ids of the cells is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutBlockIdArray to ON.

By default, the integer array containing the global Element Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalElementIdArray to ON.

By default, the integer array containing the global Node Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalNodeIdArray to ON.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkWriter.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkWriter.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkWriter.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkWriter.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkExodusIIWriter.SetBlockIdArrayName ( string  _arg) [virtual]

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

virtual void Kitware.VTK.vtkExodusIIWriter.SetFileName ( string  _arg) [virtual]

Name for the output file. If writing in parallel, the number of processes and the process rank will be appended to the name, so each process is writing out a separate file. If not set, this class will make up a file name.

virtual void Kitware.VTK.vtkExodusIIWriter.SetGhostLevel ( int  _arg) [virtual]

We never write out ghost cells. This variable is here to satisfy the behavior of ParaView on invoking a parallel writer.

Specify the vtkModelMetadata object which contains the Exodus file model information (metadata) absent in the vtkUnstructuredGrid. If you have this object, you don't need to set any other values before writing. (Just the FileName and the Input.) Note that the vtkExodusReader can create and attach a vtkModelMetadata object to it's output. If this has happened, the ExodusIIWriter will find it and use it.

virtual void Kitware.VTK.vtkExodusIIWriter.SetStoreDoubles ( int  _arg) [virtual]

If StoreDoubles is ON, the floating point fields in the Exodus file will be double precision fields. The default is determined by the max precision of the input. If the field data appears to be doubles, then StoreDoubles will be ON, otherwise StoreDoubles will be OFF.

virtual void Kitware.VTK.vtkExodusIIWriter.SetWriteAllTimeSteps ( int  _arg) [virtual]

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

virtual void Kitware.VTK.vtkExodusIIWriter.SetWriteOutBlockIdArray ( int  _arg) [virtual]

By default, the integer array containing the global Block Ids of the cells is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutBlockIdArray to ON.

By default, the integer array containing the global Element Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalElementIdArray to ON.

virtual void Kitware.VTK.vtkExodusIIWriter.SetWriteOutGlobalNodeIdArray ( int  _arg) [virtual]

By default, the integer array containing the global Node Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalNodeIdArray to ON.

static internal IntPtr Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_GetBlockIdArrayName_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_GetFileName_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_GetGhostLevel_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_GetModelMetadata_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_GetStoreDoubles_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_GetWriteAllTimeSteps_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_GetWriteOutBlockIdArray_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_GetWriteOutGlobalNodeIdArray_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_IsTypeOf_11 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_NewInstance_13 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_SafeDownCast_14 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_SetBlockIdArrayName_15 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_SetFileName_16 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_SetGhostLevel_17 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_SetModelMetadata_18 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_SetStoreDoubles_19 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_SetWriteAllTimeSteps_20 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_SetWriteOutBlockIdArray_21 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_SetWriteOutGlobalElementIdArray_22 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_SetWriteOutGlobalNodeIdArray_23 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_WriteAllTimeStepsOff_24 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_WriteAllTimeStepsOn_25 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_WriteOutBlockIdArrayOff_26 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_WriteOutBlockIdArrayOn_27 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_WriteOutGlobalElementIdArrayOn_29 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_WriteOutGlobalNodeIdArrayOff_30 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter_WriteOutGlobalNodeIdArrayOn_31 ( HandleRef  pThis) [private]

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

By default, the integer array containing the global Block Ids of the cells is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutBlockIdArray to ON.

By default, the integer array containing the global Block Ids of the cells is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutBlockIdArray to ON.

By default, the integer array containing the global Element Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalElementIdArray to ON.

By default, the integer array containing the global Element Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalElementIdArray to ON.

By default, the integer array containing the global Node Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalNodeIdArray to ON.

By default, the integer array containing the global Node Ids is not included when the new Exodus II file is written out. If you do want to include this array, set WriteOutGlobalNodeIdArray to ON.


Member Data Documentation

new readonly string Kitware.VTK.vtkExodusIIWriter.MRClassNameKey = "17vtkExodusIIWriter" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkWriter.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkWriter.


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