VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkHyperTreeGridSource Class Reference

Create a synthetic grid of hypertrees. More...

#include <vtkHyperTreeGridSource.h>

Inherits vtkHyperTreeGridAlgorithm.

Public Types

typedef vtkHyperTreeGridAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkHyperTreeGridSourceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
unsigned int GetMaximumLevel ()
 
void SetMaximumLevel (unsigned int levels)
 
virtual void SetLevelZeroMaterialIndex (vtkIdTypeArray *)
 
unsigned long GetMTime ()
 
virtual void SetOrigin (double, double, double)
 
virtual void SetOrigin (double[3])
 
virtual double * GetOrigin ()
 
virtual void GetOrigin (double &, double &, double &)
 
virtual void GetOrigin (double[3])
 
virtual void SetGridScale (double, double, double)
 
virtual void SetGridScale (double[3])
 
virtual double * GetGridScale ()
 
virtual void GetGridScale (double &, double &, double &)
 
virtual void GetGridScale (double[3])
 
virtual void SetGridSize (unsigned int, unsigned int, unsigned int)
 
virtual void SetGridSize (unsigned int[3])
 
virtual unsigned int * GetGridSize ()
 
virtual void GetGridSize (unsigned int &, unsigned int &, unsigned int &)
 
virtual void GetGridSize (unsigned int[3])
 
virtual void SetTransposedRootIndexing (bool)
 
virtual bool GetTransposedRootIndexing ()
 
void SetIndexingModeToKJI ()
 
void SetIndexingModeToIJK ()
 
virtual void SetBranchFactor (unsigned int)
 
virtual unsigned int GetBranchFactor ()
 
virtual void SetDimension (unsigned int)
 
virtual unsigned int GetDimension ()
 
virtual void SetUseDescriptor (bool)
 
virtual bool GetUseDescriptor ()
 
virtual void UseDescriptorOn ()
 
virtual void UseDescriptorOff ()
 
virtual void SetUseMaterialMask (bool)
 
virtual bool GetUseMaterialMask ()
 
virtual void UseMaterialMaskOn ()
 
virtual void UseMaterialMaskOff ()
 
virtual void SetDescriptor (const char *)
 
virtual char * GetDescriptor ()
 
virtual void SetMaterialMask (const char *)
 
virtual char * GetMaterialMask ()
 
virtual void SetDescriptorBits (vtkBitArray *)
 
virtual vtkBitArray * GetDescriptorBits ()
 
virtual void SetMaterialMaskBits (vtkBitArray *)
 
virtual vtkBitArray * GetMaterialMaskBits ()
 
virtual void SetQuadric (vtkQuadric *)
 
virtual vtkQuadric * GetQuadric ()
 
void SetQuadricCoefficients (double[10])
 
void GetQuadricCoefficients (double[10])
 
double * GetQuadricCoefficients ()
 
vtkBitArray * ConvertDescriptorStringToBitArray (const vtkStdString &)
 
vtkBitArray * ConvertMaterialMaskStringToBitArray (const vtkStdString &)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkHyperTreeGridSourceSafeDownCast (vtkObjectBase *o)
 
static vtkHyperTreeGridSourceNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkHyperTreeGridSource ()
 
 ~vtkHyperTreeGridSource ()
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
int InitializeFromStringDescriptor ()
 
int InitializeFromBitsDescriptor ()
 
double EvaluateQuadric (double[3])
 
void InitTreeFromDescriptor (vtkHyperTreeCursor *cursor, int treeIdx, int idx[3])
 
void SubdivideFromStringDescriptor (vtkHyperTreeCursor *cursor, unsigned int level, int treeIdx, int childIdx, int idx[3], int parentPos)
 
void SubdivideFromBitsDescriptor (vtkHyperTreeCursor *cursor, unsigned int level, int treeIdx, int childIdx, int idx[3], int parentPos)
 
void SubdivideFromQuadric (vtkHyperTreeCursor *cursor, unsigned int level, int treeIdx, int idx[3], double origin[3], double size[3])
 

Protected Attributes

double Origin [3]
 
double GridScale [3]
 
unsigned int GridSize [3]
 
bool TransposedRootIndexing
 
unsigned int MaximumLevel
 
unsigned int Dimension
 
unsigned int BranchFactor
 
unsigned int BlockSize
 
bool UseDescriptor
 
bool UseMaterialMask
 
vtkDataArray * XCoordinates
 
