#include <vtkExtentRCBPartitioner.h>

Inheritance diagram for vtkExtentRCBPartitioner:

Collaboration diagram for vtkExtentRCBPartitioner:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkExtentRCBPartitioner *	NewInstance () const

void	PrintSelf (ostream &oss, vtkIndent indent)

void	Partition ()

void	GetPartitionExtent (const int idx, int ext[6])


void	SetNumberOfPartitions (const int N)


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

void	SetGlobalExtent (int ext[6])


virtual void	SetDuplicateNodes (int)

virtual int	GetDuplicateNodes ()

virtual void	DuplicateNodesOn ()

virtual void	DuplicateNodesOff ()


virtual void	SetNumberOfGhostLayers (int)

virtual int	GetNumberOfGhostLayers ()


virtual int	GetNumExtents ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkExtentRCBPartitioner *	New ()

static int	IsTypeOf (const char *type)

static vtkExtentRCBPartitioner *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkExtentRCBPartitioner ()

	~vtkExtentRCBPartitioner ()

void	ExtendGhostLayers (int ext[6])

void	AcquireDataDescription ()

void	GetExtent (const int idx, int ext[6])

void	AddExtent (int ext[6])

void	ReplaceExtent (const int idx, int ext[6])

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

int	GetNumberOfTotalExtents ()

int	GetNumberOfNodes (int ext[6])

int	GetNumberOfCells (int ext[6])

int	GetLongestDimensionLength (int ext[6])

int	GetLongestDimension (int ext[6])

void	PrintExtent (std::string name, int ext[6])


void	Reset ()


void	GetGhostedExtent (int ext[6], const int minIdx, const int maxIdx)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	NumberOfGhostLayers

int	DataDescription

int	GlobalExtent [6]

int	NumberOfPartitions

int	NumExtents

int	DuplicateNodes

bool	ExtentIsPartitioned

std::vector< int >	PartitionExtents

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

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

Tests:: vtkExtentRCBPartitioner (Tests)

Definition at line 34 of file vtkExtentRCBPartitioner.h.

Member Typedef Documentation

typedef vtkObject vtkExtentRCBPartitioner::Superclass

Definition at line 38 of file vtkExtentRCBPartitioner.h.

Constructor & Destructor Documentation

vtkExtentRCBPartitioner::vtkExtentRCBPartitioner ( )

protected

vtkExtentRCBPartitioner::~vtkExtentRCBPartitioner ( )

protected

Member Function Documentation

static vtkExtentRCBPartitioner* vtkExtentRCBPartitioner::New ( )

static

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

static

virtual int 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 vtkObject.

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

static

virtual vtkObjectBase* vtkExtentRCBPartitioner::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkExtentRCBPartitioner* vtkExtentRCBPartitioner::NewInstance ( ) const

void vtkExtentRCBPartitioner::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

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.

void vtkExtentRCBPartitioner::SetNumberOfPartitions ( const int N )

inline

Set/Get the number of requested partitions

Definition at line 43 of file vtkExtentRCBPartitioner.h.

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 54 of file vtkExtentRCBPartitioner.h.

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 64 of file vtkExtentRCBPartitioner.h.

virtual void vtkExtentRCBPartitioner::SetDuplicateNodes ( int )

virtual

On/Off DuplicateNodes between partitions. Default is On.

virtual int vtkExtentRCBPartitioner::GetDuplicateNodes ( )

virtual

On/Off DuplicateNodes between partitions. Default is On.

virtual void vtkExtentRCBPartitioner::DuplicateNodesOn ( )

virtual

On/Off DuplicateNodes between partitions. Default is On.

virtual void vtkExtentRCBPartitioner::DuplicateNodesOff ( )

virtual

On/Off DuplicateNodes between partitions. Default is On.

virtual void vtkExtentRCBPartitioner::SetNumberOfGhostLayers ( int )

virtual

Set/Get macro for the number of ghost layers.

virtual int vtkExtentRCBPartitioner::GetNumberOfGhostLayers ( )

virtual

Set/Get macro for the number of ghost layers.

virtual int vtkExtentRCBPartitioner::GetNumExtents ( )

virtual

Returns the number of extents.

void vtkExtentRCBPartitioner::Partition ( )

Partitions the extent

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

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

void vtkExtentRCBPartitioner::Reset ( )

inlineprotected

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

Definition at line 101 of file vtkExtentRCBPartitioner.h.

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.

void vtkExtentRCBPartitioner::GetGhostedExtent	(	int	ext[6],
		const int	minIdx,
		const 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 118 of file vtkExtentRCBPartitioner.h.

void vtkExtentRCBPartitioner::AcquireDataDescription ( )

protected

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

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

protected

Returns the extent at the position corresponding to idx.

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

protected

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

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

protected

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

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

protected

Splits the extent along the given dimension.

int vtkExtentRCBPartitioner::GetNumberOfTotalExtents ( )

protected

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

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

protected

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

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

protected

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

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

protected

Returns the length of the longest dimension

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

protected

Returns the longest edge

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

protected

A convenience method for debugging purposes.

Member Data Documentation

int vtkExtentRCBPartitioner::NumberOfGhostLayers

protected

Definition at line 168 of file vtkExtentRCBPartitioner.h.

int vtkExtentRCBPartitioner::DataDescription

protected

Definition at line 169 of file vtkExtentRCBPartitioner.h.

int vtkExtentRCBPartitioner::GlobalExtent[6]

protected

Definition at line 170 of file vtkExtentRCBPartitioner.h.

int vtkExtentRCBPartitioner::NumberOfPartitions

protected

Definition at line 171 of file vtkExtentRCBPartitioner.h.

int vtkExtentRCBPartitioner::NumExtents

protected

Definition at line 172 of file vtkExtentRCBPartitioner.h.

int vtkExtentRCBPartitioner::DuplicateNodes

protected

Definition at line 174 of file vtkExtentRCBPartitioner.h.

bool vtkExtentRCBPartitioner::ExtentIsPartitioned

protected

Definition at line 179 of file vtkExtentRCBPartitioner.h.

std::vector<int> vtkExtentRCBPartitioner::PartitionExtents

protected

Definition at line 182 of file vtkExtentRCBPartitioner.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/ExecutionModel/vtkExtentRCBPartitioner.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation