VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
vtkAMRUtilities Class Reference

#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. More...
 
vtkAMRUtilitiesNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual 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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAMRUtilitiesSafeDownCast (vtkObjectBase *o)
 
static void StripGhostLayers (vtkOverlappingAMR *ghostedAMRData, vtkOverlappingAMR *strippedAMRData)
 This method detects and strips partially overlapping cells from a given AMR dataset. More...
 
static bool HasPartiallyOverlappingGhostCells (vtkOverlappingAMR *amr)
 A quick test of whether partially overlapping ghost cells exist. More...
 
static void BlankCells (vtkOverlappingAMR *amr)
 Blank cells in overlapping AMR. More...
 
- 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 (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAMRUtilities ()
 
 ~vtkAMRUtilities () 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. More...
 
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 &)
 

Static Protected Member Functions

static void CopyFieldsWithinRealExtent (int realExtent[6], vtkUniformGrid *ghostedGrid, vtkUniformGrid *strippedGrid)
 Given the real-extent w.r.t. More...
 
static void CopyFieldData (vtkFieldData *target, vtkIdType targetIdx, vtkFieldData *source, vtkIdType sourceIdx)
 Copies the fields from the given source to the given target. More...
 
static vtkUniformGridStripGhostLayersFromGrid (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}. More...
 
static void BlankGridsAtLevel (vtkOverlappingAMR *amr, int levelIdx, std::vector< std::vector< unsigned int > > &children, const std::vector< int > &processMap)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- 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

Definition at line 38 of file vtkAMRUtilities.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkAMRUtilities.h.

Constructor & Destructor Documentation

◆ vtkAMRUtilities()

vtkAMRUtilities::vtkAMRUtilities ( )
inlineprotected

Definition at line 71 of file vtkAMRUtilities.h.

◆ ~vtkAMRUtilities()

vtkAMRUtilities::~vtkAMRUtilities ( )
inlineoverrideprotected

Definition at line 72 of file vtkAMRUtilities.h.

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

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: