Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkParallelSerialWriter Class Reference

parallel meta-writer for serial formats More...

#include <vtkParallelSerialWriter.h>

Inheritance diagram for vtkParallelSerialWriter:
Inheritance graph
[legend]
Collaboration diagram for vtkParallelSerialWriter:
Collaboration graph
[legend]

Public Types

enum  { ASSIGNMENT_MODE_CONTIGUOUS, ASSIGNMENT_MODE_ROUND_ROBIN }
 
typedef vtkDataObjectAlgorithm Superclass
 
- Public Types inherited from vtkDataObjectAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision
 
enum  DesiredOutputPrecision
 
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
vtkMTimeType GetMTime () override
 Return the MTime also considering the internal writer. More...
 
int Write ()
 Invoke the writer. More...
 
void SetInterpreter (vtkClientServerInterpreter *interp)
 Get/Set the interpreter to use to call methods on the writer. More...
 
void SetWriter (vtkAlgorithm *)
 Set/get the internal writer. More...
 
virtual vtkAlgorithmGetWriter ()
 Set/get the internal writer. More...
 
virtual void SetFileNameMethod (const char *)
 Name of the method used to set the file name of the internal writer. More...
 
virtual char * GetFileNameMethod ()
 Name of the method used to set the file name of the internal writer. More...
 
virtual void SetFileName (const char *)
 Get/Set the name of the output file. More...
 
virtual char * GetFileName ()
 Get/Set the name of the output file. More...
 
virtual int GetPiece ()
 Get/Set the piece number to write. More...
 
virtual void SetPiece (int)
 Get/Set the piece number to write. More...
 
virtual int GetNumberOfPieces ()
 Get/Set the number of pieces into which the inputs are split. More...
 
virtual void SetNumberOfPieces (int)
 Get/Set the number of pieces into which the inputs are split. More...
 
virtual int GetGhostLevel ()
 Get/Set the number of ghost levels to be written. More...
 
virtual void SetGhostLevel (int)
 Get/Set the number of ghost levels to be written. More...
 
void SetPreGatherHelper (vtkAlgorithm *)
 Get/Set the pre-reduction helper. More...
 
virtual vtkAlgorithmGetPreGatherHelper ()
 Get/Set the pre-reduction helper. More...
 
void SetPostGatherHelper (vtkAlgorithm *)
 Get/Set the reduction helper. More...
 
virtual vtkAlgorithmGetPostGatherHelper ()
 Get/Set the reduction helper. More...
 
virtual int GetWriteAllTimeSteps ()
 Must be set to true to write all timesteps, otherwise only the current timestep will be written out. More...
 
virtual void SetWriteAllTimeSteps (int)
 Must be set to true to write all timesteps, otherwise only the current timestep will be written out. More...
 
virtual void WriteAllTimeStepsOn ()
 Must be set to true to write all timesteps, otherwise only the current timestep will be written out. More...
 
virtual void WriteAllTimeStepsOff ()
 Must be set to true to write all timesteps, otherwise only the current timestep will be written out. More...
 
virtual char * GetFileNameSuffix ()
 Provides an option to pad the time step when writing out time series data. More...
 
virtual void SetFileNameSuffix (const char *)
 Provides an option to pad the time step when writing out time series data. More...
 
virtual void SetNumberOfIORanks (int)
 In parallel runs, this writer can consolidate output from multiple ranks to a subset of ranks. More...
 
virtual int GetNumberOfIORanks ()
 In parallel runs, this writer can consolidate output from multiple ranks to a subset of ranks. More...
 
virtual void SetRankAssignmentMode (int)
 When NumberOfIORanks is greater than 1 and less than the number of MPI ranks, this controls how the ranks that write to disk are determined. More...
 
virtual int GetRankAssignmentMode ()
 When NumberOfIORanks is greater than 1 and less than the number of MPI ranks, this controls how the ranks that write to disk are determined. More...
 
void SetController (vtkMultiProcessController *controller)
 Get/Set the controller to use. More...
 
virtual vtkMultiProcessControllerGetController ()
 Get/Set the controller to use. More...
 
- Public Member Functions inherited from vtkDataObjectAlgorithm
vtkDataObjectAlgorithmNewInstance () const
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkDataObjectGetOutput ()
 
vtkDataObjectGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 
void AddInputData (int, vtkDataObject *)
 
vtkDataObjectGetOutput ()
 
vtkDataObjectGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformationGetInputPortInformation (int port)
 
vtkInformationGetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformationGetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformationGetInputInformation (int port, int index)
 
vtkInformationGetOutputInformation (int port)
 
virtual int Update (int port, vtkInformationVector *requests)
 
virtual int Update (vtkInformation *requests)
 
virtual int UpdateExtent (const int extents[6])
 
virtual void UpdateInformation ()
 
virtual void UpdateDataObject ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
void SetUpdateExtent (int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
void Register (vtkObjectBase *o) VTK_OVERRIDE
 
void UnRegister (vtkObjectBase *o) VTK_OVERRIDE
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
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)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformationGetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
intGetUpdateExtent ()
 
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 ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 
virtual vtkProgressObserverGetProgressObserver ()
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
void Register (vtkObjectBase *o) VTK_OVERRIDE
 
void UnRegister (vtkObjectBase *o) VTK_OVERRIDE
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
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)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformationGetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
intGetUpdateExtent ()
 
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 ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int 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)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkParallelSerialWriterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkParallelSerialWriterSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkDataObjectAlgorithm
static vtkDataObjectAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObjectAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
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 ()
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkParallelSerialWriter ()
 
 ~vtkParallelSerialWriter () override
 
int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
- Protected Member Functions inherited from vtkDataObjectAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataObjectAlgorithm ()
 
 ~vtkDataObjectAlgorithm ()
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutiveCreateDefaultExecutive ()
 
void ReportReferences (vtkGarbageCollector *) VTK_OVERRIDE
 
virtual void SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
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)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
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)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
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)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
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)
 
virtual void SetErrorCode (unsigned long)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
 SINGLE_PRECISION
 
 DOUBLE_PRECISION
 
 DEFAULT_PRECISION
 
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

parallel meta-writer for serial formats

vtkParallelSerialWriter is a meta-writer that enables serial writers to work in parallel. By default, it gathers data to the 1st node (root node) and invokes the internal writer. The reduction is controlled by the PreGatherHelper and PostGatherHelper. Instead of collecting all the data to the root node the filter supports reducing down to a target number of ranks which ranks chosen in either round-robin or contiguous fashion.

This also makes it possible to write time-series for temporal datasets using simple non-time-aware writers.

Definition at line 42 of file vtkParallelSerialWriter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 of file vtkParallelSerialWriter.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
ASSIGNMENT_MODE_CONTIGUOUS 
ASSIGNMENT_MODE_ROUND_ROBIN 

Definition at line 168 of file vtkParallelSerialWriter.h.

Constructor & Destructor Documentation

◆ vtkParallelSerialWriter()

vtkParallelSerialWriter::vtkParallelSerialWriter ( )
protected

◆ ~vtkParallelSerialWriter()

vtkParallelSerialWriter::~vtkParallelSerialWriter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkParallelSerialWriter* vtkParallelSerialWriter::New ( )
static

◆ GetClassName()

virtual const char* vtkParallelSerialWriter::GetClassName ( )
virtual

◆ IsTypeOf()

static int vtkParallelSerialWriter::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkParallelSerialWriter::IsA ( const char *  type)
virtual

Reimplemented from vtkDataObjectAlgorithm.

◆ SafeDownCast()

static vtkParallelSerialWriter* vtkParallelSerialWriter::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

void vtkParallelSerialWriter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ SetWriter()

void vtkParallelSerialWriter::SetWriter ( vtkAlgorithm )

Set/get the internal writer.

◆ GetWriter()

virtual vtkAlgorithm* vtkParallelSerialWriter::GetWriter ( )
virtual

Set/get the internal writer.

◆ GetMTime()

vtkMTimeType vtkParallelSerialWriter::GetMTime ( )
overridevirtual

Return the MTime also considering the internal writer.

Reimplemented from vtkObject.

◆ SetFileNameMethod()

virtual void vtkParallelSerialWriter::SetFileNameMethod ( const char *  )
virtual

Name of the method used to set the file name of the internal writer.

By default, this is SetFileName.

◆ GetFileNameMethod()

virtual char* vtkParallelSerialWriter::GetFileNameMethod ( )
virtual

Name of the method used to set the file name of the internal writer.

By default, this is SetFileName.

◆ SetFileName()

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

Get/Set the name of the output file.

◆ GetFileName()

virtual char* vtkParallelSerialWriter::GetFileName ( )
virtual

Get/Set the name of the output file.

◆ Write()

int vtkParallelSerialWriter::Write ( )

Invoke the writer.

Returns 1 for success, 0 for failure.

◆ GetPiece()

virtual int vtkParallelSerialWriter::GetPiece ( )
virtual

Get/Set the piece number to write.

The same piece number is used for all inputs.

◆ SetPiece()

virtual void vtkParallelSerialWriter::SetPiece ( int  )
virtual

Get/Set the piece number to write.

The same piece number is used for all inputs.

◆ GetNumberOfPieces()

virtual int vtkParallelSerialWriter::GetNumberOfPieces ( )
virtual

Get/Set the number of pieces into which the inputs are split.

◆ SetNumberOfPieces()

virtual void vtkParallelSerialWriter::SetNumberOfPieces ( int  )
virtual

Get/Set the number of pieces into which the inputs are split.

◆ GetGhostLevel()

virtual int vtkParallelSerialWriter::GetGhostLevel ( )
virtual

Get/Set the number of ghost levels to be written.

◆ SetGhostLevel()

virtual void vtkParallelSerialWriter::SetGhostLevel ( int  )
virtual

Get/Set the number of ghost levels to be written.

◆ SetPreGatherHelper()

void vtkParallelSerialWriter::SetPreGatherHelper ( vtkAlgorithm )

Get/Set the pre-reduction helper.

Pre-Reduction helper is an algorithm that runs on each node's data before it is sent to the root.

◆ GetPreGatherHelper()

virtual vtkAlgorithm* vtkParallelSerialWriter::GetPreGatherHelper ( )
virtual

Get/Set the pre-reduction helper.

Pre-Reduction helper is an algorithm that runs on each node's data before it is sent to the root.

◆ SetPostGatherHelper()

void vtkParallelSerialWriter::SetPostGatherHelper ( vtkAlgorithm )

Get/Set the reduction helper.

Reduction helper is an algorithm with multiple input connections, that produces a single output as the reduced output. This is run on the root node to produce a result from the gathered results of each node.

◆ GetPostGatherHelper()

virtual vtkAlgorithm* vtkParallelSerialWriter::GetPostGatherHelper ( )
virtual

Get/Set the reduction helper.

Reduction helper is an algorithm with multiple input connections, that produces a single output as the reduced output. This is run on the root node to produce a result from the gathered results of each node.

◆ GetWriteAllTimeSteps()

virtual int vtkParallelSerialWriter::GetWriteAllTimeSteps ( )
virtual

Must be set to true to write all timesteps, otherwise only the current timestep will be written out.

Off by default.

◆ SetWriteAllTimeSteps()

virtual void vtkParallelSerialWriter::SetWriteAllTimeSteps ( int  )
virtual

Must be set to true to write all timesteps, otherwise only the current timestep will be written out.

Off by default.

◆ WriteAllTimeStepsOn()

virtual void vtkParallelSerialWriter::WriteAllTimeStepsOn ( )
virtual

Must be set to true to write all timesteps, otherwise only the current timestep will be written out.

Off by default.

◆ WriteAllTimeStepsOff()

virtual void vtkParallelSerialWriter::WriteAllTimeStepsOff ( )
virtual

Must be set to true to write all timesteps, otherwise only the current timestep will be written out.

Off by default.

◆ SetInterpreter()

void vtkParallelSerialWriter::SetInterpreter ( vtkClientServerInterpreter interp)
inline

Get/Set the interpreter to use to call methods on the writer.

Definition at line 142 of file vtkParallelSerialWriter.h.

◆ GetFileNameSuffix()

virtual char* vtkParallelSerialWriter::GetFileNameSuffix ( )
virtual

Provides an option to pad the time step when writing out time series data.

