write eXtensible Data Model and Format files More...

#include <vtkXdmfWriter.h>

Inheritance diagram for vtkXdmfWriter:

Collaboration diagram for vtkXdmfWriter:

Public Types
typedef vtkDataObjectAlgorithm	Superclass

Public Types inherited from vtkDataObjectAlgorithm
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.

vtkXdmfWriter *	NewInstance () const

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

virtual void	SetInputData (vtkDataObject *dobj)
	Set the input data set.

virtual int	Write ()
	Write data to output.


	vtkSetFilePathMacro (FileName)
	Set or get the file name of the xdmf file.

	vtkGetFilePathMacro (FileName)
	Set or get the file name of the xdmf file.


	vtkSetFilePathMacro (HeavyDataFileName)
	Set or get the file name of the hdf5 file.

	vtkGetFilePathMacro (HeavyDataFileName)
	Set or get the file name of the hdf5 file.


virtual void	SetHeavyDataGroupName (const char *)
	Set or get the group name into which data will be written it may contain nested groups as in "/Proc0/Block0".

virtual char *	GetHeavyDataGroupName ()
	Set or get the group name into which data will be written it may contain nested groups as in "/Proc0/Block0".


virtual void	SetLightDataLimit (int)
	Topology Geometry and Attribute arrays smaller than this are written in line into the XML.

virtual int	GetLightDataLimit ()
	Topology Geometry and Attribute arrays smaller than this are written in line into the XML.


virtual void	SetWriteAllTimeSteps (int)
	Controls whether writer automatically writes all input time steps, or just the timestep that is currently on the input.

virtual int	GetWriteAllTimeSteps ()
	Controls whether writer automatically writes all input time steps, or just the timestep that is currently on the input.

virtual void	WriteAllTimeStepsOn ()
	Controls whether writer automatically writes all input time steps, or just the timestep that is currently on the input.

virtual void	WriteAllTimeStepsOff ()
	Controls whether writer automatically writes all input time steps, or just the timestep that is currently on the input.


virtual void	SetMeshStaticOverTime (bool)
	Set of get the flag that specify if input mesh is static over time.

virtual bool	GetMeshStaticOverTime ()
	Set of get the flag that specify if input mesh is static over time.

virtual void	MeshStaticOverTimeOn ()
	Set of get the flag that specify if input mesh is static over time.

virtual void	MeshStaticOverTimeOff ()
	Set of get the flag that specify if input mesh is static over time.


virtual void	SetPiece (int)
	Called in parallel runs to identify the portion this process is responsible for TODO: respect this.

virtual void	SetNumberOfPieces (int)
	Called in parallel runs to identify the portion this process is responsible for TODO: respect this.

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

vtkDataObjectAlgorithm *	NewInstance () const

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

vtkTypeBool	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	see vtkAlgorithm for details

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkDataObject *	GetOutput ()
	Get the output data object for a port on this algorithm.

vtkDataObject *	GetOutput (int)
	Get the output data object for a port on this algorithm.

virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.

void	SetInputData (vtkDataObject *)
	Assign a data object as input.

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.

void	AddInputData (vtkDataObject *)
	Assign a data object as input.

void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.

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.

int	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	SetProgress (double)
	`SetProgress` is deprecated.

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

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess().

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 int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.

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

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.

void	Register (vtkObjectBase *o) override
	Participate in garbage collection.

void	UnRegister (vtkObjectBase *o) 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	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.

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	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 void	Update (int port)
	Bring this algorithm's outputs up-to-date.

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

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

virtual int	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.

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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.

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

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

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

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.

virtual 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 vtkXdmfWriter *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkXdmfWriter *	SafeDownCast (vtkObjectBase *o)

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObjectAlgorithm *	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 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 (int 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 int	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

	vtkXdmfWriter ()

	~vtkXdmfWriter () override

vtkExecutive *	CreateDefaultExecutive () override
	Create a default executive.

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

int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector ) override

int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass.

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override

virtual int	CreateTopology (vtkDataSet ds, xdmf2::XdmfGrid grid, vtkIdType PDims[3], vtkIdType CDims[3], vtkIdType &PRank, vtkIdType &CRank, void *staticdata)

