Create a synthetic grid of hypertrees. More...

#include <vtkHyperTreeGridSource.h>

Inheritance diagram for vtkHyperTreeGridSource:

Collaboration diagram for vtkHyperTreeGridSource:

Public Types
typedef vtkHyperTreeGridAlgorithm	Superclass

Public Types inherited from vtkHyperTreeGridAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...

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

vtkHyperTreeGridSource *	NewInstance () const

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

unsigned int	GetMaximumLevel ()
	Return the maximum number of levels of the hypertree. More...

void	SetMaximumLevel (unsigned int levels)
	Set the maximum number of levels of the hypertrees. More...

virtual void	SetLevelZeroMaterialIndex (vtkIdTypeArray *)
	Set the index array used to as a material mask. More...

vtkMTimeType	GetMTime () override
	Override GetMTime because we delegate to a vtkQuadric. More...


virtual void	SetOrigin (double, double, double)
	Set/Get the origin of the grid. More...

virtual void	SetOrigin (double[3])
	Set/Get the origin of the grid. More...

virtual double *	GetOrigin ()
	Set/Get the origin of the grid. More...

virtual void	GetOrigin (double &, double &, double &)
	Set/Get the origin of the grid. More...

virtual void	GetOrigin (double[3])
	Set/Get the origin of the grid. More...


virtual void	SetGridScale (double, double, double)
	Set/Get the scale to be applied to root cells in each dimension of the grid. More...

virtual void	SetGridScale (double[3])
	Set/Get the scale to be applied to root cells in each dimension of the grid. More...

virtual double *	GetGridScale ()
	Set/Get the scale to be applied to root cells in each dimension of the grid. More...

virtual void	GetGridScale (double &, double &, double &)
	Set/Get the scale to be applied to root cells in each dimension of the grid. More...

virtual void	GetGridScale (double[3])
	Set/Get the scale to be applied to root cells in each dimension of the grid. More...


virtual void	SetGridSize (unsigned int, unsigned int, unsigned int)
	Set/Get the number of root cells in each dimension of the grid. More...

virtual void	SetGridSize (unsigned int[3])
	Set/Get the number of root cells in each dimension of the grid. More...

virtual unsigned int *	GetGridSize ()
	Set/Get the number of root cells in each dimension of the grid. More...

virtual void	GetGridSize (unsigned int &, unsigned int &, unsigned int &)
	Set/Get the number of root cells in each dimension of the grid. More...

virtual void	GetGridSize (unsigned int[3])
	Set/Get the number of root cells in each dimension of the grid. More...


virtual void	SetTransposedRootIndexing (bool)
	Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last. More...

virtual bool	GetTransposedRootIndexing ()
	Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last. More...

void	SetIndexingModeToKJI ()
	Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last. More...

void	SetIndexingModeToIJK ()
	Specify whether indexing mode of grid root cells must be transposed to x-axis first, z-axis last, instead of the default z-axis first, k-axis last. More...


virtual void	SetDimension (unsigned int)
	Set/Get the dimensionality of the grid. More...

virtual unsigned int	GetDimension ()
	Set/Get the dimensionality of the grid. More...


virtual void	SetOrientation (unsigned int)
	Set/Get the orientation of the grid (in 1D and 2D) More...

virtual unsigned int	GetOrientation ()
	Set/Get the orientation of the grid (in 1D and 2D) More...


virtual void	SetBranchFactor (unsigned int)
	Set/Get the subdivision factor in the grid refinement scheme. More...

virtual unsigned int	GetBranchFactor ()
	Set/Get the subdivision factor in the grid refinement scheme. More...


virtual void	SetUseDescriptor (bool)
	Set/get whether the descriptor string should be used. More...

virtual bool	GetUseDescriptor ()
	Set/get whether the descriptor string should be used. More...

virtual void	UseDescriptorOn ()
	Set/get whether the descriptor string should be used. More...

