collection of helper functions for working with DIY More...

#include <vtkDIYUtilities.h>

Inheritance diagram for vtkDIYUtilities:

Collaboration diagram for vtkDIYUtilities:

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.

vtkDIYUtilities *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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.

vtkCommand *	GetCommand (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 vtkDIYUtilities *	SafeDownCast (vtkObjectBase *o)

static void	InitializeEnvironmentForDIY ()
	In MPI-enabled builds, DIY filters need MPI to be initialized.

static diy::mpi::communicator	GetCommunicator (vtkMultiProcessController *controller)
	Converts a vtkMultiProcessController to a diy::mpi::communicator.

static void	AllReduce (diy::mpi::communicator &comm, vtkBoundingBox &bbox)
	Reduce bounding box.

static diy::ContinuousBounds	Convert (const vtkBoundingBox &bbox)
	Convert vtkBoundingBox to diy::ContinuousBounds.

static vtkBoundingBox	Convert (const diy::ContinuousBounds &bds)
	Convert diy::ContinuousBounds to vtkBoundingBox.

static void	Broadcast (diy::mpi::communicator &comm, std::vector< vtkBoundingBox > &boxes, int source)
	Broadcast a vector of bounding boxes.

static vtkBoundingBox	GetLocalBounds (vtkDataObject *dobj)
	Convenience method to get local bounds for the data object.

template<class DummyT >
static void	Link (diy::Master &master, const diy::Assigner &assigner, const std::vector< std::map< int, DummyT > > &linksMap)
	Links master such that there is communication between ranks as given in `linksMap`.

static void	Link (diy::Master &master, const diy::Assigner &assigner, const std::vector< std::set< int > > &linksMap)


static void	Save (diy::BinaryBuffer &bb, vtkDataSet *)
	Load/Save a vtkDataSet in a diy::BinaryBuffer.

static void	Load (diy::BinaryBuffer &bb, vtkDataSet *&)
	Load/Save a vtkDataSet in a diy::BinaryBuffer.


static void	Save (diy::BinaryBuffer &bb, vtkFieldData *)
	Load/Save a vtkFieldData in a diy::BinaryBuffer.

static void	Load (diy::BinaryBuffer &bb, vtkFieldData *&)
	Load/Save a vtkFieldData in a diy::BinaryBuffer.


static void	Save (diy::BinaryBuffer &bb, vtkStringArray *)
	Load/Save a vtkStringArray in a diy::BinaryBuffer.

static void	Load (diy::BinaryBuffer &bb, vtkStringArray *&)
	Load/Save a vtkStringArray in a diy::BinaryBuffer.


static void	Save (diy::BinaryBuffer &bb, vtkDataArray *)
	Load/Save a vtkDataArray in a diy::BinaryBuffer.

static void	Load (diy::BinaryBuffer &bb, vtkDataArray *&)
	Load/Save a vtkDataArray in a diy::BinaryBuffer.


static std::vector< vtkSmartPointer< vtkPoints > >	ExtractPoints (const std::vector< vtkDataSet * > &datasets, bool use_cell_centers)
	Extracts points from the input.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const

	vtkDIYUtilities ()

	~vtkDIYUtilities () 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 &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

Detailed Description

collection of helper functions for working with DIY

vtkDIYUtilities provides a set of utility functions when using DIY in a VTK filters.

Tests:: vtkDIYUtilities (Tests)

Definition at line 42 of file vtkDIYUtilities.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkDIYUtilities::Superclass

Definition at line 45 of file vtkDIYUtilities.h.

Constructor & Destructor Documentation

◆ vtkDIYUtilities()

vtkDIYUtilities::vtkDIYUtilities ( )

protected

◆ ~vtkDIYUtilities()

vtkDIYUtilities::~vtkDIYUtilities ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDIYUtilities::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkDIYUtilities * vtkDIYUtilities::NewInstance ( ) const

◆ PrintSelf()

void vtkDIYUtilities::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 vtkObjectBase.

◆ InitializeEnvironmentForDIY()

static void vtkDIYUtilities::InitializeEnvironmentForDIY ( )

static

In MPI-enabled builds, DIY filters need MPI to be initialized.

Calling this method in such filters will ensure that that's the case.

◆ GetCommunicator()

static diy::mpi::communicator vtkDIYUtilities::GetCommunicator ( vtkMultiProcessController * controller )

static

Converts a vtkMultiProcessController to a diy::mpi::communicator.

If controller is nullptr or not a vtkMPIController, then diy::mpi::communicator(MPI_COMM_NULL) is created.

◆ Save() [1/4]

static void vtkDIYUtilities::Save	(	diy::BinaryBuffer &	bb,
		vtkDataSet *
	)

static

Load/Save a vtkDataSet in a diy::BinaryBuffer.

◆ Load() [1/4]

static void vtkDIYUtilities::Load	(	diy::BinaryBuffer &	bb,
		vtkDataSet *&
	)

static

Load/Save a vtkDataSet in a diy::BinaryBuffer.

◆ Save() [2/4]

static void vtkDIYUtilities::Save	(	diy::BinaryBuffer &	bb,
		vtkFieldData *
	)

static

Load/Save a vtkFieldData in a diy::BinaryBuffer.

◆ Load() [2/4]

static void vtkDIYUtilities::Load	(	diy::BinaryBuffer &	bb,
		vtkFieldData *&
	)

static

Load/Save a vtkFieldData in a diy::BinaryBuffer.

◆ Save() [3/4]

static void vtkDIYUtilities::Save	(	diy::BinaryBuffer &	bb,
		vtkStringArray *
	)

static

Load/Save a vtkStringArray in a diy::BinaryBuffer.

◆ Load() [3/4]

static void vtkDIYUtilities::Load	(	diy::BinaryBuffer &	bb,
		vtkStringArray *&
	)

static

Load/Save a vtkStringArray in a diy::BinaryBuffer.

◆ Save() [4/4]

static void vtkDIYUtilities::Save	(	diy::BinaryBuffer &	bb,
		vtkDataArray *
	)

static

Load/Save a vtkDataArray in a diy::BinaryBuffer.

◆ Load() [4/4]

static void vtkDIYUtilities::Load	(	diy::BinaryBuffer &	bb,
		vtkDataArray *&
	)

static

Load/Save a vtkDataArray in a diy::BinaryBuffer.

◆ AllReduce()

static void vtkDIYUtilities::AllReduce	(	diy::mpi::communicator &	comm,
		vtkBoundingBox &	bbox
	)

static

Reduce bounding box.

◆ Convert() [1/2]

static diy::ContinuousBounds vtkDIYUtilities::Convert ( const vtkBoundingBox & bbox )

static

Convert vtkBoundingBox to diy::ContinuousBounds.

Note, there is a loss of precision since vtkBoundingBox uses double while diy::ContinuousBounds uses float.

◆ Convert() [2/2]

static vtkBoundingBox vtkDIYUtilities::Convert ( const diy::ContinuousBounds & bds )

static

Convert diy::ContinuousBounds to vtkBoundingBox.

Note, there is a change of precision since vtkBoundingBox uses double while diy::ContinuousBounds uses float.

◆ Broadcast()

static void vtkDIYUtilities::Broadcast	(	diy::mpi::communicator &	comm,
		std::vector< vtkBoundingBox > &	boxes,
		int	source
	)

static

Broadcast a vector of bounding boxes.

Only the source vector needs to have a valid size.

◆ ExtractPoints()

static std::vector< vtkSmartPointer< vtkPoints > > vtkDIYUtilities::ExtractPoints	(	const std::vector< vtkDataSet * > &	datasets,
		bool	use_cell_centers
	)

static

Extracts points from the input.

If input is not a vtkPointSet, it will use an appropriate filter to extract the vtkPoints. If use_cell_centers is true, cell-centers will be computed and extracted instead of the dataset points.

◆ GetLocalBounds()

static vtkBoundingBox vtkDIYUtilities::GetLocalBounds ( vtkDataObject * dobj )

static

Convenience method to get local bounds for the data object.

◆ Link() [1/2]

template<class DummyT >

static void vtkDIYUtilities::Link	(	diy::Master &	master,
		const diy::Assigner &	assigner,
		const std::vector< std::map< int, DummyT > > &	linksMap
	)

static

Links master such that there is communication between ranks as given in linksMap.

linksMap is a vector of a list of global ids. The size of this vector should be the same as the number of blocks in the current rank and should map to the block of same local id. The associated list of global ids will tell which block is to be connected with the local block.

◆ Link() [2/2]

static void vtkDIYUtilities::Link	(	diy::Master &	master,
		const diy::Assigner &	assigner,
		const std::vector< std::set< int > > &	linksMap
	)

static

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

Parallel/DIY/vtkDIYUtilities.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkDIYUtilities()

◆ ~vtkDIYUtilities()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ InitializeEnvironmentForDIY()

◆ GetCommunicator()

◆ Save() [1/4]

◆ Load() [1/4]

◆ Save() [2/4]

◆ Load() [2/4]

◆ Save() [3/4]

◆ Load() [3/4]

◆ Save() [4/4]

◆ Load() [4/4]

◆ AllReduce()

◆ Convert() [1/2]

◆ Convert() [2/2]

◆ Broadcast()

◆ ExtractPoints()

◆ GetLocalBounds()

◆ Link() [1/2]

◆ Link() [2/2]