VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkXdmfWriter Class Reference

write eXtensible Data Model and Format files More...

#include <vtkXdmfWriter.h>

Inheritance diagram for vtkXdmfWriter:
[legend]
Collaboration diagram for vtkXdmfWriter:
[legend]

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. More...
 
vtkXdmfWriterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetInputData (vtkDataObject *dobj)
 Set the input data set. More...
 
virtual void SetFileName (const char *)
 Set or get the file name of the xdmf file. More...
 
virtual char * GetFileName ()
 
virtual void SetHeavyDataFileName (const char *)
 Set or get the file name of the hdf5 file. More...
 
virtual char * GetHeavyDataFileName ()
 
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". More...
 
virtual char * GetHeavyDataGroupName ()
 
virtual int Write ()
 Write data to output. More...
 
virtual void SetLightDataLimit (int)
 Topology Geometry and Attribute arrays smaller than this are written in line into the XML. More...
 
virtual int GetLightDataLimit ()
 
virtual void SetWriteAllTimeSteps (int)
 Controls whether writer automatically writes all input time steps, or just the timestep that is currently on the input. More...
 
virtual int GetWriteAllTimeSteps ()
 
virtual void WriteAllTimeStepsOn ()
 
virtual void WriteAllTimeStepsOff ()
 
virtual void SetMeshStaticOverTime (bool)
 Set of get the flag that specify if input mesh is static over time. More...
 
virtual bool GetMeshStaticOverTime ()
 
virtual void MeshStaticOverTimeOn ()
 
virtual void MeshStaticOverTimeOff ()
 
virtual void SetPiece (int)
 Called in parallel runs to identify the portion this process is responsible for TODO: respect this. More...
 
virtual void SetNumberOfPieces (int)
 
- Public Member Functions inherited from vtkDataObjectAlgorithm
vtkDataObjectAlgorithmNewInstance () const
 
vtkDataObjectGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkDataObjectGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
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). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkXdmfWriterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXdmfWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkDataObjectAlgorithm
static vtkDataObjectAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXdmfWriter ()
 
 ~vtkXdmfWriter () override
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 
int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
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
 vtkDataObjectAlgorithm ()
 
 ~vtkDataObjectAlgorithm () override
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
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. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 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
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- 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 vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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.

Tests:
vtkXdmfWriter (Tests)

Definition at line 60 of file vtkXdmfWriter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 64 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.

◆ SetFileName()

virtual void vtkXdmfWriter::SetFileName ( const char *  )
virtual

Set or get the file name of the xdmf file.

◆ GetFileName()

virtual char* vtkXdmfWriter::GetFileName ( )
virtual

◆ SetHeavyDataFileName()

virtual void vtkXdmfWriter::SetHeavyDataFileName ( const char *  )
virtual

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

◆ GetHeavyDataFileName()

virtual char* vtkXdmfWriter::GetHeavyDataFileName ( )
virtual

◆ 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

◆ 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

◆ 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

◆ WriteAllTimeStepsOn()

virtual void vtkXdmfWriter::WriteAllTimeStepsOn ( )
virtual

◆ WriteAllTimeStepsOff()

virtual void vtkXdmfWriter::WriteAllTimeStepsOff ( )
virtual

◆ 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

◆ MeshStaticOverTimeOn()

virtual void vtkXdmfWriter::MeshStaticOverTimeOn ( )
virtual

◆ MeshStaticOverTimeOff()

virtual void vtkXdmfWriter::MeshStaticOverTimeOff ( )
virtual

◆ 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

◆ 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 193 of file vtkXdmfWriter.h.

◆ HeavyDataFileName

char* vtkXdmfWriter::HeavyDataFileName
protected

Definition at line 194 of file vtkXdmfWriter.h.

◆ HeavyDataGroupName

char* vtkXdmfWriter::HeavyDataGroupName
protected

Definition at line 195 of file vtkXdmfWriter.h.

◆ WorkingDirectory

std::string vtkXdmfWriter::WorkingDirectory
protected

Definition at line 196 of file vtkXdmfWriter.h.

◆ BaseFileName

std::string vtkXdmfWriter::BaseFileName
protected

Definition at line 197 of file vtkXdmfWriter.h.

◆ LightDataLimit

int vtkXdmfWriter::LightDataLimit
protected

Definition at line 199 of file vtkXdmfWriter.h.

◆ WriteAllTimeSteps

int vtkXdmfWriter::WriteAllTimeSteps
protected

Definition at line 201 of file vtkXdmfWriter.h.

◆ NumberOfTimeSteps

int vtkXdmfWriter::NumberOfTimeSteps
protected

Definition at line 202 of file vtkXdmfWriter.h.

◆ CurrentTime

double vtkXdmfWriter::CurrentTime
protected

Definition at line 203 of file vtkXdmfWriter.h.

◆ CurrentTimeIndex

int vtkXdmfWriter::CurrentTimeIndex
protected

Definition at line 204 of file vtkXdmfWriter.h.

◆ CurrentBlockIndex

int vtkXdmfWriter::CurrentBlockIndex
protected

Definition at line 205 of file vtkXdmfWriter.h.

◆ UnlabelledDataArrayId

int vtkXdmfWriter::UnlabelledDataArrayId
protected

Definition at line 206 of file vtkXdmfWriter.h.

◆ Piece

int vtkXdmfWriter::Piece
protected

Definition at line 208 of file vtkXdmfWriter.h.

◆ NumberOfPieces

int vtkXdmfWriter::NumberOfPieces
protected

Definition at line 209 of file vtkXdmfWriter.h.

◆ MeshStaticOverTime

bool vtkXdmfWriter::MeshStaticOverTime
protected

Definition at line 211 of file vtkXdmfWriter.h.

◆ DOM

xdmf2::XdmfDOM* vtkXdmfWriter::DOM
protected

Definition at line 213 of file vtkXdmfWriter.h.

◆ TopTemporalGrid

xdmf2::XdmfGrid* vtkXdmfWriter::TopTemporalGrid
protected

Definition at line 214 of file vtkXdmfWriter.h.

◆ DomainMemoryHandler

vtkXdmfWriterDomainMemoryHandler* vtkXdmfWriter::DomainMemoryHandler
protected

Definition at line 216 of file vtkXdmfWriter.h.

◆ TopologyAtT0

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

Definition at line 218 of file vtkXdmfWriter.h.

◆ GeometryAtT0

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

Definition at line 219 of file vtkXdmfWriter.h.


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