virtual int	CreateGeometry (vtkDataSet ds, xdmf2::XdmfGrid grid, void *staticdata)

virtual int	WriteDataSet (vtkDataObject dobj, xdmf2::XdmfGrid grid)

virtual int	WriteCompositeDataSet (vtkCompositeDataSet dobj, xdmf2::XdmfGrid grid)

virtual int	WriteAtomicDataSet (vtkDataObject dobj, xdmf2::XdmfGrid grid)

virtual int	WriteArrays (vtkFieldData dsa, xdmf2::XdmfGrid grid, int association, vtkIdType rank, vtkIdType dims, const char name)

virtual void	ConvertVToXArray (vtkDataArray vda, xdmf2::XdmfArray xda, vtkIdType rank, vtkIdType dims, int AllocStrategy, const char heavyprefix)

virtual void	SetupDataArrayXML (xdmf2::XdmfElement , xdmf2::XdmfArray ) const

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

	vtkDataObjectAlgorithm ()

	~vtkDataObjectAlgorithm () override

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

virtual int	RequestDataObject (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

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

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

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

	vtkAlgorithm ()

	~vtkAlgorithm () override

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 assocition 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 *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
char *	FileName

char *	HeavyDataFileName

char *	HeavyDataGroupName

std::string	WorkingDirectory

std::string	BaseFileName

int	LightDataLimit

int	WriteAllTimeSteps

int	NumberOfTimeSteps

double	CurrentTime

int	CurrentTimeIndex

int	CurrentBlockIndex

int	UnlabelledDataArrayId

int	Piece

int	NumberOfPieces

bool	MeshStaticOverTime

xdmf2::XdmfDOM *	DOM

xdmf2::XdmfGrid *	TopTemporalGrid

vtkXdmfWriterDomainMemoryHandler *	DomainMemoryHandler

std::vector< xdmf2::XdmfTopology * >	TopologyAtT0

std::vector< xdmf2::XdmfGeometry * >	GeometryAtT0

Protected Attributes inherited from vtkAlgorithm
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

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

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute

Static Protected Member Functions inherited from vtkDataObjectAlgorithm
static bool	SetOutputDataObject (int dataType, vtkInformation *outputInformation, bool exact=false)
	A helper method that can be used by subclasses in `RequestDataObject` to create an output data object of the given type if not already present.

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

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

write eXtensible Data Model and Format files

vtkXdmfWriter converts vtkDataObjects to XDMF format. This is intended to replace vtkXdmfWriter, which is not up to date with the capabilities of the newer XDMF2 library. This writer understands VTK's composite data types and produces full trees in the output XDMF files.

Definition at line 57 of file vtkXdmfWriter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObjectAlgorithm vtkXdmfWriter::Superclass

Definition at line 61 of file vtkXdmfWriter.h.

Constructor & Destructor Documentation

◆ vtkXdmfWriter()

vtkXdmfWriter::vtkXdmfWriter ( )

protected

◆ ~vtkXdmfWriter()

vtkXdmfWriter::~vtkXdmfWriter ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkXdmfWriter * vtkXdmfWriter::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkXdmfWriter::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 vtkDataObjectAlgorithm.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXdmfWriter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ NewInstance()

vtkXdmfWriter * vtkXdmfWriter::NewInstance ( ) const

◆ PrintSelf()

void vtkXdmfWriter::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 vtkDataObjectAlgorithm.

◆ SetInputData()

virtual void vtkXdmfWriter::SetInputData ( vtkDataObject * dobj )

virtual

Set the input data set.

◆ vtkSetFilePathMacro() [1/2]

vtkXdmfWriter::vtkSetFilePathMacro ( FileName )

Set or get the file name of the xdmf file.

◆ vtkGetFilePathMacro() [1/2]

vtkXdmfWriter::vtkGetFilePathMacro ( FileName )

Set or get the file name of the xdmf file.

◆ vtkSetFilePathMacro() [2/2]

vtkXdmfWriter::vtkSetFilePathMacro ( HeavyDataFileName )

Set or get the file name of the hdf5 file.

Note that if the File name is not specified, then the group name is ignore

◆ vtkGetFilePathMacro() [2/2]

vtkXdmfWriter::vtkGetFilePathMacro ( HeavyDataFileName )

Set or get the file name of the hdf5 file.

Note that if the File name is not specified, then the group name is ignore

◆ SetHeavyDataGroupName()

virtual void vtkXdmfWriter::SetHeavyDataGroupName ( const char * )

virtual

Set or get the group name into which data will be written it may contain nested groups as in "/Proc0/Block0".

◆ GetHeavyDataGroupName()

virtual char * vtkXdmfWriter::GetHeavyDataGroupName ( )

virtual

Set or get the group name into which data will be written it may contain nested groups as in "/Proc0/Block0".

◆ Write()

virtual int vtkXdmfWriter::Write ( )

virtual

Write data to output.

Method executes subclasses WriteData() method, as well as StartMethod() and EndMethod() methods. Returns 1 on success and 0 on failure.

◆ SetLightDataLimit()

virtual void vtkXdmfWriter::SetLightDataLimit ( int )

virtual

Topology Geometry and Attribute arrays smaller than this are written in line into the XML.

Default is 100. Node: LightDataLimit is forced to 1 when MeshStaticOverTime is TRUE.

◆ GetLightDataLimit()

virtual int vtkXdmfWriter::GetLightDataLimit ( )

virtual

Topology Geometry and Attribute arrays smaller than this are written in line into the XML.

Default is 100. Node: LightDataLimit is forced to 1 when MeshStaticOverTime is TRUE.

◆ SetWriteAllTimeSteps()

virtual void vtkXdmfWriter::SetWriteAllTimeSteps ( int )

virtual

Controls whether writer automatically writes all input time steps, or just the timestep that is currently on the input.

Default is OFF.

◆ GetWriteAllTimeSteps()

virtual int vtkXdmfWriter::GetWriteAllTimeSteps ( )

virtual

Controls whether writer automatically writes all input time steps, or just the timestep that is currently on the input.

Default is OFF.

◆ WriteAllTimeStepsOn()

virtual void vtkXdmfWriter::WriteAllTimeStepsOn ( )

virtual

Controls whether writer automatically writes all input time steps, or just the timestep that is currently on the input.

Default is OFF.

◆ WriteAllTimeStepsOff()

virtual void vtkXdmfWriter::WriteAllTimeStepsOff ( )

virtual

Controls whether writer automatically writes all input time steps, or just the timestep that is currently on the input.

Default is OFF.

◆ SetMeshStaticOverTime()

virtual void vtkXdmfWriter::SetMeshStaticOverTime ( bool )

virtual

Set of get the flag that specify if input mesh is static over time.

If so, the mesh topology and geometry heavy data will be written only once. Default if FALSE. Note: this mode requires that all data is dumped in the heavy data file.

◆ GetMeshStaticOverTime()

virtual bool vtkXdmfWriter::GetMeshStaticOverTime ( )

virtual

Set of get the flag that specify if input mesh is static over time.

If so, the mesh topology and geometry heavy data will be written only once. Default if FALSE. Note: this mode requires that all data is dumped in the heavy data file.

◆ MeshStaticOverTimeOn()

virtual void vtkXdmfWriter::MeshStaticOverTimeOn ( )

virtual

Set of get the flag that specify if input mesh is static over time.

If so, the mesh topology and geometry heavy data will be written only once. Default if FALSE. Note: this mode requires that all data is dumped in the heavy data file.

◆ MeshStaticOverTimeOff()

virtual void vtkXdmfWriter::MeshStaticOverTimeOff ( )

virtual

Set of get the flag that specify if input mesh is static over time.

If so, the mesh topology and geometry heavy data will be written only once. Default if FALSE. Note: this mode requires that all data is dumped in the heavy data file.

◆ SetPiece()

virtual void vtkXdmfWriter::SetPiece ( int )

virtual

Called in parallel runs to identify the portion this process is responsible for TODO: respect this.

◆ SetNumberOfPieces()

virtual void vtkXdmfWriter::SetNumberOfPieces ( int )

virtual

Called in parallel runs to identify the portion this process is responsible for TODO: respect this.

◆ CreateDefaultExecutive()

vtkExecutive * vtkXdmfWriter::CreateDefaultExecutive ( )

overrideprotectedvirtual

Create a default executive.

If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). Otherwise, vtkStreamingDemandDrivenPipeline is created.

