Writer for IOSS (Sierra IO System) More...

#include <vtkIOSSWriter.h>

Inheritance diagram for vtkIOSSWriter:

Collaboration diagram for vtkIOSSWriter:

Public Types
typedef vtkWriter	Superclass

using	EntityType = vtkIOSSReader::EntityType

Public Types inherited from vtkWriter
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkIOSSWriter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	SetSelector (EntityType entity, const char *selector)
	Convenience method to set a single entity selector.

vtkDataArraySelection *	GetFieldSelection (EntityType type)
	Get the selection object for the given entity type.

vtkDataArraySelection *	GetNodeBlockFieldSelection ()
	Returns the field selection object for the element block arrays.

vtkDataArraySelection *	GetEdgeBlockFieldSelection ()
	Returns the field selection object for the edge block arrays.

vtkDataArraySelection *	GetFaceBlockFieldSelection ()
	Returns the field selection object for the face block arrays.

vtkDataArraySelection *	GetElementBlockFieldSelection ()
	Returns the field selection object for the element block arrays.

vtkDataArraySelection *	GetNodeSetFieldSelection ()
	Returns the field selection object for the node set arrays.

vtkDataArraySelection *	GetEdgeSetFieldSelection ()
	Returns the field selection object for the edge set arrays.

vtkDataArraySelection *	GetFaceSetFieldSelection ()
	Returns the field selection object for the edge set arrays.

vtkDataArraySelection *	GetElementSetFieldSelection ()
	Returns the field selection object for the element set arrays.

vtkDataArraySelection *	GetSideSetFieldSelection ()
	Returns the field selection object for the side set arrays.


virtual void	SetFileName (const char *)
	Get/set the filename.

virtual char *	GetFileName ()
	Get/set the filename.


virtual void	SetAssemblyName (const char *)
	Get/Set the active assembly to use.

virtual char *	GetAssemblyName ()
	Get/Set the active assembly to use.


virtual void	SetChooseFieldsToWrite (bool)
	Choose which fields to write.

virtual bool	GetChooseFieldsToWrite ()
	Choose which fields to write.

virtual void	ChooseFieldsToWriteOn ()
	Choose which fields to write.

virtual void	ChooseFieldsToWriteOff ()
	Choose which fields to write.


bool	AddSelector (EntityType entity, const char *selector)
	API to set entity selectors.

void	ClearSelectors (EntityType entity)
	API to set entity selectors.


int	GetNumberOfSelectors (EntityType entity) const
	API to access entity selectors.

const char *	GetSelector (EntityType entity, int index) const
	API to access entity selectors.

std::set< std::string >	GetSelectors (EntityType entity) const
	API to access entity selectors.


bool	AddEdgeBlockSelector (const char *selector)
	Add/Clear/Set/Get edge block selectors.

void	ClearEdgeBlockSelectors ()
	Add/Clear/Set/Get edge block selectors.

void	SetEdgeBlockSelector (const char *selector)
	Add/Clear/Set/Get edge block selectors.

int	GetNumberOfEdgeBlockSelectors () const
	Add/Clear/Set/Get edge block selectors.

const char *	GetEdgeBlockSelector (int index) const
	Add/Clear/Set/Get edge block selectors.

std::set< std::string >	GetEdgeBlockSelectors () const
	Add/Clear/Set/Get edge block selectors.


bool	AddFaceBlockSelector (const char *selector)
	Add/Clear/Set/Get face block selectors.

void	ClearFaceBlockSelectors ()
	Add/Clear/Set/Get face block selectors.

void	SetFaceBlockSelector (const char *selector)
	Add/Clear/Set/Get face block selectors.

int	GetNumberOfFaceBlockSelectors () const
	Add/Clear/Set/Get face block selectors.

const char *	GetFaceBlockSelector (int index) const
	Add/Clear/Set/Get face block selectors.

std::set< std::string >	GetFaceBlockSelectors () const
	Add/Clear/Set/Get face block selectors.


bool	AddElementBlockSelector (const char *selector)
	Add/Clear/Set/Get element block selectors.

void	ClearElementBlockSelectors ()
	Add/Clear/Set/Get element block selectors.

void	SetElementBlockSelector (const char *selector)
	Add/Clear/Set/Get element block selectors.

int	GetNumberOfElementBlockSelectors () const
	Add/Clear/Set/Get element block selectors.

const char *	GetElementBlockSelector (int index) const
	Add/Clear/Set/Get element block selectors.

std::set< std::string >	GetElementBlockSelectors () const
	Add/Clear/Set/Get element block selectors.


bool	AddNodeSetSelector (const char *selector)
	Add/Clear/Set/Get node set selectors.

void	ClearNodeSetSelectors ()
	Add/Clear/Set/Get node set selectors.

void	SetNodeSetSelector (const char *selector)
	Add/Clear/Set/Get node set selectors.

int	GetNumberOfNodeSetSelectors () const
	Add/Clear/Set/Get node set selectors.

const char *	GetNodeSetSelector (int index) const
	Add/Clear/Set/Get node set selectors.

std::set< std::string >	GetNodeSetSelectors () const
	Add/Clear/Set/Get node set selectors.


bool	AddEdgeSetSelector (const char *selector)
	Add/Clear/Set/Get edge set selectors.

void	ClearEdgeSetSelectors ()
	Add/Clear/Set/Get edge set selectors.

void	SetEdgeSetSelector (const char *selector)
	Add/Clear/Set/Get edge set selectors.

int	GetNumberOfEdgeSetSelectors () const
	Add/Clear/Set/Get edge set selectors.

const char *	GetEdgeSetSelector (int index) const
	Add/Clear/Set/Get edge set selectors.

std::set< std::string >	GetEdgeSetSelectors () const
	Add/Clear/Set/Get edge set selectors.


bool	AddFaceSetSelector (const char *selector)
	Add/Clear/Set/Get edge set selectors.

void	ClearFaceSetSelectors ()
	Add/Clear/Set/Get edge set selectors.

void	SetFaceSetSelector (const char *selector)
	Add/Clear/Set/Get edge set selectors.

int	GetNumberOfFaceSetSelectors () const
	Add/Clear/Set/Get edge set selectors.

const char *	GetFaceSetSelector (int index) const
	Add/Clear/Set/Get edge set selectors.

std::set< std::string >	GetFaceSetSelectors () const
	Add/Clear/Set/Get edge set selectors.


bool	AddElementSetSelector (const char *selector)
	Add/Clear/Set/Get element set selectors.

void	ClearElementSetSelectors ()
	Add/Clear/Set/Get element set selectors.

void	SetElementSetSelector (const char *selector)
	Add/Clear/Set/Get element set selectors.

int	GetNumberOfElementSetSelectors () const
	Add/Clear/Set/Get element set selectors.

const char *	GetElementSetSelector (int index) const
	Add/Clear/Set/Get element set selectors.

std::set< std::string >	GetElementSetSelectors () const
	Add/Clear/Set/Get element set selectors.


bool	AddSideSetSelector (const char *selector)
	Add/Clear/Set/Get side set selectors.

void	ClearSideSetSelectors ()
	Add/Clear/Set/Get side set selectors.

void	SetSideSetSelector (const char *selector)
	Add/Clear/Set/Get side set selectors.

int	GetNumberOfSideSetSelectors () const
	Add/Clear/Set/Get side set selectors.

const char *	GetSideSetSelector (int index) const
	Add/Clear/Set/Get side set selectors.

std::set< std::string >	GetSideSetSelectors () const
	Add/Clear/Set/Get side set selectors.


virtual void	SetRemoveGhosts (bool)
	Set/Get whether to write remove ghost cells from the input.

virtual bool	GetRemoveGhosts ()
	Set/Get whether to write remove ghost cells from the input.


virtual void	SetOffsetGlobalIds (bool)
	Exodus wants global ids to start with 1, while VTK generally produces global ids starting with 0.

virtual bool	GetOffsetGlobalIds ()
	Exodus wants global ids to start with 1, while VTK generally produces global ids starting with 0.

virtual void	OffsetGlobalIdsOn ()
	Exodus wants global ids to start with 1, while VTK generally produces global ids starting with 0.

virtual void	OffsetGlobalIdsOff ()
	Exodus wants global ids to start with 1, while VTK generally produces global ids starting with 0.


virtual void	SetPreserveOriginalIds (bool)
	If input is transformed, e.g.

virtual bool	GetPreserveOriginalIds ()
	If input is transformed, e.g.

virtual void	PreserveOriginalIdsOn ()
	If input is transformed, e.g.

virtual void	PreserveOriginalIdsOff ()
	If input is transformed, e.g.


virtual void	SetWriteQAAndInformationRecords (bool)
	When set to true (default), the writer will write quality assurance and information records.

virtual bool	GetWriteQAAndInformationRecords ()
	When set to true (default), the writer will write quality assurance and information records.

virtual void	WriteQAAndInformationRecordsOn ()
	When set to true (default), the writer will write quality assurance and information records.

virtual void	WriteQAAndInformationRecordsOff ()
	When set to true (default), the writer will write quality assurance and information records.


virtual void	SetDisplacementMagnitude (double)
	If input dataset has displacements pre-applied, setting the displacement magnitude to non-zero ensures that the point coordinates in the dataset are correctly transformed using the displacement field array, if present.

virtual double	GetDisplacementMagnitude ()
	If input dataset has displacements pre-applied, setting the displacement magnitude to non-zero ensures that the point coordinates in the dataset are correctly transformed using the displacement field array, if present.


virtual void	SetTimeStepRange (int, int)
	`TimeStepRange` and `TimeStepStride` can be used to limit which timesteps will be written.

void	SetTimeStepRange (int[2])
	`TimeStepRange` and `TimeStepStride` can be used to limit which timesteps will be written.

virtual int *	GetTimeStepRange ()
	`TimeStepRange` and `TimeStepStride` can be used to limit which timesteps will be written.

virtual void	GetTimeStepRange (int &, int &)
	`TimeStepRange` and `TimeStepStride` can be used to limit which timesteps will be written.

virtual void	GetTimeStepRange (int[2])
	`TimeStepRange` and `TimeStepStride` can be used to limit which timesteps will be written.

virtual void	SetTimeStepStride (int)
	`TimeStepRange` and `TimeStepStride` can be used to limit which timesteps will be written.

virtual int	GetTimeStepStride ()
	`TimeStepRange` and `TimeStepStride` can be used to limit which timesteps will be written.


void	SetController (vtkMultiProcessController *controller)
	Get/Set the controller to use when working in parallel.

virtual vtkMultiProcessController *	GetController ()
	Get/Set the controller to use when working in parallel.

Public Member Functions inherited from vtkWriter
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkWriter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual int	Write ()
	Write data to output.

void	EncodeString (char resname, const char name, bool doublePercent)
	Encode the string so that the reader will not have problems.

void	EncodeWriteString (ostream out, const char name, bool doublePercent)
	Encode the string so that the reader will not have problems.

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

void	SetInputData (vtkDataObject *input)
	Set/get the input to this writer.

void	SetInputData (int index, vtkDataObject *input)
	Set/get the input to this writer.

Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.

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.

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output 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.

void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.

void	UpdateProgress (double amount)
	Update the progress of the process object.

bool	CheckAbort ()
	Checks to see if this filter should abort.

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.

void	RemoveAllInputs ()
	Remove all the input data.

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.

virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS void	UpdateInformation ()
	Bring the algorithm's information up-to-date.

