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

Serial stand-in for parallel filter that distributes data among processors. More...

#include <vtkDistributedDataFilter.h>

Inheritance diagram for vtkDistributedDataFilter:
[legend]
Collaboration diagram for vtkDistributedDataFilter:
[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...
 
vtkDistributedDataFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetController (vtkMultiProcessController *c)
 Set/Get the communicator object. More...
 
virtual vtkMultiProcessControllerGetController ()
 
vtkPKdTreeGetKdtree ()
 Get a pointer to the parallel k-d tree object. More...
 
virtual void RetainKdtreeOn ()
 When this filter executes, it creates a vtkPKdTree (K-d tree) data structure in parallel which divides the total distributed data set into spatial regions. More...
 
virtual void RetainKdtreeOff ()
 
virtual int GetRetainKdtree ()
 
virtual void SetRetainKdtree (int)
 
virtual void IncludeAllIntersectingCellsOn ()
 Each cell in the data set is associated with one of the spatial regions of the k-d tree decomposition. More...
 
virtual void IncludeAllIntersectingCellsOff ()
 
virtual int GetIncludeAllIntersectingCells ()
 
virtual void SetIncludeAllIntersectingCells (int)
 
virtual void ClipCellsOn ()
 Set this variable if you want the cells of the output vtkUnstructuredGrid to be clipped to the spatial region boundaries. More...
 
virtual void ClipCellsOff ()
 
virtual int GetClipCells ()
 
virtual void SetClipCells (int)
 
void SetBoundaryMode (int mode)
 Handling of ClipCells and IncludeAllIntersectingCells. More...
 
void SetBoundaryModeToAssignToOneRegion ()
 
void SetBoundaryModeToAssignToAllIntersectingRegions ()
 
void SetBoundaryModeToSplitBoundaryCells ()
 
int GetBoundaryMode ()
 
int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Ensure previous filters don't send up ghost cells. More...
 
virtual void UseMinimalMemoryOn ()
 This class does a great deal of all-to-all communication when exchanging portions of data sets and building new sub grids. More...
 
virtual void UseMinimalMemoryOff ()
 
virtual int GetUseMinimalMemory ()
 
virtual void SetUseMinimalMemory (int)
 
virtual int GetMinimumGhostLevel ()
 The minimum number of ghost levels to add to each processor's output. More...
 
virtual void SetMinimumGhostLevel (int)
 
virtual void TimingOn ()
 Turn on collection of timing data. More...
 
virtual void TimingOff ()
 
virtual void SetTiming (int)
 
virtual int GetTiming ()
 
vtkBSPCutsGetCuts ()
 You can set the k-d tree decomposition, rather than have D3 compute it. More...
 
void SetCuts (vtkBSPCuts *cuts)
 
void SetUserRegionAssignments (const int *map, int numRegions)
 vtkBSPCuts doesn't have information about process assignments for the cuts. More...
 
- 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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkDistributedDataFilterSafeDownCast (vtkObjectBase *o)
 
static vtkDistributedDataFilterNew ()
 
- 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
 
 vtkDistributedDataFilter ()
 
 ~vtkDistributedDataFilter () override
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Build a vtkUnstructuredGrid to store the input. More...
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 
virtual int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Overridden to create the correct type of data output. More...
 
- Protected Member Functions inherited from vtkDataObjectAlgorithm
 vtkDataObjectAlgorithm ()
 
 ~vtkDataObjectAlgorithm () override
 
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 &)
 

Protected Attributes

vtkPKdTreeKdtree
 
vtkMultiProcessControllerController
 
int NumProcesses
 
int MyId
 
intTarget
 
intSource
 
int NumConvexSubRegions
 
doubleConvexSubRegionBounds
 
int MinimumGhostLevel
 
int GhostLevel
 
int RetainKdtree
 
int IncludeAllIntersectingCells
 
int ClipCells
 
int Timing
 
int NextProgressStep
 
double ProgressIncrement
 
int UseMinimalMemory
 
vtkBSPCutsUserCuts
 
std::vector< intUserRegionAssignments
 
- 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

Serial stand-in for parallel filter that distributes data among processors.