vtkDataArray * YCoordinates
 
vtkDataArray * ZCoordinates
 
char * Descriptor
 
char * MaterialMask
 
std::vector< vtkStdString > LevelDescriptors
 
std::vector< vtkStdString > 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 * Output
 

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: /* 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 and Joachim Pouderoux, Kitware 2013 This work was supported in part by Commissariat a l'Energie Atomique (CEA/DIF)
Examples:
vtkHyperTreeGridSource (Examples)
Tests:
vtkHyperTreeGridSource (Tests)

Definition at line 58 of file vtkHyperTreeGridSource.h.

Member Typedef Documentation

typedef vtkHyperTreeGridAlgorithm vtkHyperTreeGridSource::Superclass

Definition at line 61 of file vtkHyperTreeGridSource.h.

Constructor & Destructor Documentation

vtkHyperTreeGridSource::vtkHyperTreeGridSource ( )
protected
vtkHyperTreeGridSource::~vtkHyperTreeGridSource ( )
protected

Member Function Documentation

static int vtkHyperTreeGridSource::IsTypeOf ( const char *  type)
static
virtual int vtkHyperTreeGridSource::IsA ( const char *  type)
virtual
static vtkHyperTreeGridSource* vtkHyperTreeGridSource::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkHyperTreeGridSource::NewInstanceInternal ( ) const
protectedvirtual
vtkHyperTreeGridSource* vtkHyperTreeGridSource::NewInstance ( ) const
void vtkHyperTreeGridSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 hypertree.

Precondition
positive_levels: levels>=1
Postcondition
is_set: this->GetLevels()==levels
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

Set/Get the scale to be applied to root cells in each dimension of the grid

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

Set/Get the scale to be applied to root cells in each dimension of the grid

virtual double* vtkHyperTreeGridSource::GetGridScale ( )
virtual

Set/Get the scale to be applied to root cells in each dimension of the grid

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

Set/Get the scale to be applied to root cells in each dimension of the grid

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

Set/Get the scale to be applied to root cells in each dimension of the grid

virtual void vtkHyperTreeGridSource::SetGridSize ( unsigned  int,
unsigned  int,
unsigned  int 
)
virtual

Set/Get the number of root cells in each dimension of the grid

virtual void vtkHyperTreeGridSource::SetGridSize ( unsigned  int[3])
virtual

Set/Get the number of root cells in each dimension of the grid

virtual unsigned int* vtkHyperTreeGridSource::GetGridSize ( )
virtual

Set/Get the number of root cells in each dimension of the grid

virtual void vtkHyperTreeGridSource::GetGridSize ( unsigned int &  ,
unsigned int &  ,
unsigned int &   
)
virtual

Set/Get the number of root cells in each dimension of the grid

virtual void vtkHyperTreeGridSource::GetGridSize ( unsigned  int[3])
virtual

Set/Get the number of root cells in each dimension of the grid

virtual void vtkHyperTreeGridSource::SetTransposedRootIndexing ( bool  )
virtual

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

virtual bool vtkHyperTreeGridSource::GetTransposedRootIndexing ( )
virtual

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

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

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

virtual void vtkHyperTreeGridSource::SetBranchFactor ( unsigned  int)
virtual

Set/Get the subdivision factor in the grid refinement scheme

virtual unsigned int vtkHyperTreeGridSource::GetBranchFactor ( )
virtual

Set/Get the subdivision factor in the grid refinement scheme

virtual void vtkHyperTreeGridSource::SetDimension ( unsigned  int)
virtual

Set/Get the dimensionality of the grid

virtual unsigned int vtkHyperTreeGridSource::GetDimension ( )
virtual

Set/Get the dimensionality of the grid

virtual void vtkHyperTreeGridSource::SetUseDescriptor ( bool  )
virtual

Set/get whether the descriptor string should be used. NB: Otherwise a quadric definition is expected. Default: true

virtual bool vtkHyperTreeGridSource::GetUseDescriptor ( )
virtual

Set/get whether the descriptor string should be used. NB: Otherwise a quadric definition is expected. Default: true

virtual void vtkHyperTreeGridSource::UseDescriptorOn ( )
virtual

Set/get whether the descriptor string should be used. NB: Otherwise a quadric definition is expected. Default: true

virtual void vtkHyperTreeGridSource::UseDescriptorOff ( )
virtual

Set/get whether the descriptor string should be used. NB: Otherwise a quadric definition is expected. Default: true

virtual void vtkHyperTreeGridSource::SetUseMaterialMask ( bool  )
virtual

Set/get whether the material mask should be used. NB: This is only used when UseDescriptor is ON Default: false

virtual bool vtkHyperTreeGridSource::GetUseMaterialMask ( )
virtual

Set/get whether the material mask should be used. NB: This is only used when UseDescriptor is ON Default: false

virtual void vtkHyperTreeGridSource::UseMaterialMaskOn ( )
virtual

Set/get whether the material mask should be used. NB: This is only used when UseDescriptor is ON Default: false

virtual void vtkHyperTreeGridSource::UseMaterialMaskOff ( )
virtual

Set/get whether the material mask should be used. NB: This is only used when UseDescriptor is ON Default: false

virtual void vtkHyperTreeGridSource::SetDescriptor ( const char *  )
virtual

Set/Get the string used to describe the grid

virtual char* vtkHyperTreeGridSource::GetDescriptor ( )
virtual

Set/Get the string used to describe the grid

virtual void vtkHyperTreeGridSource::SetMaterialMask ( const char *  )
virtual

Set/Get the string used to as a material mask

virtual char* vtkHyperTreeGridSource::GetMaterialMask ( )
virtual

Set/Get the string used to as a material mask

virtual void vtkHyperTreeGridSource::SetDescriptorBits ( vtkBitArray *  )
virtual

Set/Get the bitarray used to describe the grid

virtual vtkBitArray* vtkHyperTreeGridSource::GetDescriptorBits ( )
virtual

Set/Get the bitarray used to describe the grid

virtual void vtkHyperTreeGridSource::SetLevelZeroMaterialIndex ( vtkIdTypeArray *  )
virtual

Set the index array used to as a material mask

virtual void vtkHyperTreeGridSource::SetMaterialMaskBits ( vtkBitArray *  )
virtual

Set/Get the bitarray used as a material mask

virtual vtkBitArray* vtkHyperTreeGridSource::GetMaterialMaskBits ( )
virtual

Set/Get the bitarray used as a material mask

virtual void vtkHyperTreeGridSource::SetQuadric ( vtkQuadric *  )
virtual

Set/Get the quadric function

virtual vtkQuadric* vtkHyperTreeGridSource::GetQuadric ( )
virtual

Set/Get the quadric function

void vtkHyperTreeGridSource::SetQuadricCoefficients ( double  [10])

Helpers to set/get the 10 coefficients of the quadric function

void vtkHyperTreeGridSource::GetQuadricCoefficients ( double  [10])

Helpers to set/get the 10 coefficients of the quadric function

double* vtkHyperTreeGridSource::GetQuadricCoefficients ( )

Helpers to set/get the 10 coefficients of the quadric function

unsigned long vtkHyperTreeGridSource::GetMTime ( )

Override GetMTime because we delegate to a vtkQuadric

vtkBitArray* vtkHyperTreeGridSource::ConvertDescriptorStringToBitArray ( const vtkStdString &  )

Helpers to convert string descriptors & mask to bit arrays

vtkBitArray* vtkHyperTreeGridSource::ConvertMaterialMaskStringToBitArray ( const vtkStdString &  )

Helpers to convert string descriptors & mask to bit arrays

int vtkHyperTreeGridSource::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected
virtual int vtkHyperTreeGridSource::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
int vtkHyperTreeGridSource::InitializeFromStringDescriptor ( )
protected

Initialize grid from descriptor string when it is to be used

int vtkHyperTreeGridSource::InitializeFromBitsDescriptor ( )
protected

Initialize grid from bit array descriptors when it is to be used

void vtkHyperTreeGridSource::InitTreeFromDescriptor ( vtkHyperTreeCursor *  cursor,
int  treeIdx,
int  idx[3] 
)
protected

Initialize tree grid from descriptor and call subdivide if needed

void vtkHyperTreeGridSource::SubdivideFromStringDescriptor ( vtkHyperTreeCursor *  cursor,
unsigned int  level,
int  treeIdx,
int  childIdx,
int  idx[3],
int  parentPos 
)
protected

Subdivide grid from descriptor string when it is to be used

void vtkHyperTreeGridSource::SubdivideFromBitsDescriptor ( vtkHyperTreeCursor *  cursor,
unsigned int  level,
int  treeIdx,
int  childIdx,
int  idx[3],
int  parentPos 
)
protected

Subdivide grid from descriptor string when it is to be used

void vtkHyperTreeGridSource::SubdivideFromQuadric ( vtkHyperTreeCursor *  cursor,
unsigned int  level,
int  treeIdx,
int  idx[3],
double  origin[3],
double  size[3] 
)
protected

Subdivide grid from quadric when descriptor is not used

double vtkHyperTreeGridSource::EvaluateQuadric ( double  [3])
protected

Evaluate quadric at given point coordinates

Member Data Documentation

double vtkHyperTreeGridSource::Origin[3]
protected

Definition at line 238 of file vtkHyperTreeGridSource.h.

double vtkHyperTreeGridSource::GridScale[3]
protected

Definition at line 239 of file vtkHyperTreeGridSource.h.

unsigned int vtkHyperTreeGridSource::GridSize[3]
protected

Definition at line 240 of file vtkHyperTreeGridSource.h.

bool vtkHyperTreeGridSource::TransposedRootIndexing
protected

Definition at line 241 of file vtkHyperTreeGridSource.h.

unsigned int vtkHyperTreeGridSource::MaximumLevel
protected

Definition at line 242 of file vtkHyperTreeGridSource.h.

unsigned int vtkHyperTreeGridSource::Dimension
protected

Definition at line 243 of file vtkHyperTreeGridSource.h.

unsigned int vtkHyperTreeGridSource::BranchFactor
protected

Definition at line 244 of file vtkHyperTreeGridSource.h.

unsigned int vtkHyperTreeGridSource::BlockSize
protected

Definition at line 245 of file vtkHyperTreeGridSource.h.

bool vtkHyperTreeGridSource::UseDescriptor
protected

Definition at line 246 of file vtkHyperTreeGridSource.h.

bool vtkHyperTreeGridSource::UseMaterialMask
protected

Definition at line 247 of file vtkHyperTreeGridSource.h.

vtkDataArray* vtkHyperTreeGridSource::XCoordinates
protected

Definition at line 249 of file vtkHyperTreeGridSource.h.

vtkDataArray* vtkHyperTreeGridSource::YCoordinates
protected

Definition at line 250 of file vtkHyperTreeGridSource.h.

vtkDataArray* vtkHyperTreeGridSource::ZCoordinates
protected

Definition at line 251 of file vtkHyperTreeGridSource.h.

char* vtkHyperTreeGridSource::Descriptor
protected

Definition at line 253 of file vtkHyperTreeGridSource.h.

char* vtkHyperTreeGridSource::MaterialMask
protected

Definition at line 254 of file vtkHyperTreeGridSource.h.

std::vector<vtkStdString> vtkHyperTreeGridSource::LevelDescriptors
protected

Definition at line 255 of file vtkHyperTreeGridSource.h.

std::vector<vtkStdString> vtkHyperTreeGridSource::LevelMaterialMasks
protected

Definition at line 256 of file vtkHyperTreeGridSource.h.

vtkBitArray* vtkHyperTreeGridSource::DescriptorBits
protected

Definition at line 258 of file vtkHyperTreeGridSource.h.

vtkBitArray* vtkHyperTreeGridSource::MaterialMaskBits
protected

Definition at line 259 of file vtkHyperTreeGridSource.h.

std::vector<vtkIdType> vtkHyperTreeGridSource::LevelBitsIndex
protected

Definition at line 260 of file vtkHyperTreeGridSource.h.

std::vector<vtkIdType> vtkHyperTreeGridSource::LevelBitsIndexCnt
protected

Definition at line 261 of file vtkHyperTreeGridSource.h.

vtkIdTypeArray* vtkHyperTreeGridSource::LevelZeroMaterialIndex
protected

Definition at line 263 of file vtkHyperTreeGridSource.h.

std::map<vtkIdType, vtkIdType> vtkHyperTreeGridSource::LevelZeroMaterialMap
protected

Definition at line 264 of file vtkHyperTreeGridSource.h.

std::vector<int> vtkHyperTreeGridSource::LevelCounters
protected

Definition at line 266 of file vtkHyperTreeGridSource.h.

vtkQuadric* vtkHyperTreeGridSource::Quadric
protected

Definition at line 268 of file vtkHyperTreeGridSource.h.

vtkHyperTreeGrid* vtkHyperTreeGridSource::Output
protected

Definition at line 270 of file vtkHyperTreeGridSource.h.


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