virtual void	UpdateDataObject ()
	Create output object(s).

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

virtual VTK_UNBLOCKTHREADS void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.

void	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()` to all output ports of this `vtkAlgorithm`.

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.

bool	UsesGarbageCollector () const override
	Participate in garbage collection.

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.

virtual double	GetProgress ()
	Get the execution progress of a process object.

void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.

vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.

virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.

virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.

void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.

void	SetInputArrayToProcess (const char *name, int fieldAssociation)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.

virtual VTK_UNBLOCKTHREADS void	Update ()
	Bring this algorithm's outputs up-to-date.

virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.

virtual vtkTypeBool	GetReleaseDataFlag ()
	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	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.

int	UpdateExtentIsEmpty (vtkInformation pinfo, 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.

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.

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

void	SetNoPriorTemporalAccessInformationKey (int key)
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

void	SetNoPriorTemporalAccessInformationKey ()
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkIOSSWriter *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkIOSSWriter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkWriter
static vtkTypeBool	IsTypeOf (const char *type)

static vtkWriter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

static vtkInformationIntegerKey *	ABORTED ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkIOSSWriter ()

	~vtkIOSSWriter () override

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

int	RequestUpdateExtent (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

void	WriteData () override

Protected Member Functions inherited from vtkWriter
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkWriter ()

	~vtkWriter () override

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual void	WriteData ()=0

Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.

virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool >	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkWriter
vtkTimeStamp	WriteTime

Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime

vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime

static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Writer for IOSS (Sierra IO System)

vtkIOSSWriter is a writer that uses the IOSS (Sierra IO System) library to write files. Currently this writer supports the Exodus file format. IOSS imposes certain restrictions on the aforementioned file format and hence it may not be possible to write every dataset as an Exodus file using this writer. This is rare for the Exodus.

This writer generates files using the same naming conventions that vtkIOSSReader understands.

Selecting blocks and sets to write

An IOSS file comprises of blocks and sets of various types. These are described by the enum vtkIOSSReader::EntityType. If the input of the writer was initially read by the vtkIOSSReader, then the entity types can be automatically deduced. If it was not initially read by vtkIOSSReader (or even if it was), the assembly name and selectors can be utilized to define which blocks are e.g. element blocks, or side sets. vtkIOSSWriter::SetAssemblyName(...) can be used to set the assembly, and vtkIOSSWriter::AddSelector(...) (or one of its convenience variants) can be used to add selectors. If no selectors have been defined all partitions will be treated as element blocks.

Typical usage is as follows:

vtkNew<vtkIOSSWriter> writer;
writer->SetInputData(...)
writer->SetFileName(...);
writer->SetAssemblyName("Assembly");
writer->AddElementBlockSelector("/IOSS/element_blocks");
writer->Write();

Selecting arrays to write

Similar arrays (or fields as IOSS refers to them) to read from each of the blocks or sets can be specified using the vtkDataArraySelection instance returned using vtkIOSSWriter::GetFieldSelection (or one of its convenience variants).

By default all arrays are enabled. To write specific arrays, f ChooseFieldsToWrite has to be true, which can change using vtkIOSSWriter::SetChooseFieldsToWrite(true).

Typical usage is as follows:

vtkNew<vtkIOSSWriter> writer;
writer->SetInputData(...)
writer->SetFileName(...);
writer->SetAssemblyName("Assembly");
writer->AddElementBlockSelector("/IOSS/element_blocks");
writer->SetChooseFieldsToWrite(true);
writer->GetElementBlockFieldSelection()->EnableArray("EQPS");
writer->Write();

Selection TimeSteps

vtkIOSSWriter::SetTimeStepRange(...) and vtkIOSSWriter::SetTimeStepStride(...) can be used to write a subset of time steps using a range and a stride.

Upcoming features

The following features are planned to be implemented in the future:

Support CGNS file format.
Support writing global data
Support writing pedigree IDs

Appendix

See also: vtkIOSSReader, vtkExodusIIWriter

Tests:: vtkIOSSWriter (Tests)

Definition at line 100 of file vtkIOSSWriter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkWriter vtkIOSSWriter::Superclass

Definition at line 104 of file vtkIOSSWriter.h.

◆ EntityType

using vtkIOSSWriter::EntityType = vtkIOSSReader::EntityType

Definition at line 128 of file vtkIOSSWriter.h.

Constructor & Destructor Documentation

◆ vtkIOSSWriter()

vtkIOSSWriter::vtkIOSSWriter ( )

protected

◆ ~vtkIOSSWriter()

vtkIOSSWriter::~vtkIOSSWriter ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkIOSSWriter * vtkIOSSWriter::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkIOSSWriter::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkIOSSWriter::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkWriter.

◆ SafeDownCast()

static vtkIOSSWriter * vtkIOSSWriter::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkIOSSWriter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkWriter.

◆ NewInstance()

vtkIOSSWriter * vtkIOSSWriter::NewInstance ( ) const

◆ PrintSelf()

void vtkIOSSWriter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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

◆ SetFileName()

virtual void vtkIOSSWriter::SetFileName ( const char * )

virtual

Get/set the filename.

When writing in a distributed environment, the actual filename written out may be different.

◆ GetFileName()

virtual char * vtkIOSSWriter::GetFileName ( )

virtual

Get/set the filename.

When writing in a distributed environment, the actual filename written out may be different.

◆ SetAssemblyName()

virtual void vtkIOSSWriter::SetAssemblyName ( const char * )

virtual

Get/Set the active assembly to use.

The chosen assembly is used in combination with the selectors specified to determine which blocks are to be extracted.

The default is set to vtkDataAssemblyUtilities::HierarchyName().

◆ GetAssemblyName()

virtual char * vtkIOSSWriter::GetAssemblyName ( )

virtual

Get/Set the active assembly to use.

The chosen assembly is used in combination with the selectors specified to determine which blocks are to be extracted.

The default is set to vtkDataAssemblyUtilities::HierarchyName().

◆ SetChooseFieldsToWrite()

virtual void vtkIOSSWriter::SetChooseFieldsToWrite ( bool )

virtual

Choose which fields to write.

If this is true, then only the arrays selected will be written. If this is false, then all arrays will be written.

The default is false.

◆ GetChooseFieldsToWrite()

virtual bool vtkIOSSWriter::GetChooseFieldsToWrite ( )

virtual

Choose which fields to write.

If this is true, then only the arrays selected will be written. If this is false, then all arrays will be written.

The default is false.

◆ ChooseFieldsToWriteOn()

virtual void vtkIOSSWriter::ChooseFieldsToWriteOn ( )

virtual

Choose which fields to write.

If this is true, then only the arrays selected will be written. If this is false, then all arrays will be written.

The default is false.

◆ ChooseFieldsToWriteOff()

virtual void vtkIOSSWriter::ChooseFieldsToWriteOff ( )

virtual

Choose which fields to write.

If this is true, then only the arrays selected will be written. If this is false, then all arrays will be written.

The default is false.

◆ AddSelector()

bool vtkIOSSWriter::AddSelector	(	EntityType	entity,
		const char *	selector
	)

API to set entity selectors.

Multiple selectors can be added using AddSelector. The order in which selectors are specified is not preserved and has no impact on the result.

AddSelector returns true if the selector was added, false if the selector was already specified and hence not added.

See also: vtkDataAssembly::SelectNodes

◆ ClearSelectors()

void vtkIOSSWriter::ClearSelectors ( EntityType entity )

API to set entity selectors.

Multiple selectors can be added using AddSelector. The order in which selectors are specified is not preserved and has no impact on the result.

AddSelector returns true if the selector was added, false if the selector was already specified and hence not added.

See also: vtkDataAssembly::SelectNodes

◆ SetSelector()

void vtkIOSSWriter::SetSelector	(	EntityType	entity,
		const char *	selector
	)

Convenience method to set a single entity selector.

This clears any other existing selectors.

◆ GetNumberOfSelectors()

int vtkIOSSWriter::GetNumberOfSelectors ( EntityType entity ) const

API to access entity selectors.

◆ GetSelector()

const char * vtkIOSSWriter::GetSelector	(	EntityType	entity,
		int	index
	)		const

API to access entity selectors.

◆ GetSelectors()

std::set< std::string > vtkIOSSWriter::GetSelectors ( EntityType entity ) const

API to access entity selectors.

◆ GetFieldSelection()

vtkDataArraySelection * vtkIOSSWriter::GetFieldSelection ( EntityType type )

Get the selection object for the given entity type.

This can be used to select which fields to write.

◆ GetNodeBlockFieldSelection()

vtkDataArraySelection * vtkIOSSWriter::GetNodeBlockFieldSelection ( )

inline

Returns the field selection object for the element block arrays.

Definition at line 189 of file vtkIOSSWriter.h.

◆ AddEdgeBlockSelector()

bool vtkIOSSWriter::AddEdgeBlockSelector ( const char * selector )

inline

Add/Clear/Set/Get edge block selectors.

Definition at line 202 of file vtkIOSSWriter.h.

◆ ClearEdgeBlockSelectors()

void vtkIOSSWriter::ClearEdgeBlockSelectors ( )

inline

Add/Clear/Set/Get edge block selectors.

Definition at line 206 of file vtkIOSSWriter.h.

◆ SetEdgeBlockSelector()

void vtkIOSSWriter::SetEdgeBlockSelector ( const char * selector )

inline

Add/Clear/Set/Get edge block selectors.

Definition at line 207 of file vtkIOSSWriter.h.

◆ GetNumberOfEdgeBlockSelectors()

int vtkIOSSWriter::GetNumberOfEdgeBlockSelectors ( ) const

inline

Add/Clear/Set/Get edge block selectors.

Definition at line 211 of file vtkIOSSWriter.h.

◆ GetEdgeBlockSelector()

const char * vtkIOSSWriter::GetEdgeBlockSelector ( int index ) const

inline

Add/Clear/Set/Get edge block selectors.

Definition at line 215 of file vtkIOSSWriter.h.

◆ GetEdgeBlockSelectors()

std::set< std::string > vtkIOSSWriter::GetEdgeBlockSelectors ( ) const

inline

Add/Clear/Set/Get edge block selectors.

Definition at line 219 of file vtkIOSSWriter.h.

◆ GetEdgeBlockFieldSelection()

vtkDataArraySelection * vtkIOSSWriter::GetEdgeBlockFieldSelection ( )

inline

Returns the field selection object for the edge block arrays.

Definition at line 228 of file vtkIOSSWriter.h.

◆ AddFaceBlockSelector()

bool vtkIOSSWriter::AddFaceBlockSelector ( const char * selector )

inline

Add/Clear/Set/Get face block selectors.

Definition at line 241 of file vtkIOSSWriter.h.

◆ ClearFaceBlockSelectors()

void vtkIOSSWriter::ClearFaceBlockSelectors ( )

inline

Add/Clear/Set/Get face block selectors.

Definition at line 245 of file vtkIOSSWriter.h.

◆ SetFaceBlockSelector()

void vtkIOSSWriter::SetFaceBlockSelector ( const char * selector )

inline

Add/Clear/Set/Get face block selectors.

Definition at line 246 of file vtkIOSSWriter.h.

◆ GetNumberOfFaceBlockSelectors()

int vtkIOSSWriter::GetNumberOfFaceBlockSelectors ( ) const

inline

Add/Clear/Set/Get face block selectors.

Definition at line 250 of file vtkIOSSWriter.h.

◆ GetFaceBlockSelector()

const char * vtkIOSSWriter::GetFaceBlockSelector ( int index ) const

inline

Add/Clear/Set/Get face block selectors.

Definition at line 254 of file vtkIOSSWriter.h.

◆ GetFaceBlockSelectors()

std::set< std::string > vtkIOSSWriter::GetFaceBlockSelectors ( ) const

inline

Add/Clear/Set/Get face block selectors.

Definition at line 258 of file vtkIOSSWriter.h.

◆ GetFaceBlockFieldSelection()

vtkDataArraySelection * vtkIOSSWriter::GetFaceBlockFieldSelection ( )

inline

Returns the field selection object for the face block arrays.

Definition at line 267 of file vtkIOSSWriter.h.

◆ AddElementBlockSelector()

bool vtkIOSSWriter::AddElementBlockSelector ( const char * selector )

inline

Add/Clear/Set/Get element block selectors.

Definition at line 280 of file vtkIOSSWriter.h.

◆ ClearElementBlockSelectors()

void vtkIOSSWriter::ClearElementBlockSelectors ( )

inline

Add/Clear/Set/Get element block selectors.

Definition at line 284 of file vtkIOSSWriter.h.

◆ SetElementBlockSelector()

void vtkIOSSWriter::SetElementBlockSelector ( const char * selector )

inline

Add/Clear/Set/Get element block selectors.

Definition at line 285 of file vtkIOSSWriter.h.

◆ GetNumberOfElementBlockSelectors()

int vtkIOSSWriter::GetNumberOfElementBlockSelectors ( ) const

inline

Add/Clear/Set/Get element block selectors.

Definition at line 289 of file vtkIOSSWriter.h.

◆ GetElementBlockSelector()

const char * vtkIOSSWriter::GetElementBlockSelector ( int index ) const

inline

Add/Clear/Set/Get element block selectors.

Definition at line 293 of file vtkIOSSWriter.h.

◆ GetElementBlockSelectors()

std::set< std::string > vtkIOSSWriter::GetElementBlockSelectors ( ) const

inline

Add/Clear/Set/Get element block selectors.

Definition at line 297 of file vtkIOSSWriter.h.

◆ GetElementBlockFieldSelection()

vtkDataArraySelection * vtkIOSSWriter::GetElementBlockFieldSelection ( )

inline

Returns the field selection object for the element block arrays.

Definition at line 306 of file vtkIOSSWriter.h.

◆ AddNodeSetSelector()

bool vtkIOSSWriter::AddNodeSetSelector ( const char * selector )

inline

Add/Clear/Set/Get node set selectors.

Definition at line 319 of file vtkIOSSWriter.h.

◆ ClearNodeSetSelectors()

void vtkIOSSWriter::ClearNodeSetSelectors ( )

inline

Add/Clear/Set/Get node set selectors.

Definition at line 323 of file vtkIOSSWriter.h.

◆ SetNodeSetSelector()

void vtkIOSSWriter::SetNodeSetSelector ( const char * selector )

inline

Add/Clear/Set/Get node set selectors.

Definition at line 324 of file vtkIOSSWriter.h.

◆ GetNumberOfNodeSetSelectors()

int vtkIOSSWriter::GetNumberOfNodeSetSelectors ( ) const

inline

Add/Clear/Set/Get node set selectors.

Definition at line 328 of file vtkIOSSWriter.h.

◆ GetNodeSetSelector()

const char * vtkIOSSWriter::GetNodeSetSelector ( int index ) const

inline

Add/Clear/Set/Get node set selectors.

Definition at line 332 of file vtkIOSSWriter.h.

◆ GetNodeSetSelectors()

std::set< std::string > vtkIOSSWriter::GetNodeSetSelectors ( ) const

inline

Add/Clear/Set/Get node set selectors.

Definition at line 336 of file vtkIOSSWriter.h.

◆ GetNodeSetFieldSelection()

vtkDataArraySelection * vtkIOSSWriter::GetNodeSetFieldSelection ( )

inline

Returns the field selection object for the node set arrays.

Definition at line 345 of file vtkIOSSWriter.h.

◆ AddEdgeSetSelector()

bool vtkIOSSWriter::AddEdgeSetSelector ( const char * selector )

inline

Add/Clear/Set/Get edge set selectors.

Definition at line 358 of file vtkIOSSWriter.h.

◆ ClearEdgeSetSelectors()

void vtkIOSSWriter::ClearEdgeSetSelectors ( )

inline

Add/Clear/Set/Get edge set selectors.

Definition at line 362 of file vtkIOSSWriter.h.

◆ SetEdgeSetSelector()

void vtkIOSSWriter::SetEdgeSetSelector ( const char * selector )

inline

Add/Clear/Set/Get edge set selectors.

Definition at line 363 of file vtkIOSSWriter.h.

◆ GetNumberOfEdgeSetSelectors()

int vtkIOSSWriter::GetNumberOfEdgeSetSelectors ( ) const

inline

Add/Clear/Set/Get edge set selectors.

Definition at line 367 of file vtkIOSSWriter.h.

◆ GetEdgeSetSelector()

const char * vtkIOSSWriter::GetEdgeSetSelector ( int index ) const

inline

Add/Clear/Set/Get edge set selectors.

Definition at line 371 of file vtkIOSSWriter.h.

◆ GetEdgeSetSelectors()

std::set< std::string > vtkIOSSWriter::GetEdgeSetSelectors ( ) const

inline

Add/Clear/Set/Get edge set selectors.

Definition at line 375 of file vtkIOSSWriter.h.

◆ GetEdgeSetFieldSelection()

vtkDataArraySelection * vtkIOSSWriter::GetEdgeSetFieldSelection ( )

inline

Returns the field selection object for the edge set arrays.

Definition at line 384 of file vtkIOSSWriter.h.

◆ AddFaceSetSelector()

bool vtkIOSSWriter::AddFaceSetSelector ( const char * selector )

inline

Add/Clear/Set/Get edge set selectors.

Definition at line 397 of file vtkIOSSWriter.h.

◆ ClearFaceSetSelectors()

void vtkIOSSWriter::ClearFaceSetSelectors ( )

inline

Add/Clear/Set/Get edge set selectors.

Definition at line 401 of file vtkIOSSWriter.h.

◆ SetFaceSetSelector()

void vtkIOSSWriter::SetFaceSetSelector ( const char * selector )

inline

Add/Clear/Set/Get edge set selectors.

Definition at line 402 of file vtkIOSSWriter.h.

◆ GetNumberOfFaceSetSelectors()

int vtkIOSSWriter::GetNumberOfFaceSetSelectors ( ) const

inline

Add/Clear/Set/Get edge set selectors.

Definition at line 406 of file vtkIOSSWriter.h.

◆ GetFaceSetSelector()

const char * vtkIOSSWriter::GetFaceSetSelector ( int index ) const

inline

Add/Clear/Set/Get edge set selectors.

Definition at line 410 of file vtkIOSSWriter.h.

◆ GetFaceSetSelectors()

std::set< std::string > vtkIOSSWriter::GetFaceSetSelectors ( ) const

inline

Add/Clear/Set/Get edge set selectors.

Definition at line 414 of file vtkIOSSWriter.h.

◆ GetFaceSetFieldSelection()

vtkDataArraySelection * vtkIOSSWriter::GetFaceSetFieldSelection ( )

inline

Returns the field selection object for the edge set arrays.

Definition at line 423 of file vtkIOSSWriter.h.

◆ AddElementSetSelector()

bool vtkIOSSWriter::AddElementSetSelector ( const char * selector )

inline

Add/Clear/Set/Get element set selectors.

Definition at line 436 of file vtkIOSSWriter.h.

◆ ClearElementSetSelectors()

void vtkIOSSWriter::ClearElementSetSelectors ( )

inline

Add/Clear/Set/Get element set selectors.

Definition at line 440 of file vtkIOSSWriter.h.

◆ SetElementSetSelector()

void vtkIOSSWriter::SetElementSetSelector ( const char * selector )

inline

Add/Clear/Set/Get element set selectors.

Definition at line 441 of file vtkIOSSWriter.h.

◆ GetNumberOfElementSetSelectors()

int vtkIOSSWriter::GetNumberOfElementSetSelectors ( ) const

inline

Add/Clear/Set/Get element set selectors.

Definition at line 445 of file vtkIOSSWriter.h.

◆ GetElementSetSelector()

const char * vtkIOSSWriter::GetElementSetSelector ( int index ) const

inline

Add/Clear/Set/Get element set selectors.

Definition at line 449 of file vtkIOSSWriter.h.

◆ GetElementSetSelectors()

std::set< std::string > vtkIOSSWriter::GetElementSetSelectors ( ) const

inline

Add/Clear/Set/Get element set selectors.

Definition at line 453 of file vtkIOSSWriter.h.

◆ GetElementSetFieldSelection()

vtkDataArraySelection * vtkIOSSWriter::GetElementSetFieldSelection ( )

inline

Returns the field selection object for the element set arrays.

Definition at line 462 of file vtkIOSSWriter.h.

◆ AddSideSetSelector()

bool vtkIOSSWriter::AddSideSetSelector ( const char * selector )

inline

Add/Clear/Set/Get side set selectors.

Definition at line 475 of file vtkIOSSWriter.h.

◆ ClearSideSetSelectors()

void vtkIOSSWriter::ClearSideSetSelectors ( )

inline

Add/Clear/Set/Get side set selectors.

Definition at line 479 of file vtkIOSSWriter.h.

◆ SetSideSetSelector()

void vtkIOSSWriter::SetSideSetSelector ( const char * selector )

inline

Add/Clear/Set/Get side set selectors.

Definition at line 480 of file vtkIOSSWriter.h.

◆ GetNumberOfSideSetSelectors()

int vtkIOSSWriter::GetNumberOfSideSetSelectors ( ) const

inline

Add/Clear/Set/Get side set selectors.

Definition at line 484 of file vtkIOSSWriter.h.

◆ GetSideSetSelector()

const char * vtkIOSSWriter::GetSideSetSelector ( int index ) const

inline

Add/Clear/Set/Get side set selectors.

Definition at line 488 of file vtkIOSSWriter.h.

◆ GetSideSetSelectors()

std::set< std::string > vtkIOSSWriter::GetSideSetSelectors ( ) const

inline

Add/Clear/Set/Get side set selectors.

Definition at line 492 of file vtkIOSSWriter.h.

◆ GetSideSetFieldSelection()

vtkDataArraySelection * vtkIOSSWriter::GetSideSetFieldSelection ( )

inline

Returns the field selection object for the side set arrays.

Definition at line 501 of file vtkIOSSWriter.h.

◆ SetRemoveGhosts()

virtual void vtkIOSSWriter::SetRemoveGhosts ( bool )

virtual

Set/Get whether to write remove ghost cells from the input.

The default is 1.

◆ GetRemoveGhosts()

virtual bool vtkIOSSWriter::GetRemoveGhosts ( )

virtual

Set/Get whether to write remove ghost cells from the input.

The default is 1.

◆ SetOffsetGlobalIds()

virtual void vtkIOSSWriter::SetOffsetGlobalIds ( bool )

virtual

Exodus wants global ids to start with 1, while VTK generally produces global ids starting with 0.

Set this to true (default false), if the global ids are generated by VTK and hence start with 0. When writing to the output file, they will be offset by 1 to ensure the ids are valid exodus ids.

◆ GetOffsetGlobalIds()

virtual bool vtkIOSSWriter::GetOffsetGlobalIds ( )

virtual

Exodus wants global ids to start with 1, while VTK generally produces global ids starting with 0.

Set this to true (default false), if the global ids are generated by VTK and hence start with 0. When writing to the output file, they will be offset by 1 to ensure the ids are valid exodus ids.

◆ OffsetGlobalIdsOn()

virtual void vtkIOSSWriter::OffsetGlobalIdsOn ( )

virtual

Exodus wants global ids to start with 1, while VTK generally produces global ids starting with 0.

Set this to true (default false), if the global ids are generated by VTK and hence start with 0. When writing to the output file, they will be offset by 1 to ensure the ids are valid exodus ids.

◆ OffsetGlobalIdsOff()

virtual void vtkIOSSWriter::OffsetGlobalIdsOff ( )

virtual

Exodus wants global ids to start with 1, while VTK generally produces global ids starting with 0.

Set this to true (default false), if the global ids are generated by VTK and hence start with 0. When writing to the output file, they will be offset by 1 to ensure the ids are valid exodus ids.

◆ SetPreserveOriginalIds()

virtual void vtkIOSSWriter::SetPreserveOriginalIds ( bool )

virtual

If input is transformed, e.g.

through clipping, new element blocks may be created. This flag can be used to indicate whether to preserve the original ids from blocks.

The default is false.

◆ GetPreserveOriginalIds()

virtual bool vtkIOSSWriter::GetPreserveOriginalIds ( )

virtual

If input is transformed, e.g.

through clipping, new element blocks may be created. This flag can be used to indicate whether to preserve the original ids from blocks.

The default is false.

◆ PreserveOriginalIdsOn()

virtual void vtkIOSSWriter::PreserveOriginalIdsOn ( )

virtual

If input is transformed, e.g.

through clipping, new element blocks may be created. This flag can be used to indicate whether to preserve the original ids from blocks.

The default is false.

◆ PreserveOriginalIdsOff()

virtual void vtkIOSSWriter::PreserveOriginalIdsOff ( )

virtual

If input is transformed, e.g.

through clipping, new element blocks may be created. This flag can be used to indicate whether to preserve the original ids from blocks.

The default is false.

◆ SetWriteQAAndInformationRecords()

virtual void vtkIOSSWriter::SetWriteQAAndInformationRecords ( bool )

virtual

When set to true (default), the writer will write quality assurance and information records.

These records are not copied from the input, but they are generated by the writer.

◆ GetWriteQAAndInformationRecords()

virtual bool vtkIOSSWriter::GetWriteQAAndInformationRecords ( )

virtual

When set to true (default), the writer will write quality assurance and information records.

These records are not copied from the input, but they are generated by the writer.

◆ WriteQAAndInformationRecordsOn()

virtual void vtkIOSSWriter::WriteQAAndInformationRecordsOn ( )

virtual

When set to true (default), the writer will write quality assurance and information records.

These records are not copied from the input, but they are generated by the writer.

◆ WriteQAAndInformationRecordsOff()

virtual void vtkIOSSWriter::WriteQAAndInformationRecordsOff ( )

virtual

When set to true (default), the writer will write quality assurance and information records.

These records are not copied from the input, but they are generated by the writer.

◆ SetDisplacementMagnitude()

virtual void vtkIOSSWriter::SetDisplacementMagnitude ( double )

virtual

If input dataset has displacements pre-applied, setting the displacement magnitude to non-zero ensures that the point coordinates in the dataset are correctly transformed using the displacement field array, if present.

Defaults to 1.0.

◆ GetDisplacementMagnitude()

virtual double vtkIOSSWriter::GetDisplacementMagnitude ( )

virtual

If input dataset has displacements pre-applied, setting the displacement magnitude to non-zero ensures that the point coordinates in the dataset are correctly transformed using the displacement field array, if present.

Defaults to 1.0.

◆ SetTimeStepRange() [1/2]

virtual void vtkIOSSWriter::SetTimeStepRange	(	int	,
		int
	)

virtual

TimeStepRange and TimeStepStride can be used to limit which timesteps will be written.

If the range is invalid, i.e. TimeStepRange[0] >= TimeStepRange[1], it's assumed that no TimeStepRange overrides have been specified and both TimeStepRange and TimeStepStride will be ignored. When valid, only the chosen subset of files will be processed.

◆ SetTimeStepRange() [2/2]

void vtkIOSSWriter::SetTimeStepRange ( int [2] )

TimeStepRange and TimeStepStride can be used to limit which timesteps will be written.

If the range is invalid, i.e. TimeStepRange[0] >= TimeStepRange[1], it's assumed that no TimeStepRange overrides have been specified and both TimeStepRange and TimeStepStride will be ignored. When valid, only the chosen subset of files will be processed.

◆ GetTimeStepRange() [1/3]

virtual int * vtkIOSSWriter::GetTimeStepRange ( )

virtual

TimeStepRange and TimeStepStride can be used to limit which timesteps will be written.

If the range is invalid, i.e. TimeStepRange[0] >= TimeStepRange[1], it's assumed that no TimeStepRange overrides have been specified and both TimeStepRange and TimeStepStride will be ignored. When valid, only the chosen subset of files will be processed.

◆ GetTimeStepRange() [2/3]

virtual void vtkIOSSWriter::GetTimeStepRange	(	int &	,
		int &
	)

virtual

TimeStepRange and TimeStepStride can be used to limit which timesteps will be written.

If the range is invalid, i.e. TimeStepRange[0] >= TimeStepRange[1], it's assumed that no TimeStepRange overrides have been specified and both TimeStepRange and TimeStepStride will be ignored. When valid, only the chosen subset of files will be processed.

◆ GetTimeStepRange() [3/3]

virtual void vtkIOSSWriter::GetTimeStepRange ( int [2] )

virtual

TimeStepRange and TimeStepStride can be used to limit which timesteps will be written.

If the range is invalid, i.e. TimeStepRange[0] >= TimeStepRange[1], it's assumed that no TimeStepRange overrides have been specified and both TimeStepRange and TimeStepStride will be ignored. When valid, only the chosen subset of files will be processed.

◆ SetTimeStepStride()

virtual void vtkIOSSWriter::SetTimeStepStride ( int )

virtual

TimeStepRange and TimeStepStride can be used to limit which timesteps will be written.

If the range is invalid, i.e. TimeStepRange[0] >= TimeStepRange[1], it's assumed that no TimeStepRange overrides have been specified and both TimeStepRange and TimeStepStride will be ignored. When valid, only the chosen subset of files will be processed.

◆ GetTimeStepStride()

virtual int vtkIOSSWriter::GetTimeStepStride ( )

virtual

TimeStepRange and TimeStepStride can be used to limit which timesteps will be written.

If the range is invalid, i.e. TimeStepRange[0] >= TimeStepRange[1], it's assumed that no TimeStepRange overrides have been specified and both TimeStepRange and TimeStepStride will be ignored. When valid, only the chosen subset of files will be processed.

◆ SetController()

void vtkIOSSWriter::SetController ( vtkMultiProcessController * controller )

Get/Set the controller to use when working in parallel.

Initialized to vtkMultiProcessController::GetGlobalController in the constructor.

The controller is used to determine the upstream piece request in RequestUpdateExtent.

◆ GetController()

virtual vtkMultiProcessController * vtkIOSSWriter::GetController ( )

virtual

Get/Set the controller to use when working in parallel.

Initialized to vtkMultiProcessController::GetGlobalController in the constructor.

The controller is used to determine the upstream piece request in RequestUpdateExtent.

◆ FillInputPortInformation()

int vtkIOSSWriter::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)

overrideprotectedvirtual

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

◆ ProcessRequest()

vtkTypeBool vtkIOSSWriter::ProcessRequest	(	vtkInformation *	request,
		vtkInformationVector **	inInfo,
		vtkInformationVector *	outInfo
	)

overrideprotectedvirtual

Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

Upstream requests correspond to information flow from the algorithm's outputs to its inputs. Downstream requests correspond to information flow from the algorithm's inputs to its outputs.

A downstream request is defined by the contents of the request information object. The input to the request is stored in the input information vector passed to ProcessRequest. The results of an downstream request are stored in the output information vector passed to ProcessRequest.

An upstream request is defined by the contents of the request information object. The input to the request is stored in the output information vector passed to ProcessRequest. The results of an upstream request are stored in the input information vector passed to ProcessRequest.

It returns the boolean status of the pipeline (false means failure).

Reimplemented from vtkAlgorithm.

◆ RequestInformation()

int vtkIOSSWriter::RequestInformation	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

protected

◆ RequestUpdateExtent()

int vtkIOSSWriter::RequestUpdateExtent	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

protected

◆ RequestData()

int vtkIOSSWriter::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

overrideprotectedvirtual

Reimplemented from vtkWriter.

◆ WriteData()

void vtkIOSSWriter::WriteData ( )

overrideprotectedvirtual

Implements vtkWriter.

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

IO/IOSS/vtkIOSSWriter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Selecting blocks and sets to write

Selecting arrays to write

Selection TimeSteps

Upcoming features

Appendix

Member Typedef Documentation

◆ Superclass

◆ EntityType

Constructor & Destructor Documentation

◆ vtkIOSSWriter()

◆ ~vtkIOSSWriter()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetFileName()

◆ GetFileName()

◆ SetAssemblyName()

◆ GetAssemblyName()

◆ SetChooseFieldsToWrite()

◆ GetChooseFieldsToWrite()

◆ ChooseFieldsToWriteOn()

◆ ChooseFieldsToWriteOff()

◆ AddSelector()

◆ ClearSelectors()

◆ SetSelector()

◆ GetNumberOfSelectors()

◆ GetSelector()

◆ GetSelectors()

◆ GetFieldSelection()

◆ GetNodeBlockFieldSelection()

◆ AddEdgeBlockSelector()

◆ ClearEdgeBlockSelectors()

◆ SetEdgeBlockSelector()

◆ GetNumberOfEdgeBlockSelectors()

◆ GetEdgeBlockSelector()

◆ GetEdgeBlockSelectors()

◆ GetEdgeBlockFieldSelection()

◆ AddFaceBlockSelector()

◆ ClearFaceBlockSelectors()

◆ SetFaceBlockSelector()

◆ GetNumberOfFaceBlockSelectors()

◆ GetFaceBlockSelector()

◆ GetFaceBlockSelectors()

◆ GetFaceBlockFieldSelection()

◆ AddElementBlockSelector()

◆ ClearElementBlockSelectors()

◆ SetElementBlockSelector()

◆ GetNumberOfElementBlockSelectors()

◆ GetElementBlockSelector()

◆ GetElementBlockSelectors()

◆ GetElementBlockFieldSelection()

◆ AddNodeSetSelector()

◆ ClearNodeSetSelectors()

◆ SetNodeSetSelector()

◆ GetNumberOfNodeSetSelectors()

◆ GetNodeSetSelector()

◆ GetNodeSetSelectors()

◆ GetNodeSetFieldSelection()

◆ AddEdgeSetSelector()

◆ ClearEdgeSetSelectors()

◆ SetEdgeSetSelector()

◆ GetNumberOfEdgeSetSelectors()

◆ GetEdgeSetSelector()

◆ GetEdgeSetSelectors()

◆ GetEdgeSetFieldSelection()

◆ AddFaceSetSelector()

◆ ClearFaceSetSelectors()

◆ SetFaceSetSelector()

◆ GetNumberOfFaceSetSelectors()