This filter is a serial implementation of the vtkPDistributedDataFilter filter with the intent that it can be used in non-MPI builds. This filter acts almost as a "pass-through" filter when run in serial, though when the input is a non-composite dataset, the output will be an vtkUnstructuredGrid to be consistent with the parallel filter. The combination of this filter and its parallel counterpart serves to unify the API for serial and parallel builds.

See also
vtkPDistributedDataFilter
Tests:
vtkDistributedDataFilter (Tests)

Definition at line 50 of file vtkDistributedDataFilter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 54 of file vtkDistributedDataFilter.h.

Member Enumeration Documentation

◆ BoundaryModes

Enumerator
ASSIGN_TO_ONE_REGION 
ASSIGN_TO_ALL_INTERSECTING_REGIONS 
SPLIT_BOUNDARY_CELLS 

Definition at line 126 of file vtkDistributedDataFilter.h.

Constructor & Destructor Documentation

◆ vtkDistributedDataFilter()

vtkDistributedDataFilter::vtkDistributedDataFilter ( )
protected

◆ ~vtkDistributedDataFilter()

vtkDistributedDataFilter::~vtkDistributedDataFilter ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkPDistributedDataFilter.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkDistributedDataFilter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkPDistributedDataFilter.

◆ NewInstance()

vtkDistributedDataFilter* vtkDistributedDataFilter::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkPDistributedDataFilter.

◆ New()

static vtkDistributedDataFilter* vtkDistributedDataFilter::New ( )
static

◆ SetController()

void vtkDistributedDataFilter::SetController ( vtkMultiProcessController c)

Set/Get the communicator object.

◆ GetController()

virtual vtkMultiProcessController* vtkDistributedDataFilter::GetController ( )
virtual

◆ GetKdtree()

vtkPKdTree* vtkDistributedDataFilter::GetKdtree ( )

Get a pointer to the parallel k-d tree object.

Required for changing default behavior for region assignment, changing default depth of tree, or other tree building default parameters. See vtkPKdTree and vtkKdTree for more information about these options. NOTE: Changing the tree returned by this method does NOT change the d3 filter. Make sure to call Modified() on the d3 object if you want it to re-execute.

◆ RetainKdtreeOn()

virtual void vtkDistributedDataFilter::RetainKdtreeOn ( )
virtual

When this filter executes, it creates a vtkPKdTree (K-d tree) data structure in parallel which divides the total distributed data set into spatial regions.

The K-d tree object also creates tables describing which processes have data for which regions. Only then does this filter redistribute the data according to the region assignment scheme. By default, the K-d tree structure and it's associated tables are deleted after the filter executes. If you anticipate changing only the region assignment scheme (input is unchanged) and explicitly re-executing, then RetainKdTreeOn, and the K-d tree structure and tables will be saved. Then, when you re-execute, this filter will skip the k-d tree build phase and go straight to redistributing the data according to region assignment. See vtkPKdTree for more information about region assignment.

◆ RetainKdtreeOff()

virtual void vtkDistributedDataFilter::RetainKdtreeOff ( )
virtual

◆ GetRetainKdtree()

virtual int vtkDistributedDataFilter::GetRetainKdtree ( )
virtual

◆ SetRetainKdtree()

virtual void vtkDistributedDataFilter::SetRetainKdtree ( int  )
virtual

◆ IncludeAllIntersectingCellsOn()

virtual void vtkDistributedDataFilter::IncludeAllIntersectingCellsOn ( )
virtual

Each cell in the data set is associated with one of the spatial regions of the k-d tree decomposition.

In particular, the cell belongs to the region that it's centroid lies in. When the new vtkUnstructuredGrid is created, by default it is composed of the cells associated with the region(s) assigned to this process. If you also want it to contain cells that intersect these regions, but have their centroid elsewhere, then set this variable on. By default it is off.

◆ IncludeAllIntersectingCellsOff()

virtual void vtkDistributedDataFilter::IncludeAllIntersectingCellsOff ( )
virtual

◆ GetIncludeAllIntersectingCells()

virtual int vtkDistributedDataFilter::GetIncludeAllIntersectingCells ( )
virtual

◆ SetIncludeAllIntersectingCells()

virtual void vtkDistributedDataFilter::SetIncludeAllIntersectingCells ( int  )
virtual

◆ ClipCellsOn()

virtual void vtkDistributedDataFilter::ClipCellsOn ( )
virtual

Set this variable if you want the cells of the output vtkUnstructuredGrid to be clipped to the spatial region boundaries.

By default this is off.

◆ ClipCellsOff()

virtual void vtkDistributedDataFilter::ClipCellsOff ( )
virtual

◆ GetClipCells()

virtual int vtkDistributedDataFilter::GetClipCells ( )
virtual

◆ SetClipCells()

virtual void vtkDistributedDataFilter::SetClipCells ( int  )
virtual

◆ SetBoundaryMode()

void vtkDistributedDataFilter::SetBoundaryMode ( int  mode)

Handling of ClipCells and IncludeAllIntersectingCells.

◆ SetBoundaryModeToAssignToOneRegion()

void vtkDistributedDataFilter::SetBoundaryModeToAssignToOneRegion ( )
inline

Definition at line 137 of file vtkDistributedDataFilter.h.

◆ SetBoundaryModeToAssignToAllIntersectingRegions()

void vtkDistributedDataFilter::SetBoundaryModeToAssignToAllIntersectingRegions ( )
inline

Definition at line 139 of file vtkDistributedDataFilter.h.

◆ SetBoundaryModeToSplitBoundaryCells()

void vtkDistributedDataFilter::SetBoundaryModeToSplitBoundaryCells ( )
inline

Definition at line 143 of file vtkDistributedDataFilter.h.

◆ GetBoundaryMode()

int vtkDistributedDataFilter::GetBoundaryMode ( )

◆ RequestUpdateExtent()

int vtkDistributedDataFilter::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overridevirtual

Ensure previous filters don't send up ghost cells.

Reimplemented from vtkDataObjectAlgorithm.

◆ UseMinimalMemoryOn()

virtual void vtkDistributedDataFilter::UseMinimalMemoryOn ( )
virtual

This class does a great deal of all-to-all communication when exchanging portions of data sets and building new sub grids.

By default it will do fast communication. It can instead use communication routines that use the least possible amount of memory, but these are slower. Set this option ON to choose these latter routines.

◆ UseMinimalMemoryOff()

virtual void vtkDistributedDataFilter::UseMinimalMemoryOff ( )
virtual

◆ GetUseMinimalMemory()

virtual int vtkDistributedDataFilter::GetUseMinimalMemory ( )
virtual

◆ SetUseMinimalMemory()

virtual void vtkDistributedDataFilter::SetUseMinimalMemory ( int  )
virtual

◆ GetMinimumGhostLevel()

virtual int vtkDistributedDataFilter::GetMinimumGhostLevel ( )
virtual

The minimum number of ghost levels to add to each processor's output.

If the pipeline also requests ghost levels, the larger value will be used.

◆ SetMinimumGhostLevel()

virtual void vtkDistributedDataFilter::SetMinimumGhostLevel ( int  )
virtual

◆ TimingOn()

virtual void vtkDistributedDataFilter::TimingOn ( )
virtual

Turn on collection of timing data.

◆ TimingOff()

virtual void vtkDistributedDataFilter::TimingOff ( )
virtual

◆ SetTiming()

virtual void vtkDistributedDataFilter::SetTiming ( int  )
virtual

◆ GetTiming()

virtual int vtkDistributedDataFilter::GetTiming ( )
virtual

◆ GetCuts()

vtkBSPCuts* vtkDistributedDataFilter::GetCuts ( )
inline

You can set the k-d tree decomposition, rather than have D3 compute it.

This allows you to divide a dataset using the decomposition computed for another dataset. Obtain a description of the k-d tree cuts this way:

vtkBSPCuts *cuts = D3Object1->GetCuts()

And set it this way:

D3Object2->SetCuts(cuts)

Definition at line 194 of file vtkDistributedDataFilter.h.

◆ SetCuts()

void vtkDistributedDataFilter::SetCuts ( vtkBSPCuts cuts)

◆ SetUserRegionAssignments()

