A concrete instance of vtkObject that employs a singleton design pattern and implements functionality for AMR specific operations. More...

#include <vtkAMRUtilities.h>

Inheritance diagram for vtkAMRUtilities:

[legend]

Collaboration diagram for vtkAMRUtilities:

[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.

vtkAMRUtilities *	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 vtkAMRUtilities *	SafeDownCast (vtkObjectBase *o)

static void	StripGhostLayers (vtkOverlappingAMR ghostedAMRData, vtkOverlappingAMR strippedAMRData)
	This method detects and strips partially overlapping cells from a given AMR dataset.

static bool	HasPartiallyOverlappingGhostCells (vtkOverlappingAMR *amr)
	A quick test of whether partially overlapping ghost cells exist.

static void	BlankCells (vtkOverlappingAMR *amr)
	Blank cells in overlapping AMR.

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

	vtkAMRUtilities ()=default

	~vtkAMRUtilities () override=default

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 &)

Static Protected Member Functions
static void	CopyFieldsWithinRealExtent (int realExtent[6], vtkUniformGrid ghostedGrid, vtkUniformGrid strippedGrid)
	Given the real-extent w.r.t.

static void	CopyFieldData (vtkFieldData target, vtkIdType targetIdx, vtkFieldData source, vtkIdType sourceIdx)
	Copies the fields from the given source to the given target.

static vtkUniformGrid *	StripGhostLayersFromGrid (vtkUniformGrid *grid, int ghost[6])
	Strips ghost layers from the given grid according to the given ghost vector which encodes the number of cells to remote from each of the 6 sides {imin,imax,jmin,jmax,kmin,kmax}.

static void	BlankGridsAtLevel (vtkOverlappingAMR *amr, int levelIdx, std::vector< std::vector< unsigned int > > &children, const std::vector< int > &processMap)

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Additional Inherited Members
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

A concrete instance of vtkObject that employs a singleton design pattern and implements functionality for AMR specific operations.

See also: vtkOverlappingAMR, vtkAMRBox

Examples:: vtkAMRUtilities (Examples)

Online Examples:

Generate2DAMRDataSetWithPulse

Generate3DAMRDataSetWithPulse

OverlappingAMR

Tests:: vtkAMRUtilities (Tests)

Definition at line 74 of file vtkAMRUtilities.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkAMRUtilities::Superclass

Definition at line 78 of file vtkAMRUtilities.h.

Constructor & Destructor Documentation

◆ vtkAMRUtilities()

vtkAMRUtilities::vtkAMRUtilities ( )

protecteddefault

◆ ~vtkAMRUtilities()

vtkAMRUtilities::~vtkAMRUtilities ( )

overrideprotecteddefault

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAMRUtilities::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkParallelAMRUtilities.

◆ NewInstance()

vtkAMRUtilities * vtkAMRUtilities::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkParallelAMRUtilities.

◆ StripGhostLayers()

static void vtkAMRUtilities::StripGhostLayers	(	vtkOverlappingAMR *	ghostedAMRData,
		vtkOverlappingAMR *	strippedAMRData
	)

static

This method detects and strips partially overlapping cells from a given AMR dataset.

If ghost layers are detected, they are removed and new grid instances are created to represent the stripped data-set otherwise, each block is shallow-copied.

.SECTION Assumptions 1) The ghosted AMR data must have complete metadata information.

◆ HasPartiallyOverlappingGhostCells()

static bool vtkAMRUtilities::HasPartiallyOverlappingGhostCells ( vtkOverlappingAMR * amr )

static

A quick test of whether partially overlapping ghost cells exist.

This test starts from the highest-res boxes and checks if they have partially overlapping cells. The code returns with true once partially overlapping cells are detected. Otherwise, false is returned.

◆ BlankCells()

static void vtkAMRUtilities::BlankCells ( vtkOverlappingAMR * amr )

static

Blank cells in overlapping AMR.

◆ CopyFieldsWithinRealExtent()

static void vtkAMRUtilities::CopyFieldsWithinRealExtent	(	int	realExtent[6],
		vtkUniformGrid *	ghostedGrid,
		vtkUniformGrid *	strippedGrid
	)

staticprotected

Given the real-extent w.r.t.

the ghosted grid, this method copies the field data (point/cell) data on the stripped grid.

◆ CopyFieldData()

static void vtkAMRUtilities::CopyFieldData	(	vtkFieldData *	target,
		vtkIdType	targetIdx,
		vtkFieldData *	source,
		vtkIdType	sourceIdx
	)

staticprotected

Copies the fields from the given source to the given target.

◆ StripGhostLayersFromGrid()

static vtkUniformGrid * vtkAMRUtilities::StripGhostLayersFromGrid	(	vtkUniformGrid *	grid,
		int	ghost[6]
	)

staticprotected

Strips ghost layers from the given grid according to the given ghost vector which encodes the number of cells to remote from each of the 6 sides {imin,imax,jmin,jmax,kmin,kmax}.

For example, a ghost vector of {0,2,0,2,0,0} would indicate that there exist 2 ghost cells on the imax and jmax side.

◆ BlankGridsAtLevel()

static void vtkAMRUtilities::BlankGridsAtLevel	(	vtkOverlappingAMR *	amr,
		int	levelIdx,
		std::vector< std::vector< unsigned int > > &	children,
		const std::vector< int > &	processMap
	)

staticprotected

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

Common/DataModel/vtkAMRUtilities.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkAMRUtilities()

◆ ~vtkAMRUtilities()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ StripGhostLayers()

◆ HasPartiallyOverlappingGhostCells()

◆ BlankCells()

◆ CopyFieldsWithinRealExtent()

◆ CopyFieldData()

◆ StripGhostLayersFromGrid()

◆ BlankGridsAtLevel()