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

redistributes input dataset into requested number of partitions More...

#include <vtkRedistributeDataSetFilter.h>

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

Public Types

enum  BoundaryModes { ASSIGN_TO_ONE_REGION = 0, ASSIGN_TO_ALL_INTERSECTING_REGIONS = 1, SPLIT_BOUNDARY_CELLS = 2 }
 
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...
 
vtkRedistributeDataSetFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetController (vtkMultiProcessController *)
 Get/Set the controller to use. More...
 
virtual vtkMultiProcessControllerGetController ()
 
virtual void SetBoundaryMode (int)
 Specify how cells on the boundaries are handled. More...
 
virtual int GetBoundaryMode ()
 
void SetBoundaryModeToAssignToOneRegion ()
 
void SetBoundaryModeToAssignToAllIntersectingRegions ()
 
void SetBoundaryModeToSplitBoundaryCells ()
 
virtual void SetUseExplicitCuts (bool)
 Specify whether to compute the load balancing automatically or use explicitly provided cuts. More...
 
virtual bool GetUseExplicitCuts ()
 
virtual void UseExplicitCutsOn ()
 
virtual void UseExplicitCutsOff ()
 
void SetExplicitCuts (const std::vector< vtkBoundingBox > &boxes)
 Specify the cuts to use when UseExplicitCuts is true. More...
 
const std::vector< vtkBoundingBox > & GetExplicitCuts () const
 
void RemoveAllExplicitCuts ()
 
void AddExplicitCut (const vtkBoundingBox &bbox)
 
void AddExplicitCut (const double bbox[6])
 
int GetNumberOfExplicitCuts () const
 
const vtkBoundingBoxGetExplicitCut (int index) const
 
virtual void SetExpandExplicitCuts (bool)
 When using explicit cuts, it possible that the bounding box defined by all the cuts is smaller than the input's bounds. More...
 
virtual bool GetExpandExplicitCuts ()
 
virtual void ExpandExplicitCutsOn ()
 
virtual void ExpandExplicitCutsOff ()
 
const std::vector< vtkBoundingBox > & GetCuts () const
 Returns the cuts used by the most recent RequestData call. More...
 
virtual void SetNumberOfPartitions (int)
 Specify the number of partitions to split the input dataset into. More...
 
virtual int GetNumberOfPartitions ()
 
virtual void SetPreservePartitionsInOutput (bool)
 When set to true (default is false), this filter will generate a vtkPartitionedDataSet as the output. More...
 
virtual bool GetPreservePartitionsInOutput ()
 
virtual void PreservePartitionsInOutputOn ()
 
virtual void PreservePartitionsInOutputOff ()
 
virtual void SetGenerateGlobalCellIds (bool)
 Generate global cell ids if none present in the input. More...
 
virtual bool GetGenerateGlobalCellIds ()
 
virtual void GenerateGlobalCellIdsOn ()
 
virtual void GenerateGlobalCellIdsOff ()
 
std::vector< vtkBoundingBoxExpandCuts (const std::vector< vtkBoundingBox > &cuts, const vtkBoundingBox &bounds)
 Helper function to expand a collection of bounding boxes to include the bounds specified. More...
 
virtual void SetEnableDebugging (bool)
 Enable/disable debugging mode. More...
 
virtual bool GetEnableDebugging ()
 
virtual void EnableDebuggingOn ()
 
virtual void EnableDebuggingOff ()
 