void vtkDistributedDataFilter::SetUserRegionAssignments ( const int map,
int  numRegions 
)

vtkBSPCuts doesn't have information about process assignments for the cuts.

Typically D3 filter simply reassigns the processes for each cut. However, that may not always work, sometimes the processes have be pre-assigned and we want to preserve that partitioning. In that case, one sets the region assignments explicitly. Look at vtkPKdTree::AssignRegions for details about the arguments. Calling SetUserRegionAssignments(nullptr, 0) will revert to default behavior i.e. letting the KdTree come up with the assignments.

◆ RequestData()

virtual int vtkDistributedDataFilter::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

Build a vtkUnstructuredGrid to store the input.

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkPDistributedDataFilter.

◆ RequestInformation()

virtual int vtkDistributedDataFilter::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ FillInputPortInformation()

virtual int vtkDistributedDataFilter::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()

virtual int vtkDistributedDataFilter::RequestDataObject ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

Overridden to create the correct type of data output.

If input is dataset, output is vtkUnstructuredGrid. If input is composite dataset, output is vtkMultiBlockDataSet.

Reimplemented from vtkDataObjectAlgorithm.

Member Data Documentation

◆ Kdtree

vtkPKdTree* vtkDistributedDataFilter::Kdtree
protected

Definition at line 230 of file vtkDistributedDataFilter.h.

◆ Controller

vtkMultiProcessController* vtkDistributedDataFilter::Controller
protected

Definition at line 231 of file vtkDistributedDataFilter.h.

◆ NumProcesses

int vtkDistributedDataFilter::NumProcesses
protected

Definition at line 233 of file vtkDistributedDataFilter.h.

◆ MyId

int vtkDistributedDataFilter::MyId
protected

Definition at line 234 of file vtkDistributedDataFilter.h.

◆ Target

int* vtkDistributedDataFilter::Target
protected

Definition at line 236 of file vtkDistributedDataFilter.h.

◆ Source

int* vtkDistributedDataFilter::Source
protected

Definition at line 237 of file vtkDistributedDataFilter.h.

◆ NumConvexSubRegions

int vtkDistributedDataFilter::NumConvexSubRegions
protected

Definition at line 239 of file vtkDistributedDataFilter.h.

◆ ConvexSubRegionBounds

double* vtkDistributedDataFilter::ConvexSubRegionBounds
protected

Definition at line 240 of file vtkDistributedDataFilter.h.

◆ MinimumGhostLevel

int vtkDistributedDataFilter::MinimumGhostLevel
protected

Definition at line 243 of file vtkDistributedDataFilter.h.

◆ GhostLevel

int vtkDistributedDataFilter::GhostLevel
protected

Definition at line 246 of file vtkDistributedDataFilter.h.

◆ RetainKdtree

int vtkDistributedDataFilter::RetainKdtree
protected

Definition at line 248 of file vtkDistributedDataFilter.h.

◆ IncludeAllIntersectingCells

int vtkDistributedDataFilter::IncludeAllIntersectingCells
protected

Definition at line 249 of file vtkDistributedDataFilter.h.

◆ ClipCells

int vtkDistributedDataFilter::ClipCells
protected

Definition at line 250 of file vtkDistributedDataFilter.h.

◆ Timing

int vtkDistributedDataFilter::Timing
protected

Definition at line 252 of file vtkDistributedDataFilter.h.

◆ NextProgressStep

int vtkDistributedDataFilter::NextProgressStep
protected

Definition at line 254 of file vtkDistributedDataFilter.h.

◆ ProgressIncrement

double vtkDistributedDataFilter::ProgressIncrement
protected

Definition at line 255 of file vtkDistributedDataFilter.h.

◆ UseMinimalMemory

int vtkDistributedDataFilter::UseMinimalMemory
protected

Definition at line 257 of file vtkDistributedDataFilter.h.

◆ UserCuts

vtkBSPCuts* vtkDistributedDataFilter::UserCuts
protected

Definition at line 259 of file vtkDistributedDataFilter.h.

◆ UserRegionAssignments

std::vector<int> vtkDistributedDataFilter::UserRegionAssignments
protected

Definition at line 261 of file vtkDistributedDataFilter.h.


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