Reimplemented from vtkAlgorithm.

◆ FillInputPortInformation()

int vtkXdmfWriter::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 vtkDataObjectAlgorithm.

◆ RequestInformation()

int vtkXdmfWriter::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ RequestUpdateExtent()

int vtkXdmfWriter::RequestUpdateExtent	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkDataObjectAlgorithm.

◆ RequestData()

int vtkXdmfWriter::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ CreateTopology()

virtual int vtkXdmfWriter::CreateTopology	(	vtkDataSet *	ds,
		xdmf2::XdmfGrid *	grid,
		vtkIdType	PDims[3],
		vtkIdType	CDims[3],
		vtkIdType &	PRank,
		vtkIdType &	CRank,
		void *	staticdata
	)

protectedvirtual

◆ CreateGeometry()

virtual int vtkXdmfWriter::CreateGeometry	(	vtkDataSet *	ds,
		xdmf2::XdmfGrid *	grid,
		void *	staticdata
	)

protectedvirtual

◆ WriteDataSet()

virtual int vtkXdmfWriter::WriteDataSet	(	vtkDataObject *	dobj,
		xdmf2::XdmfGrid *	grid
	)

protectedvirtual

◆ WriteCompositeDataSet()

virtual int vtkXdmfWriter::WriteCompositeDataSet	(	vtkCompositeDataSet *	dobj,
		xdmf2::XdmfGrid *	grid
	)