Only allow this format: ABC%.Xd where ABC is an arbitrary string which may or may not exist and d must exist and d must be the last character '.' and X may or may not exist, X must be an integer if it exists. Default is nullptr.

◆ SetFileNameSuffix()

virtual void vtkParallelSerialWriter::SetFileNameSuffix ( const char *  )
virtual

Provides an option to pad the time step when writing out time series data.

Only allow this format: ABC%.Xd where ABC is an arbitrary string which may or may not exist and d must exist and d must be the last character '.' and X may or may not exist, X must be an integer if it exists. Default is nullptr.

◆ SetNumberOfIORanks()

virtual void vtkParallelSerialWriter::SetNumberOfIORanks ( int  )
virtual

In parallel runs, this writer can consolidate output from multiple ranks to a subset of ranks.

This specifies the number of ranks that will do the final writing to disk. If NumberOfIORanks is 0, then all ranks will save the local data. If set to 1 (default), the root node alone will write to disk. All data from all ranks will be gathered to the root node before being written out.

◆ GetNumberOfIORanks()

virtual int vtkParallelSerialWriter::GetNumberOfIORanks ( )
virtual

In parallel runs, this writer can consolidate output from multiple ranks to a subset of ranks.

This specifies the number of ranks that will do the final writing to disk. If NumberOfIORanks is 0, then all ranks will save the local data. If set to 1 (default), the root node alone will write to disk. All data from all ranks will be gathered to the root node before being written out.

◆ SetRankAssignmentMode()

virtual void vtkParallelSerialWriter::SetRankAssignmentMode ( int  )
virtual

When NumberOfIORanks is greater than 1 and less than the number of MPI ranks, this controls how the ranks that write to disk are determined.

This also affects which ranks send data to which rank for IO.

In ASSIGNMENT_MODE_CONTIGUOUS (default), all MPI ranks are numerically grouped into NumberOfIORanks groups with the first rank in each group acting as the root node for that group and is the one that does IO. For example, if there are 16 MPI ranks and NumberOfIORanks is set to 3 then the groups are [0 - 5], [6 - 10], [11 - 15] with the first rank in each group 0, 6, and 15 doing the IO.

In ASSIGNMENT_MODE_ROUND_ROBIN, the grouping is done in round robin fashion, thus for 16 MPI ranks with NumberOfIORanks set to 3, the groups are [0, 3, ..., 15], [1, 4, ..., 13], [2, 5, ..., 14] with 0, 1 and 2 doing the IO.

◆ GetRankAssignmentMode()

virtual int vtkParallelSerialWriter::GetRankAssignmentMode ( )
virtual

When NumberOfIORanks is greater than 1 and less than the number of MPI ranks, this controls how the ranks that write to disk are determined.

This also affects which ranks send data to which rank for IO.

In ASSIGNMENT_MODE_CONTIGUOUS (default), all MPI ranks are numerically grouped into NumberOfIORanks groups with the first rank in each group acting as the root node for that group and is the one that does IO. For example, if there are 16 MPI ranks and NumberOfIORanks is set to 3 then the groups are [0 - 5], [6 - 10], [11 - 15] with the first rank in each group 0, 6, and 15 doing the IO.

In ASSIGNMENT_MODE_ROUND_ROBIN, the grouping is done in round robin fashion, thus for 16 MPI ranks with NumberOfIORanks set to 3, the groups are [0, 3, ..., 15], [1, 4, ..., 13], [2, 5, ..., 14] with 0, 1 and 2 doing the IO.

◆ SetController()

void vtkParallelSerialWriter::SetController ( vtkMultiProcessController controller)

Get/Set the controller to use.

By default initialized to vtkMultiProcessController::GetGlobalController in the constructor.

◆ GetController()

virtual vtkMultiProcessController* vtkParallelSerialWriter::GetController ( )
virtual

Get/Set the controller to use.

By default initialized to vtkMultiProcessController::GetGlobalController in the constructor.

◆ RequestInformation()

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

Reimplemented from vtkDataObjectAlgorithm.

◆ RequestUpdateExtent()

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

Reimplemented from vtkDataObjectAlgorithm.

◆ RequestData()

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

Reimplemented from vtkDataObjectAlgorithm.


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