- 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 vtkRedistributeDataSetFilterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRedistributeDataSetFilterSafeDownCast (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
 
 vtkRedistributeDataSetFilter ()
 
 ~vtkRedistributeDataSetFilter () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 
virtual std::vector< vtkBoundingBoxGenerateCuts (vtkDataObject *data)
 This method is called to generate the partitions for the input dataset. More...
 
virtual vtkSmartPointer< vtkPartitionedDataSetSplitDataSet (vtkDataSet *dataset, const std::vector< vtkBoundingBox > &cuts)
 This method is called to split a vtkDataSet into multiple datasets by the vector of vtkBoundingBox passed in. More...
 
- Protected Member Functions inherited from vtkDataObjectAlgorithm
 vtkDataObjectAlgorithm ()
 
 ~vtkDataObjectAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (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 vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. 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 &)
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- 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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

redistributes input dataset into requested number of partitions

vtkRedistributeDataSetFilter is intended for redistributing data in a load balanced fashion. The load balancing attempts to balance the number of cells per target partition approximately. It uses a DIY-based kdtree implementation that builds balances the cell centers among requested number of partitions. Current implementation only supports power-of-2 target partition. If a non-power of two value is specified for NumberOfPartitions, then the load balancing simply uses the power-of-two greater than the requested value. The bounding boxes for the kdtree leaf nodes are then used to redistribute the data.

Alternatively a collection of bounding boxes may be provided that can be used to distribute the data instead of computing them (see UseExplicitCuts and SetExplicitCuts). When explicit cuts are specified, it is possible use those cuts strictly or to expand boxes on the edge to fit the domain of the input dataset. This can be controlled by ExpandExplicitCutsForInputDomain.

The filter allows users to pick how cells along the boundary of the cuts either automatically generated or explicitly specified are to be distributed using BoundaryMode. One can choose to assign those cells uniquely to one of those regions or duplicate then on all regions or split the cells (using vtkTableBasedClipDataSet filter). When cells are duplicated along the boundary, the filter will mark the duplicated cells as vtkDataSetAttributes::DUPLICATECELL correctly on all but one of the partitions using the ghost cell array (

See also
vtkDataSetAttributes::GhostArrayName).

Besides redistributing the data, the filter can optionally generate global cell ids. This is provided since it relative easy to generate these on when it is known that the data is spatially partitioned as is the case after this filter has executed.

Definition at line 64 of file vtkRedistributeDataSetFilter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 68 of file vtkRedistributeDataSetFilter.h.

Member Enumeration Documentation

◆ BoundaryModes

Enumerator
ASSIGN_TO_ONE_REGION 
ASSIGN_TO_ALL_INTERSECTING_REGIONS 
SPLIT_BOUNDARY_CELLS 

Definition at line 80 of file vtkRedistributeDataSetFilter.h.

Constructor & Destructor Documentation

◆ vtkRedistributeDataSetFilter()

vtkRedistributeDataSetFilter::vtkRedistributeDataSetFilter ( )
protected

◆ ~vtkRedistributeDataSetFilter()

vtkRedistributeDataSetFilter::~vtkRedistributeDataSetFilter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkRedistributeDataSetFilter* vtkRedistributeDataSetFilter::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkRedistributeDataSetFilter::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 vtkRedistributeDataSetFilter* vtkRedistributeDataSetFilter::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRedistributeDataSetFilter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ NewInstance()

vtkRedistributeDataSetFilter* vtkRedistributeDataSetFilter::NewInstance ( ) const

◆ PrintSelf()

void vtkRedistributeDataSetFilter::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.

◆ SetController()

void vtkRedistributeDataSetFilter::SetController ( vtkMultiProcessController )

Get/Set the controller to use.

By default vtkMultiProcessController::GlobalController will be used.

◆ GetController()

virtual vtkMultiProcessController* vtkRedistributeDataSetFilter::GetController ( )
virtual

◆ SetBoundaryMode()

virtual void vtkRedistributeDataSetFilter::SetBoundaryMode ( int  )
virtual

Specify how cells on the boundaries are handled.

  • ASSIGN_TO_ONE_REGION results in a cell on the boundary uniquely added to one of the ranks containing the region intersecting the cell.
  • ASSIGN_TO_ALL_INTERSECTING_REGIONS results in a cell on the boundary added to all ranks containing the region intersecting the cell.
  • SPLIT_BOUNDARY_CELLS results in cells along the boundary being clipped along the region boundaries.

Default is ASSIGN_TO_ONE_REGION.

◆ GetBoundaryMode()

virtual int vtkRedistributeDataSetFilter::GetBoundaryMode ( )
virtual

◆ SetBoundaryModeToAssignToOneRegion()

void vtkRedistributeDataSetFilter::SetBoundaryModeToAssignToOneRegion ( )
inline

Definition at line 102 of file vtkRedistributeDataSetFilter.h.

◆ SetBoundaryModeToAssignToAllIntersectingRegions()

void vtkRedistributeDataSetFilter::SetBoundaryModeToAssignToAllIntersectingRegions ( )
inline

Definition at line 103 of file vtkRedistributeDataSetFilter.h.

◆ SetBoundaryModeToSplitBoundaryCells()

void vtkRedistributeDataSetFilter::SetBoundaryModeToSplitBoundaryCells ( )
inline

Definition at line 107 of file vtkRedistributeDataSetFilter.h.

◆ SetUseExplicitCuts()

virtual void vtkRedistributeDataSetFilter::SetUseExplicitCuts ( bool  )
virtual

Specify whether to compute the load balancing automatically or use explicitly provided cuts.

Set to false (default) to automatically compute the cuts to use for redistributing the dataset.

◆ GetUseExplicitCuts()

virtual bool vtkRedistributeDataSetFilter::GetUseExplicitCuts ( )
virtual

◆ UseExplicitCutsOn()

virtual void vtkRedistributeDataSetFilter::UseExplicitCutsOn ( )
virtual

◆ UseExplicitCutsOff()

virtual void vtkRedistributeDataSetFilter::UseExplicitCutsOff ( )
virtual

◆ SetExplicitCuts()

void vtkRedistributeDataSetFilter::SetExplicitCuts ( const std::vector< vtkBoundingBox > &  boxes)

Specify the cuts to use when UseExplicitCuts is true.

◆ GetExplicitCuts()

const std::vector<vtkBoundingBox>& vtkRedistributeDataSetFilter::GetExplicitCuts ( ) const
inline

Definition at line 126 of file vtkRedistributeDataSetFilter.h.

◆ RemoveAllExplicitCuts()

void vtkRedistributeDataSetFilter::RemoveAllExplicitCuts ( )

◆ AddExplicitCut() [1/2]

void vtkRedistributeDataSetFilter::AddExplicitCut ( const vtkBoundingBox bbox)

◆ AddExplicitCut() [2/2]

void vtkRedistributeDataSetFilter::AddExplicitCut ( const double  bbox[6])

◆ GetNumberOfExplicitCuts()

int vtkRedistributeDataSetFilter::GetNumberOfExplicitCuts ( ) const

◆ GetExplicitCut()

const vtkBoundingBox& vtkRedistributeDataSetFilter::GetExplicitCut ( int  index) const

◆ SetExpandExplicitCuts()

virtual void vtkRedistributeDataSetFilter::SetExpandExplicitCuts ( bool  )
virtual

When using explicit cuts, it possible that the bounding box defined by all the cuts is smaller than the input's bounds.

In that case, the filter can automatically expand the edge boxes to include the input bounds to avoid clipping of the input dataset on the external faces of the combined bounding box.

Default is true, that is explicit cuts will automatically be expanded.

◆ GetExpandExplicitCuts()

virtual bool vtkRedistributeDataSetFilter::GetExpandExplicitCuts ( )
virtual

◆ ExpandExplicitCutsOn()

virtual void vtkRedistributeDataSetFilter::ExpandExplicitCutsOn ( )
virtual

◆ ExpandExplicitCutsOff()

virtual void vtkRedistributeDataSetFilter::ExpandExplicitCutsOff ( )
virtual

◆ GetCuts()

const std::vector<vtkBoundingBox>& vtkRedistributeDataSetFilter::GetCuts ( ) const
inline

Returns the cuts used by the most recent RequestData call.

This is only valid after a successful Update request.

Definition at line 155 of file vtkRedistributeDataSetFilter.h.

◆ SetNumberOfPartitions()

virtual void vtkRedistributeDataSetFilter::SetNumberOfPartitions ( int  )
virtual

Specify the number of partitions to split the input dataset into.

Set to 0 to indicate that the partitions should match the number of ranks (processes) determined using vtkMultiProcessController provided. Setting to a non-zero positive number will result in the filter generating at least as many partitions.

This is simply a hint and not an exact number of partitions the data will be split into. Current implementation results in number of partitions equal to the power of 2 greater than or equal to the chosen value.

Default is 0.

This has no effect when UseExplicitCuts is set to true. In that case, the number of partitions is dictated by the number of cuts provided.

See also
PreservePartitionsInOutput, UseExplicitCuts

◆ GetNumberOfPartitions()

virtual int vtkRedistributeDataSetFilter::GetNumberOfPartitions ( )
virtual

◆ SetPreservePartitionsInOutput()

virtual void vtkRedistributeDataSetFilter::SetPreservePartitionsInOutput ( bool  )
virtual

When set to true (default is false), this filter will generate a vtkPartitionedDataSet as the output.

The advantage of doing that is each partition that the input dataset was split into can be individually accessed. Otherwise, when the number of partitions generated is greater than the number of ranks, a rank with more than one partition will use vtkAppendFilter to merge the multiple partitions into a single unstructured grid.

The output dataset type is always vtkUnstructuredGrid when PreservePartitionsInOutput is false and always a vtkPartitionedDataSet when PreservePartitionsInOutput is true.

Default is false i.e. the filter will generate a single vtkUnstructuredGrid.

◆ GetPreservePartitionsInOutput()

virtual bool vtkRedistributeDataSetFilter::GetPreservePartitionsInOutput ( )
virtual

◆ PreservePartitionsInOutputOn()

virtual void vtkRedistributeDataSetFilter::PreservePartitionsInOutputOn ( )
virtual

◆ PreservePartitionsInOutputOff()

virtual void vtkRedistributeDataSetFilter::PreservePartitionsInOutputOff ( )
virtual

◆ SetGenerateGlobalCellIds()

virtual void vtkRedistributeDataSetFilter::SetGenerateGlobalCellIds ( bool  )
virtual

Generate global cell ids if none present in the input.

If global cell ids are present in the input then this flag is ignored. Default is true.

◆ GetGenerateGlobalCellIds()

virtual bool vtkRedistributeDataSetFilter::GetGenerateGlobalCellIds ( )
virtual

◆ GenerateGlobalCellIdsOn()

virtual void vtkRedistributeDataSetFilter::GenerateGlobalCellIdsOn ( )
virtual

◆ GenerateGlobalCellIdsOff()

virtual void vtkRedistributeDataSetFilter::GenerateGlobalCellIdsOff ( )
virtual

◆ ExpandCuts()

std::vector<vtkBoundingBox> vtkRedistributeDataSetFilter::ExpandCuts ( const std::vector< vtkBoundingBox > &  cuts,
const vtkBoundingBox bounds 
)

Helper function to expand a collection of bounding boxes to include the bounds specified.

This will expand any boxes in the cuts that abut any of the external faces of the bounding box formed by all the cuts to touch the external faces of the bounds.

◆ SetEnableDebugging()

virtual void vtkRedistributeDataSetFilter::SetEnableDebugging ( bool  )
virtual

Enable/disable debugging mode.

In this mode internal arrays are preserved and ghost cells are not explicitly marked as such so that they can be inspected without risk of being dropped or removed by the pipeline.

Default is false.

◆ GetEnableDebugging()

virtual bool vtkRedistributeDataSetFilter::GetEnableDebugging ( )
virtual

◆ EnableDebuggingOn()

virtual void vtkRedistributeDataSetFilter::EnableDebuggingOn ( )
virtual

◆ EnableDebuggingOff()

virtual void vtkRedistributeDataSetFilter::EnableDebuggingOff ( )
virtual

◆ FillInputPortInformation()

int vtkRedistributeDataSetFilter::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.

◆ RequestDataObject()

int vtkRedistributeDataSetFilter::RequestDataObject ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkDataObjectAlgorithm.

◆ RequestData()

int vtkRedistributeDataSetFilter::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ GenerateCuts()

virtual std::vector<vtkBoundingBox> vtkRedistributeDataSetFilter::GenerateCuts ( vtkDataObject data)
protectedvirtual

This method is called to generate the partitions for the input dataset.

Subclasses should override this to generate partitions using preferred data redistribution strategy.

The data will either be a vtkPartitionedDataSet or a vtkDataSet. In case of vtkPartitionedDataSet, the method is expected to redistribute all datasets (partitions) in the vtkPartitionedDataSet taken as a whole.

◆ SplitDataSet()

virtual vtkSmartPointer<vtkPartitionedDataSet> vtkRedistributeDataSetFilter::SplitDataSet ( vtkDataSet dataset,
const std::vector< vtkBoundingBox > &  cuts 
)
protectedvirtual

This method is called to split a vtkDataSet into multiple datasets by the vector of vtkBoundingBox passed in.

The returned vtkPartitionedDataSet must have exactly as many partitions as the number of vtkBoundingBoxes in the cuts vector with each partition matching the bounding box at the matching index.

Note, this method duplicates cells that lie on the boundaries and adds cell arrays that indicate cell ownership and flags boundary cells.


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