ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected 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.
- Public Member Functions inherited from Kitware.VTK.vtkWriter
 vtkWriter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
void EncodeString (string resname, string name, bool doublePercent)
 Encode the string so that the reader will not have problems. The resulting string is up to three times the size of the input string. doublePercent indicates whether to output a double '%' before escaped characters so the string may be used as a printf format string.
vtkDataObject GetInput ()
 Set/get the input to this writer.
vtkDataObject GetInput (int port)
 Set/get the input to this writer.
void SetInput (vtkDataObject input)
 Set/get the input to this writer.
void SetInput (int index, vtkDataObject input)
 Set/get the input to this writer.
virtual int Write ()
 Write data to output. Method executes subclasses WriteData() method, as well as StartMethod() and EndMethod() methods. Returns 1 on success and 0 on failure.
- Public Member Functions inherited from Kitware.VTK.vtkAlgorithm
 vtkAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkAlgorithm ()
 *Undocumented Block
override void Register (vtkObjectBase o)
 Participate in garbage collection.
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void AddInputConnection (int port, vtkAlgorithmOutput input)
 Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is.
virtual void AddInputConnection (vtkAlgorithmOutput input)
 Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is.
virtual double ComputePriority ()
 Returns the priority of the piece described by the current update extent. The priority is a number between 0.0 and 1.0 with 0 meaning skippable (REQUEST_DATA not needed) and 1.0 meaning important.
void ConvertTotalInputToPortConnection (int ind, ref int port, ref int conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual int GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual uint GetErrorCode ()
 The error code contains a possible error that occured while reading or writing the file.
vtkExecutive GetExecutive ()
 Get this algorithm's executive. If it has none, a default executive will be created.
virtual vtkInformation GetInformation ()
 Set/Get the information object associated with this algorithm.
vtkInformation GetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
vtkAlgorithmOutput GetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
vtkDataObject GetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
vtkInformation GetInputPortInformation (int port)
 Get the information object associated with an input port. There is one input port per kind of input to the algorithm. Each input port tells executives what kind of data and downstream requests this algorithm can handle for that input.
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
vtkDataObject GetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
vtkAlgorithmOutput GetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.
vtkAlgorithmOutput GetOutputPort ()
 Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.
vtkInformation GetOutputPortInformation (int port)
 Get the information object associated with an output port. There is one output port per output from the algorithm. Each output port tells executives what kind of upstream requests this algorithm can handle for that output.
virtual double GetProgress ()
 Set/Get the execution progress of a process object.
virtual double GetProgressMaxValue ()
 Set/Get the execution progress of a process object.
virtual double GetProgressMinValue ()
 Set/Get the execution progress of a process object.
virtual string GetProgressText ()
 Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
int HasExecutive ()
 Check whether this algorithm has an assigned executive. This will NOT create a default executive.
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. The default implementation is empty. Returns 1 on success, 0 on failure. When can be either vtkExecutive::BeforeForward or vtkExecutive::AfterForward.
int ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector outInfo)
 Version of ProcessRequest() that is wrapped. This converts the collection to an array and calls the other version.
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
void RemoveAllInputs ()
 Remove all the input data.
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput input)
 Remove a connection from the given input port index. See SetInputConnection() for details on input connection. This method is the complement to AddInputConnection() in that it removes only the connection specified without affecting other connections. Typical usage is.
virtual void SetAbortExecute (int _arg)
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void SetExecutive (vtkExecutive executive)
 Set this algorithm's executive. This algorithm is removed from any executive to which it has previously been assigned and then assigned to the given executive.
virtual void SetInformation (vtkInformation arg0)
 Set/Get the information object associated with this algorithm.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, string name)
 Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void SetInputArrayToProcess (int idx, vtkInformation info)
 Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void SetInputArrayToProcess (int idx, int port, int connection, string fieldAssociation, string attributeTypeorName)
 String based versions of SetInputArrayToProcess(). Because fieldAssociation and fieldAttributeType are enums, they cannot be easily accessed from scripting language. These methods provides an easy and safe way of passing association and attribute type information. Field association is one of the following:
virtual void SetInputConnection (int port, vtkAlgorithmOutput input)
 Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().
virtual void SetInputConnection (vtkAlgorithmOutput input)
 Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().
virtual void SetProgress (double _arg)
 Set/Get the execution progress of a process object.
void SetProgressText (string ptext)
 Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().
virtual void SetReleaseDataFlag (int arg0)
 Turn release data flag on or off for all output ports.
virtual void Update ()
 Bring this algorithm's outputs up-to-date.
int UpdateExtentIsEmpty (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. The source uses this call to determine whether to call Execute.
int UpdateExtentIsEmpty (vtkInformation pinfo, int extentType)
 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. The source uses this call to determine whether to call Execute.
virtual void UpdateInformation ()
 Backward compatibility method to invoke UpdateInformation on executive.
void UpdateProgress (double amount)
 Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
virtual uint GetMTime ()
 Return this object's modified time.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

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.
- Public Attributes inherited from Kitware.VTK.vtkWriter
- Public Attributes inherited from Kitware.VTK.vtkAlgorithm
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkExodusIIWriter"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkWriter
- Static Public Attributes inherited from Kitware.VTK.vtkAlgorithm
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

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.

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

static Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter ( )
staticprivate

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.

Kitware.VTK.vtkExodusIIWriter.vtkExodusIIWriter ( )

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

virtual string Kitware.VTK.vtkExodusIIWriter.GetBlockIdArrayName ( )
virtual

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.

virtual int Kitware.VTK.vtkExodusIIWriter.GetGhostLevel ( )
virtual

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

virtual vtkModelMetadata Kitware.VTK.vtkExodusIIWriter.GetModelMetadata ( )
virtual

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:

virtual int Kitware.VTK.vtkExodusIIWriter.GetStoreDoubles ( )
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 int Kitware.VTK.vtkExodusIIWriter.GetWriteAllTimeSteps ( )
virtual

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

virtual int Kitware.VTK.vtkExodusIIWriter.GetWriteOutBlockIdArray ( )
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.

virtual int Kitware.VTK.vtkExodusIIWriter.GetWriteOutGlobalElementIdArray ( )
virtual

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 Kitware.VTK.vtkExodusIIWriter.GetWriteOutGlobalNodeIdArray ( )
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.

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.

static new vtkExodusIIWriter Kitware.VTK.vtkExodusIIWriter.New ( )
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkAlgorithm.

new vtkExodusIIWriter Kitware.VTK.vtkExodusIIWriter.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkWriter.

static new vtkExodusIIWriter Kitware.VTK.vtkExodusIIWriter.SafeDownCast ( vtkObjectBase  o)
static

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

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

virtual void Kitware.VTK.vtkExodusIIWriter.SetWriteOutGlobalElementIdArray ( int  _arg)
virtual

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.

virtual void Kitware.VTK.vtkExodusIIWriter.WriteAllTimeStepsOff ( )
virtual

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

virtual void Kitware.VTK.vtkExodusIIWriter.WriteAllTimeStepsOn ( )
virtual

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

virtual void Kitware.VTK.vtkExodusIIWriter.WriteOutBlockIdArrayOff ( )
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.

virtual void Kitware.VTK.vtkExodusIIWriter.WriteOutBlockIdArrayOn ( )
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.

virtual void Kitware.VTK.vtkExodusIIWriter.WriteOutGlobalElementIdArrayOff ( )
virtual

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.WriteOutGlobalElementIdArrayOn ( )
virtual

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

virtual void Kitware.VTK.vtkExodusIIWriter.WriteOutGlobalNodeIdArrayOn ( )
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.


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: