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

This method partitions a global extent to N partitions where N is a user supplied parameter. More...

#include <vtkExtentRCBPartitioner.h>

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

Public Types

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...
 
vtkExtentRCBPartitionerNewInstance () const
 
void PrintSelf (ostream &oss, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Partition ()
 Partitions the extent. More...
 
void GetPartitionExtent (int idx, int ext[6])
 Returns the extent of the partition corresponding to the given ID. More...
 
void SetNumberOfPartitions (int N)
 Set/Get the number of requested partitions. More...
 
void SetGlobalExtent (int imin, int imax, int jmin, int jmax, int kmin, int kmax)
 Set/Get the global extent array to be partitioned. More...
 
void SetGlobalExtent (int ext[6])
 Set/Get the global extent array to be partitioned. More...
 
virtual void SetDuplicateNodes (vtkTypeBool)
 On/Off DuplicateNodes between partitions. More...
 
virtual vtkTypeBool GetDuplicateNodes ()
 On/Off DuplicateNodes between partitions. More...
 
virtual void DuplicateNodesOn ()
 On/Off DuplicateNodes between partitions. More...
 
virtual void DuplicateNodesOff ()
 On/Off DuplicateNodes between partitions. More...
 
virtual void SetNumberOfGhostLayers (int)
 Set/Get macro for the number of ghost layers. More...
 
virtual int GetNumberOfGhostLayers ()
 Set/Get macro for the number of ghost layers. More...
 
virtual int GetNumExtents ()
 Returns the number of extents. More...
 
- 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...
 
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. 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). 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...
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkExtentRCBPartitionerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkExtentRCBPartitionerSafeDownCast (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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkExtentRCBPartitioner ()
 
 ~vtkExtentRCBPartitioner () override
 
void ExtendGhostLayers (int ext[6])
 Given an extent, this method will create ghost layers on each side of the boundary in each dimension. More...
 
void AcquireDataDescription ()
 Gets the structured data-description based on the givenn global extent. More...
 
void GetExtent (int idx, int ext[6])
 Returns the extent at the position corresponding to idx. More...
 
void AddExtent (int ext[6])
 Adds the extent to the end of the list of partitioned extents. More...
 
void ReplaceExtent (int idx, int ext[6])
 Replaces the extent at the position indicated by idx with the provided extent. More...
 
void SplitExtent (int parent[6], int s1[6], int s2[6], int splitDimension)
 Splits the extent along the given dimension. More...
 
int GetNumberOfTotalExtents ()
 Returns the total number of extents. More...
 
int GetNumberOfNodes (int ext[6])
 Computes the total number of nodes for the given structured grid extent. More...
 
int GetNumberOfCells (int ext[6])
 Computes the total number of cells for the given structured grid extent. More...
 
int GetLongestDimensionLength (int ext[6])
 Returns the length of the longest dimension. More...
 
int GetLongestDimension (int ext[6])
 Returns the longest edge. More...
 
void PrintExtent (const std::string &name, int ext[6])
 A convenience method for debugging purposes. More...
 
void Reset ()
 Resets the partitioner to the initial state, all previous partition extents are cleared. More...
 
void GetGhostedExtent (int ext[6], int minIdx, int maxIdx)
 Givent an extent and the min/max of the dimension we are looking at, this method will produce a ghosted extent which is clamped within the given global extent. More...
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int NumberOfGhostLayers
 
int DataDescription
 
int GlobalExtent [6]
 
int NumberOfPartitions
 
int NumExtents
 
vtkTypeBool DuplicateNodes
 
bool ExtentIsPartitioned
 
std::vector< int > PartitionExtents
 
- 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

This method partitions a global extent to N partitions where N is a user supplied parameter.

Tests:
vtkExtentRCBPartitioner (Tests)

Definition at line 22 of file vtkExtentRCBPartitioner.h.

Member Typedef Documentation

◆ Superclass

Definition at line 26 of file vtkExtentRCBPartitioner.h.

Constructor & Destructor Documentation

◆ vtkExtentRCBPartitioner()

vtkExtentRCBPartitioner::vtkExtentRCBPartitioner ( )
protected

◆ ~vtkExtentRCBPartitioner()

vtkExtentRCBPartitioner::~vtkExtentRCBPartitioner ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkExtentRCBPartitioner* vtkExtentRCBPartitioner::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkExtentRCBPartitioner::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkExtentRCBPartitioner* vtkExtentRCBPartitioner::NewInstance ( ) const

◆ PrintSelf()

void vtkExtentRCBPartitioner::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 vtkObject.

◆ SetNumberOfPartitions()

void vtkExtentRCBPartitioner::SetNumberOfPartitions ( int  N)
inline

Set/Get the number of requested partitions.

Definition at line 33 of file vtkExtentRCBPartitioner.h.

◆ SetGlobalExtent() [1/2]

void vtkExtentRCBPartitioner::SetGlobalExtent ( int  imin,
int  imax,
int  jmin,
int  jmax,
int  kmin,
int  kmax 
)
inline

Set/Get the global extent array to be partitioned.

The global extent is packed as follows: [imin,imax,jmin,jmax,kmin,kmax]

Definition at line 47 of file vtkExtentRCBPartitioner.h.

◆ SetGlobalExtent() [2/2]

void vtkExtentRCBPartitioner::SetGlobalExtent ( int  ext[6])
inline

Set/Get the global extent array to be partitioned.

The global extent is packed as follows: [imin,imax,jmin,jmax,kmin,kmax]

Definition at line 57 of file vtkExtentRCBPartitioner.h.

◆ SetDuplicateNodes()

virtual void vtkExtentRCBPartitioner::SetDuplicateNodes ( vtkTypeBool  )
virtual

On/Off DuplicateNodes between partitions.

Default is On.

◆ GetDuplicateNodes()

virtual vtkTypeBool vtkExtentRCBPartitioner::GetDuplicateNodes ( )
virtual

On/Off DuplicateNodes between partitions.

Default is On.

◆ DuplicateNodesOn()

virtual void vtkExtentRCBPartitioner::DuplicateNodesOn ( )
virtual

On/Off DuplicateNodes between partitions.

Default is On.

◆ DuplicateNodesOff()

virtual void vtkExtentRCBPartitioner::DuplicateNodesOff ( )
virtual

On/Off DuplicateNodes between partitions.

Default is On.

◆ SetNumberOfGhostLayers()

virtual void vtkExtentRCBPartitioner::SetNumberOfGhostLayers ( int  )
virtual

Set/Get macro for the number of ghost layers.

◆ GetNumberOfGhostLayers()

virtual int vtkExtentRCBPartitioner::GetNumberOfGhostLayers ( )
virtual

Set/Get macro for the number of ghost layers.

◆ GetNumExtents()

virtual int vtkExtentRCBPartitioner::GetNumExtents ( )
virtual

Returns the number of extents.

◆ Partition()

void vtkExtentRCBPartitioner::Partition ( )

Partitions the extent.

◆ GetPartitionExtent()

void vtkExtentRCBPartitioner::GetPartitionExtent ( int  idx,
int  ext[6] 
)

Returns the extent of the partition corresponding to the given ID.

◆ Reset()

void vtkExtentRCBPartitioner::Reset ( )
inlineprotected

Resets the partitioner to the initial state, all previous partition extents are cleared.

Definition at line 106 of file vtkExtentRCBPartitioner.h.

◆ ExtendGhostLayers()

void vtkExtentRCBPartitioner::ExtendGhostLayers ( int  ext[6])
protected

Given an extent, this method will create ghost layers on each side of the boundary in each dimension.

The ghost layers however will be restricted to the given global extent.

◆ GetGhostedExtent()

void vtkExtentRCBPartitioner::GetGhostedExtent ( int  ext[6],
int  minIdx,
int  maxIdx 
)
inlineprotected

Givent an extent and the min/max of the dimension we are looking at, this method will produce a ghosted extent which is clamped within the given global extent.

Definition at line 127 of file vtkExtentRCBPartitioner.h.

◆ AcquireDataDescription()

void vtkExtentRCBPartitioner::AcquireDataDescription ( )
protected

Gets the structured data-description based on the givenn global extent.

◆ GetExtent()

void vtkExtentRCBPartitioner::GetExtent ( int  idx,
int  ext[6] 
)
protected

Returns the extent at the position corresponding to idx.

◆ AddExtent()

void vtkExtentRCBPartitioner::AddExtent ( int  ext[6])
protected

Adds the extent to the end of the list of partitioned extents.

◆ ReplaceExtent()

void vtkExtentRCBPartitioner::ReplaceExtent ( int  idx,
int  ext[6] 
)
protected

Replaces the extent at the position indicated by idx with the provided extent.

◆ SplitExtent()

void vtkExtentRCBPartitioner::SplitExtent ( int  parent[6],
int  s1[6],
int  s2[6],
int  splitDimension 
)
protected

Splits the extent along the given dimension.

◆ GetNumberOfTotalExtents()

int vtkExtentRCBPartitioner::GetNumberOfTotalExtents ( )
protected

Returns the total number of extents.

It's always the 2^N where N is the number of subdivisions.

◆ GetNumberOfNodes()

int vtkExtentRCBPartitioner::GetNumberOfNodes ( int  ext[6])
protected

Computes the total number of nodes for the given structured grid extent.

◆ GetNumberOfCells()

int vtkExtentRCBPartitioner::GetNumberOfCells ( int  ext[6])
protected

Computes the total number of cells for the given structured grid extent.

◆ GetLongestDimensionLength()

int vtkExtentRCBPartitioner::GetLongestDimensionLength ( int  ext[6])
protected

Returns the length of the longest dimension.

◆ GetLongestDimension()

int vtkExtentRCBPartitioner::GetLongestDimension ( int  ext[6])
protected

Returns the longest edge.

◆ PrintExtent()

void vtkExtentRCBPartitioner::PrintExtent ( const std::string &  name,
int  ext[6] 
)
protected

A convenience method for debugging purposes.

Member Data Documentation

◆ NumberOfGhostLayers

int vtkExtentRCBPartitioner::NumberOfGhostLayers
protected

Definition at line 195 of file vtkExtentRCBPartitioner.h.

◆ DataDescription

int vtkExtentRCBPartitioner::DataDescription
protected

Definition at line 196 of file vtkExtentRCBPartitioner.h.

◆ GlobalExtent

int vtkExtentRCBPartitioner::GlobalExtent[6]
protected

Definition at line 197 of file vtkExtentRCBPartitioner.h.

◆ NumberOfPartitions

int vtkExtentRCBPartitioner::NumberOfPartitions
protected

Definition at line 198 of file vtkExtentRCBPartitioner.h.

◆ NumExtents

int vtkExtentRCBPartitioner::NumExtents
protected

Definition at line 199 of file vtkExtentRCBPartitioner.h.

◆ DuplicateNodes

vtkTypeBool vtkExtentRCBPartitioner::DuplicateNodes
protected

Definition at line 201 of file vtkExtentRCBPartitioner.h.

◆ ExtentIsPartitioned

bool vtkExtentRCBPartitioner::ExtentIsPartitioned
protected

Definition at line 206 of file vtkExtentRCBPartitioner.h.

◆ PartitionExtents

std::vector<int> vtkExtentRCBPartitioner::PartitionExtents
protected

Definition at line 208 of file vtkExtentRCBPartitioner.h.


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