protectedvirtual

◆ WriteAtomicDataSet()

virtual int vtkXdmfWriter::WriteAtomicDataSet	(	vtkDataObject *	dobj,
		xdmf2::XdmfGrid *	grid
	)

protectedvirtual

◆ WriteArrays()

virtual int vtkXdmfWriter::WriteArrays	(	vtkFieldData *	dsa,
		xdmf2::XdmfGrid *	grid,
		int	association,
		vtkIdType	rank,
		vtkIdType *	dims,
		const char *	name
	)

protectedvirtual

◆ ConvertVToXArray()

virtual void vtkXdmfWriter::ConvertVToXArray	(	vtkDataArray *	vda,
		xdmf2::XdmfArray *	xda,
		vtkIdType	rank,
		vtkIdType *	dims,
		int	AllocStrategy,
		const char *	heavyprefix
	)

protectedvirtual

◆ SetupDataArrayXML()

virtual void vtkXdmfWriter::SetupDataArrayXML	(	xdmf2::XdmfElement *	,
		xdmf2::XdmfArray *
	)		const

protectedvirtual

Member Data Documentation

◆ FileName

char* vtkXdmfWriter::FileName

protected

Definition at line 184 of file vtkXdmfWriter.h.

◆ HeavyDataFileName

char* vtkXdmfWriter::HeavyDataFileName

protected

Definition at line 185 of file vtkXdmfWriter.h.

◆ HeavyDataGroupName

char* vtkXdmfWriter::HeavyDataGroupName

protected

Definition at line 186 of file vtkXdmfWriter.h.

◆ WorkingDirectory

std::string vtkXdmfWriter::WorkingDirectory

protected

Definition at line 187 of file vtkXdmfWriter.h.

◆ BaseFileName

std::string vtkXdmfWriter::BaseFileName

protected

Definition at line 188 of file vtkXdmfWriter.h.

◆ LightDataLimit

int vtkXdmfWriter::LightDataLimit

protected

Definition at line 190 of file vtkXdmfWriter.h.

◆ WriteAllTimeSteps

int vtkXdmfWriter::WriteAllTimeSteps

protected

Definition at line 192 of file vtkXdmfWriter.h.

◆ NumberOfTimeSteps

int vtkXdmfWriter::NumberOfTimeSteps

protected

