VTK  9.3.20240907
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPartitioningStrategy Class Referenceabstract

A strategy interface for partitioning meshes. More...

#include <vtkPartitioningStrategy.h>

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

Classes

struct  PartitionInformation
 Encapsulation structure for describing the result of a partitioning calculation. More...
 

Public Types

enum  PartitionedEntity { POINTS = 0 , CELLS = 1 }
 An enum defining which principal entity is being partitioned. 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.
 
vtkPartitioningStrategyNewInstance () const
 
void PrintSelf (std::ostream &os, vtkIndent indent) override
 
virtual std::vector< PartitionInformationComputePartition (vtkPartitionedDataSetCollection *)=0
 Main method for subclasses to implement in order to define their partitioning method (should be called on all ranks due to distributed communication)
 
void SetController (vtkMultiProcessController *)
 Get/Set the controller to use.
 
virtual vtkMultiProcessControllerGetController ()
 Get/Set the controller to use.
 
virtual vtkIdType GetNumberOfPartitions ()
 Get/Set number of partitions (if < 0 use number of MPI ranks)
 
virtual void SetNumberOfPartitions (vtkIdType)
 Get/Set number of partitions (if < 0 use number of MPI ranks)
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPartitioningStrategySafeDownCast (vtkObjectBase *o)
 
- 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPartitioningStrategy ()
 
 ~vtkPartitioningStrategy () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkMultiProcessControllerController = nullptr
 
vtkIdType NumberOfPartitions = -1
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

A strategy interface for partitioning meshes.

This abstract class is meant to act as an interface for homogeneizing the use of different partitioning algorithms in the vtkRedistributeDataSetFilter.

This class offers two main architectural contributions:

1) Format: a vtkPartitioningStrategy::PartitionInformation structure that defines a protocol for submitting partition information to the vtkRedistributeDataSetFilter for subsequent communication and process dispatch

2) Processing Signature: a pure virtual method/interface vtkPartitioningStrategy::ComputePartition for implementing partitioning algorithms and providing std::vectors of PartitionInformation (one for each current partition in the vtkPartitionedDataSetCollection) to the vtkRedistributeDataSetFilter

See also
vtkRedistributeDataSetFilter

Definition at line 36 of file vtkPartitioningStrategy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkPartitioningStrategy.h.

Member Enumeration Documentation

◆ PartitionedEntity

An enum defining which principal entity is being partitioned.

Enumerator
POINTS 
CELLS 

Definition at line 45 of file vtkPartitioningStrategy.h.

Constructor & Destructor Documentation

◆ vtkPartitioningStrategy()

vtkPartitioningStrategy::vtkPartitioningStrategy ( )
protected

◆ ~vtkPartitioningStrategy()

vtkPartitioningStrategy::~vtkPartitioningStrategy ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkNativePartitioningStrategy.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPartitioningStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkNativePartitioningStrategy.

◆ NewInstance()

vtkPartitioningStrategy * vtkPartitioningStrategy::NewInstance ( ) const

◆ PrintSelf()

void vtkPartitioningStrategy::PrintSelf ( std::ostream &  os,
vtkIndent  indent 
)
override

◆ ComputePartition()

virtual std::vector< PartitionInformation > vtkPartitioningStrategy::ComputePartition ( vtkPartitionedDataSetCollection )
pure virtual

Main method for subclasses to implement in order to define their partitioning method (should be called on all ranks due to distributed communication)

Returns a vector of PartitionInformation structures (one for each block partition data set in the collection)

Implemented in vtkNativePartitioningStrategy.

◆ SetController()

void vtkPartitioningStrategy::SetController ( vtkMultiProcessController )

Get/Set the controller to use.

By default vtkMultiProcessController::GlobalController will be used.

◆ GetController()

virtual vtkMultiProcessController * vtkPartitioningStrategy::GetController ( )
virtual

Get/Set the controller to use.

By default vtkMultiProcessController::GlobalController will be used.

◆ GetNumberOfPartitions()

virtual vtkIdType vtkPartitioningStrategy::GetNumberOfPartitions ( )
virtual

Get/Set number of partitions (if < 0 use number of MPI ranks)

◆ SetNumberOfPartitions()

virtual void vtkPartitioningStrategy::SetNumberOfPartitions ( vtkIdType  )
virtual

Get/Set number of partitions (if < 0 use number of MPI ranks)

Member Data Documentation

◆ Controller

vtkMultiProcessController* vtkPartitioningStrategy::Controller = nullptr
protected

Definition at line 126 of file vtkPartitioningStrategy.h.

◆ NumberOfPartitions

vtkIdType vtkPartitioningStrategy::NumberOfPartitions = -1
protected

Definition at line 128 of file vtkPartitioningStrategy.h.


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