virtual void	UseDescriptorOff ()
	Set/get whether the descriptor string should be used. More...


virtual void	SetUseMaterialMask (bool)
	Set/get whether the material mask should be used. More...

virtual bool	GetUseMaterialMask ()
	Set/get whether the material mask should be used. More...

virtual void	UseMaterialMaskOn ()
	Set/get whether the material mask should be used. More...

virtual void	UseMaterialMaskOff ()
	Set/get whether the material mask should be used. More...


virtual void	SetGenerateInterfaceFields (bool)
	Set/get whether cell-centered interface fields should be generated. More...

virtual bool	GetGenerateInterfaceFields ()
	Set/get whether cell-centered interface fields should be generated. More...

virtual void	GenerateInterfaceFieldsOn ()
	Set/get whether cell-centered interface fields should be generated. More...

virtual void	GenerateInterfaceFieldsOff ()
	Set/get whether cell-centered interface fields should be generated. More...


virtual void	SetDescriptor (const char *)
	Set/Get the string used to describe the grid. More...

virtual char *	GetDescriptor ()
	Set/Get the string used to describe the grid. More...


virtual void	SetMaterialMask (const char *)
	Set/Get the string used to as a material mask. More...

virtual char *	GetMaterialMask ()
	Set/Get the string used to as a material mask. More...


virtual void	SetDescriptorBits (vtkBitArray *)
	Set/Get the bitarray used to describe the grid. More...

virtual vtkBitArray *	GetDescriptorBits ()
	Set/Get the bitarray used to describe the grid. More...


virtual void	SetMaterialMaskBits (vtkBitArray *)
	Set/Get the bitarray used as a material mask. More...

virtual vtkBitArray *	GetMaterialMaskBits ()
	Set/Get the bitarray used as a material mask. More...


virtual void	SetQuadric (vtkQuadric *)
	Set/Get the quadric function. More...

virtual vtkQuadric *	GetQuadric ()
	Set/Get the quadric function. More...


void	SetQuadricCoefficients (double[10])
	Helpers to set/get the 10 coefficients of the quadric function. More...

void	GetQuadricCoefficients (double[10])
	Helpers to set/get the 10 coefficients of the quadric function. More...

double *	GetQuadricCoefficients ()
	Helpers to set/get the 10 coefficients of the quadric function. More...


vtkBitArray *	ConvertDescriptorStringToBitArray (const std::string &)
	Helpers to convert string descriptors & mask to bit arrays. More...

vtkBitArray *	ConvertMaterialMaskStringToBitArray (const std::string &)
	Helpers to convert string descriptors & mask to bit arrays. More...

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

int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	See vtkAlgorithm for details. More...

vtkDataObject *	GetOutput ()
	Get the output data object for a port on this algorithm. More...

vtkDataObject *	GetOutput (int)
	Get the output data object for a port on this algorithm. More...

virtual void	SetOutput (vtkDataObject *)
	Get the output data object for a port on this algorithm. More...

vtkHyperTreeGrid *	GetHyperTreeGridOutput ()
	Get the output as a hyper tree grid. More...

vtkHyperTreeGrid *	GetHyperTreeGridOutput (int)
	Get the output as a hyper tree grid. More...

vtkPolyData *	GetPolyDataOutput ()
	Get the output as a polygonal dataset. More...

vtkPolyData *	GetPolyDataOutput (int)
	Get the output as a polygonal dataset. More...

vtkUnstructuredGrid *	GetUnstructuredGridOutput ()
	Get the output as an unstructured grid. More...

vtkUnstructuredGrid *	GetUnstructuredGridOutput (int)
	Get the output as an unstructured grid. More...

void	SetInputData (vtkDataObject *)
	Assign a data object as input. More...

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input. More...

void	AddInputData (vtkDataObject *)
	Assign a data object as input. More...

void	AddInputData (int, vtkDataObject *)
	Assign a data object as input. More...

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

int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped. More...

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request. More...

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm. More...

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm. More...