Definition at line 193 of file vtkXdmfWriter.h.

◆ CurrentTime

double vtkXdmfWriter::CurrentTime

protected

Definition at line 194 of file vtkXdmfWriter.h.

◆ CurrentTimeIndex

int vtkXdmfWriter::CurrentTimeIndex

protected

Definition at line 195 of file vtkXdmfWriter.h.

◆ CurrentBlockIndex

int vtkXdmfWriter::CurrentBlockIndex

protected

Definition at line 196 of file vtkXdmfWriter.h.

◆ UnlabelledDataArrayId

int vtkXdmfWriter::UnlabelledDataArrayId

protected

Definition at line 197 of file vtkXdmfWriter.h.

◆ Piece

int vtkXdmfWriter::Piece

protected

Definition at line 199 of file vtkXdmfWriter.h.

◆ NumberOfPieces

int vtkXdmfWriter::NumberOfPieces

protected

Definition at line 200 of file vtkXdmfWriter.h.

◆ MeshStaticOverTime

bool vtkXdmfWriter::MeshStaticOverTime

protected

Definition at line 202 of file vtkXdmfWriter.h.

◆ DOM

xdmf2::XdmfDOM* vtkXdmfWriter::DOM

protected

Definition at line 204 of file vtkXdmfWriter.h.

◆ TopTemporalGrid

xdmf2::XdmfGrid* vtkXdmfWriter::TopTemporalGrid

protected

Definition at line 205 of file vtkXdmfWriter.h.

◆ DomainMemoryHandler

vtkXdmfWriterDomainMemoryHandler* vtkXdmfWriter::DomainMemoryHandler

protected

Definition at line 207 of file vtkXdmfWriter.h.

◆ TopologyAtT0

std::vector<xdmf2::XdmfTopology*> vtkXdmfWriter::TopologyAtT0

protected

Definition at line 209 of file vtkXdmfWriter.h.

◆ GeometryAtT0

std::vector<xdmf2::XdmfGeometry*> vtkXdmfWriter::GeometryAtT0

protected

Definition at line 210 of file vtkXdmfWriter.h.

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

IO/Xdmf2/vtkXdmfWriter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkXdmfWriter()

◆ ~vtkXdmfWriter()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetInputData()

◆ vtkSetFilePathMacro() [1/2]

◆ vtkGetFilePathMacro() [1/2]

◆ vtkSetFilePathMacro() [2/2]

◆ vtkGetFilePathMacro() [2/2]

◆ SetHeavyDataGroupName()

◆ GetHeavyDataGroupName()

◆ Write()

◆ SetLightDataLimit()

◆ GetLightDataLimit()

◆ SetWriteAllTimeSteps()

◆ GetWriteAllTimeSteps()

◆ WriteAllTimeStepsOn()

◆ WriteAllTimeStepsOff()

◆ SetMeshStaticOverTime()

◆ GetMeshStaticOverTime()

◆ MeshStaticOverTimeOn()

◆ MeshStaticOverTimeOff()

◆ SetPiece()

◆ SetNumberOfPieces()

◆ CreateDefaultExecutive()

◆ FillInputPortInformation()

◆ RequestInformation()

◆ RequestUpdateExtent()

◆ RequestData()

◆ CreateTopology()

◆ CreateGeometry()

◆ WriteDataSet()

◆ WriteCompositeDataSet()

◆ WriteAtomicDataSet()

◆ WriteArrays()

◆ ConvertVToXArray()

◆ SetupDataArrayXML()

Member Data Documentation

◆ FileName

◆ HeavyDataFileName

◆ HeavyDataGroupName

◆ WorkingDirectory

◆ BaseFileName

◆ LightDataLimit

◆ WriteAllTimeSteps

◆ NumberOfTimeSteps

◆ CurrentTime

◆ CurrentTimeIndex

◆ CurrentBlockIndex

◆ UnlabelledDataArrayId

◆ Piece

◆ NumberOfPieces

◆ MeshStaticOverTime

◆ DOM

◆ TopTemporalGrid

◆ DomainMemoryHandler

◆ TopologyAtT0

◆ GeometryAtT0