void	UpdateProgress (double amount)
	Update the progress of the process object. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess(). More...

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...

void	RemoveAllInputs ()
	Remove all the input data. More...

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection. More...

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index. More...

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx. More...

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections. More...

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index. More...

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port. More...

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port. More...

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm. More...

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...

virtual int	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...

virtual int	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date. More...

virtual void	UpdateDataObject ()
	Create output object(s). More...

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream. More...

virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date. More...

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm. More...

void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection. More...

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object. More...

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	SetProgress (double)
	Set/Get the execution progress of a process object. More...

virtual double	GetProgress ()
	Set/Get the execution progress of a process object. More...

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state. More...

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...

virtual void	Update ()
	Bring this algorithm's outputs up-to-date. More...

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports. More...

virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports. More...

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents. More...

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. 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...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

vtkCommand *	GetCommand (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...

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)
	This method invokes an event and return whether the event was aborted or not. More...

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

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. 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...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkHyperTreeGridSource *	SafeDownCast (vtkObjectBase *o)

static vtkHyperTreeGridSource *	New ()

Static Public Member Functions inherited from vtkHyperTreeGridAlgorithm
static vtkTypeBool	IsTypeOf (const char *type)

static vtkHyperTreeGridAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements. More...

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...

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. 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 ()
	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 int	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkHyperTreeGridSource ()

	~vtkHyperTreeGridSource () override

int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector ) override

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass. More...

int	FillOutputPortInformation (int, vtkInformation *) override
	Define default input and output port types. More...

int	ProcessTrees (vtkHyperTreeGrid , vtkDataObject ) override
	Main routine to process individual trees in the grid. More...

int	InitializeFromStringDescriptor (int *extent)
	Initialize grid from descriptor string when it is to be used. More...

int	InitializeFromBitsDescriptor ()
	Initialize grid from bit array descriptors when it is to be used. More...

void	InitTreeFromDescriptor (vtkHyperTreeGrid output, vtkHyperTreeCursor cursor, int treeIdx, int idx[3])
	Initialize tree grid from descriptor and call subdivide if needed. More...

void	SubdivideFromStringDescriptor (vtkHyperTreeGrid output, vtkHyperTreeCursor cursor, unsigned int level, int treeIdx, int childIdx, int idx[3], int parentPos)
	Subdivide grid from descriptor string when it is to be used. More...

void	SubdivideFromBitsDescriptor (vtkHyperTreeGrid output, vtkHyperTreeCursor cursor, unsigned int level, int treeIdx, int childIdx, int idx[3], int parentPos)
	Subdivide grid from descriptor string when it is to be used. More...

void	SubdivideFromQuadric (vtkHyperTreeGrid output, vtkHyperTreeCursor cursor, unsigned int level, int treeIdx, const int idx[3], double origin[3], double size[3])
	Subdivide grid from quadric when descriptor is not used. More...

double	EvaluateQuadric (double[3])
	Evaluate quadric at given point coordinates. More...

Protected Member Functions inherited from vtkHyperTreeGridAlgorithm
	vtkHyperTreeGridAlgorithm ()

	~vtkHyperTreeGridAlgorithm () override

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass. More...

int	FillInputPortInformation (int, vtkInformation *) override
	Define default input and output port types. More...

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm () override

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm. More...

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm. More...

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive. More...

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port. More...

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port. More...

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input. More...

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. 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	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	Origin [3]

double	GridScale [3]

unsigned int	GridSize [3]

bool	TransposedRootIndexing

unsigned int	MaximumLevel

unsigned int	Dimension

unsigned int	Orientation

unsigned int	BranchFactor

unsigned int	BlockSize

bool	UseDescriptor

bool	UseMaterialMask

bool	GenerateInterfaceFields

vtkDataArray *	XCoordinates

vtkDataArray *	YCoordinates

vtkDataArray *	ZCoordinates

char *	Descriptor

char *	MaterialMask

std::vector< std::string >	LevelDescriptors

std::vector< std::string >	LevelMaterialMasks

vtkBitArray *	DescriptorBits

vtkBitArray *	MaterialMaskBits

std::vector< vtkIdType >	LevelBitsIndex

std::vector< vtkIdType >	LevelBitsIndexCnt

vtkIdTypeArray *	LevelZeroMaterialIndex

std::map< vtkIdType, vtkIdType >	LevelZeroMaterialMap

std::vector< int >	LevelCounters

vtkQuadric *	Quadric

vtkHyperTreeGrid *	OutputHTG

Protected Attributes inherited from vtkHyperTreeGridAlgorithm
vtkDataSetAttributes *	InData

vtkDataSetAttributes *	OutData

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Create a synthetic grid of hypertrees.

This class uses input parameters, most notably a string descriptor, to generate a vtkHyperTreeGrid instance representing the corresponding tree-based AMR grid. This descriptor uses the following conventions, e.g., to describe a 1-D ternary subdivision with 2 root cells L0 L1 L2 RR | .R. ... | ... For this tree: HTG: . / \ L0: . . /|\ /|\ L1: c . c c c c /|\ L2: c c c The top level of the tree is not considered a grid level NB: For ease of legibility, white spaces are allowed and ignored.

Thanks:: This class was written by Philippe Pebay, Joachim Pouderoux, and Charles Law, Kitware 2013 This class was modified by Guenole Harel and Jacques-Bernard Lekien 2014 This class was modified by Philippe Pebay, 2016 This work was supported by Commissariat a l'Energie Atomique (CEA/DIF)

Tests:: vtkHyperTreeGridSource (Tests)

Definition at line 65 of file vtkHyperTreeGridSource.h.

Member Typedef Documentation

typedef vtkHyperTreeGridAlgorithm vtkHyperTreeGridSource::Superclass

Definition at line 68 of file vtkHyperTreeGridSource.h.

Constructor & Destructor Documentation

vtkHyperTreeGridSource::vtkHyperTreeGridSource ( )

protected

vtkHyperTreeGridSource::~vtkHyperTreeGridSource ( )

overrideprotected

Member Function Documentation

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

static

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

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

static

virtual vtkObjectBase* vtkHyperTreeGridSource::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkHyperTreeGridAlgorithm.

vtkHyperTreeGridSource* vtkHyperTreeGridSource::NewInstance ( ) const

void vtkHyperTreeGridSource::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 vtkHyperTreeGridAlgorithm.

static vtkHyperTreeGridSource* vtkHyperTreeGridSource::New ( )

static

unsigned int vtkHyperTreeGridSource::GetMaximumLevel ( )

Return the maximum number of levels of the hypertree.

Postcondition: positive_result: result>=1

void vtkHyperTreeGridSource::SetMaximumLevel ( unsigned int levels )

Set the maximum number of levels of the hypertrees.

Precondition: positive_levels: levels>=1

Postcondition: is_set: this->GetLevels()==levels; min_is_valid: this->GetMinLevels()<this->GetLevels()

virtual void vtkHyperTreeGridSource::SetOrigin	(	double	,
		double	,
		double
	)

virtual

Set/Get the origin of the grid.

virtual void vtkHyperTreeGridSource::SetOrigin ( double [3] )

virtual

Set/Get the origin of the grid.

virtual double* vtkHyperTreeGridSource::GetOrigin ( )

virtual

Set/Get the origin of the grid.

virtual void vtkHyperTreeGridSource::GetOrigin	(	double &	,
		double &	,
		double &
	)

virtual

Set/Get the origin of the grid.

virtual void vtkHyperTreeGridSource::GetOrigin ( double [3] )

virtual

Set/Get the origin of the grid.

virtual void vtkHyperTreeGridSource::SetGridScale	(	double	,
		double	,
		double
	)

virtual