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 | List of all members
vtkAMRInformation Class Reference

Meta data that describes the structure of an AMR data set. More...

#include <vtkAMRInformation.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkAMRInformationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
bool operator== (const vtkAMRInformation &other)
 
void Initialize (int numLevels, const int *blocksPerLevel)
 
unsigned int GetNumberOfDataSets (unsigned int level) const
 
void ComputeIndexPair (unsigned int index, unsigned int &level, unsigned int &id)
 
const double * GetBounds ()
 
void GetBounds (unsigned int level, unsigned int id, double *bb)
 
bool GetOrigin (unsigned int level, unsigned int id, double *origin)
 
void GetSpacing (unsigned int level, double spacing[3])
 
bool HasSpacing (unsigned int level)
 
bool GetCoarsenedAMRBox (unsigned int level, unsigned int id, vtkAMRBox &box) const
 
void GenerateRefinementRatio ()
 
bool HasRefinementRatio ()
 
void SetRefinementRatio (unsigned int level, int ratio)
 
int GetRefinementRatio (unsigned int level) const
 
void SetSpacing (unsigned int level, const double *h)
 
bool HasChildrenInformation ()
 
unsigned int * GetParents (unsigned int level, unsigned int index, unsigned int &numParents)
 
unsigned int * GetChildren (unsigned int level, unsigned int index, unsigned int &numChildren)
 
void PrintParentChildInfo (unsigned int level, unsigned int index)
 
void GenerateParentChildInformation ()
 
bool Audit ()
 
bool FindCell (double q[3], unsigned int level, unsigned int index, int &cellIdx)
 
bool FindGrid (double q[3], int level, unsigned int &gridId)
 
bool FindGrid (double q[3], unsigned int &level, unsigned int &gridId)
 
std::vector< std::vector
< unsigned int > > & 
GetChildrenAtLevel (unsigned int i)
 
void DeepCopy (vtkAMRInformation *other)
 
virtual int GetGridDescription ()
 
void SetGridDescription (int description)
 
void GetOrigin (double origin[3])
 
double * GetOrigin ()
 
void SetOrigin (const double *origin)
 
unsigned int GetNumberOfLevels () const
 
unsigned int GetTotalNumberOfBlocks ()
 
int GetIndex (unsigned int level, unsigned int id) const
 
void SetAMRBox (unsigned int level, unsigned int id, const vtkAMRBox &box)
 
const vtkAMRBoxGetAMRBox (unsigned int level, unsigned int id) const
 
int GetAMRBlockSourceIndex (int index)
 
void SetAMRBlockSourceIndex (int index, int sourceId)
 
const std::vector< int > & GetNumBlocks () const
 

Static Public Member Functions

static vtkAMRInformationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAMRInformationSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 

Detailed Description

Meta data that describes the structure of an AMR data set.

vtkAMRInformation encaspulates the following meta information for an AMR data set

Definition at line 47 of file vtkAMRInformation.h.

Member Typedef Documentation

typedef vtkObject vtkAMRInformation::Superclass

Definition at line 51 of file vtkAMRInformation.h.

Member Function Documentation

static vtkAMRInformation* vtkAMRInformation::New ( )
static
static int vtkAMRInformation::IsTypeOf ( const char *  type)
static
virtual int vtkAMRInformation::IsA ( const char *  type)
virtual
static vtkAMRInformation* vtkAMRInformation::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkAMRInformation::NewInstanceInternal ( ) const
protectedvirtual
vtkAMRInformation* vtkAMRInformation::NewInstance ( ) const
void vtkAMRInformation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
bool vtkAMRInformation::operator== ( const vtkAMRInformation other)
void vtkAMRInformation::Initialize ( int  numLevels,
const int *  blocksPerLevel 
)

Initialize the meta information numLevels is the number of levels blocksPerLevel[i] is the number of blocks at level i

virtual int vtkAMRInformation::GetGridDescription ( )
virtual

returns the value of vtkUniformGrid::GridDescription() of any block

void vtkAMRInformation::SetGridDescription ( int  description)

returns the value of vtkUniformGrid::GridDescription() of any block

void vtkAMRInformation::GetOrigin ( double  origin[3])

Get the AMR dataset origin The origin is essentially the minimum of all the grids.

double* vtkAMRInformation::GetOrigin ( )

Get the AMR dataset origin The origin is essentially the minimum of all the grids.

void vtkAMRInformation::SetOrigin ( const double *  origin)

Get the AMR dataset origin The origin is essentially the minimum of all the grids.

unsigned int vtkAMRInformation::GetNumberOfLevels ( ) const
inline

Return the number of levels

Definition at line 77 of file vtkAMRInformation.h.

unsigned int vtkAMRInformation::GetNumberOfDataSets ( unsigned int  level) const

Returns the number of datasets at the given levelx

unsigned int vtkAMRInformation::GetTotalNumberOfBlocks ( )
inline

Returns total number of datasets

Definition at line 86 of file vtkAMRInformation.h.

int vtkAMRInformation::GetIndex ( unsigned int  level,
unsigned int  id 
) const
inline

Returns the single index from a pair of indices

Definition at line 92 of file vtkAMRInformation.h.

void vtkAMRInformation::ComputeIndexPair ( unsigned int  index,
unsigned int &  level,
unsigned int &  id 
)

Returns the an index pair given a single index

const double* vtkAMRInformation::GetBounds ( )

Returns the bounds of the entire domain

void vtkAMRInformation::GetBounds ( unsigned int  level,
unsigned int  id,
double *  bb 
)

Returns the bounding box of a given box

bool vtkAMRInformation::GetOrigin ( unsigned int  level,
unsigned int  id,
double *  origin 
)

Returns the origin of the grid at (level,id)

void vtkAMRInformation::GetSpacing ( unsigned int  level,
double  spacing[3] 
)

Return the spacing at the given fiven

bool vtkAMRInformation::HasSpacing ( unsigned int  level)
void vtkAMRInformation::SetAMRBox ( unsigned int  level,
unsigned int  id,
const vtkAMRBox box 
)

Methods to set and get the AMR box at a given position

const vtkAMRBox& vtkAMRInformation::GetAMRBox ( unsigned int  level,
unsigned int  id 
) const

Methods to set and get the AMR box at a given position

bool vtkAMRInformation::GetCoarsenedAMRBox ( unsigned int  level,
unsigned int  id,
vtkAMRBox box 
) const

return the amr box coarsened to the previous level

int vtkAMRInformation::GetAMRBlockSourceIndex ( int  index)

Get/Set the SourceIndex of a block. Typically, this is a file-type specific index that can be used by a reader to load a particular file block

void vtkAMRInformation::SetAMRBlockSourceIndex ( int  index,
int  sourceId 
)

Get/Set the SourceIndex of a block. Typically, this is a file-type specific index that can be used by a reader to load a particular file block

void vtkAMRInformation::GenerateRefinementRatio ( )

This method computes the refinement ratio at each level. At each level, l, the refinement ratio r_l is computed by r_l = D_{l} / D_{l+1}, where D_{l+1} and D_{l} are the grid spacings at the next and current level respectively. .SECTION Assumptions 1) Within each level, the refinement ratios are the same for all blocks. 2) The refinement ratio is uniform along each dimension of the block.

bool vtkAMRInformation::HasRefinementRatio ( )

Returns Wether refinement ratio has been set (either by calling GenerateRefinementRatio() or by calling SetRefinementRatio()

void vtkAMRInformation::SetRefinementRatio ( unsigned int  level,
int  ratio 
)

Set the refinement ratio at a level. This method should be called for all levels, if called at all.

int vtkAMRInformation::GetRefinementRatio ( unsigned int  level) const

Returns the refinement of a given level.

void vtkAMRInformation::SetSpacing ( unsigned int  level,
const double *  h 
)

Set the spacing at a given level

bool vtkAMRInformation::HasChildrenInformation ( )

Return whether parent child information has been generated

unsigned int* vtkAMRInformation::GetParents ( unsigned int  level,
unsigned int  index,
unsigned int &  numParents 
)

Return a pointer to Parents of a block. The first entry is the number of parents the block has followed by its parent ids in level-1. If none exits it returns NULL.

unsigned int* vtkAMRInformation::GetChildren ( unsigned int  level,
unsigned int  index,
unsigned int &  numChildren 
)

Return a pointer to Children of a block. The first entry is the number of children the block has followed by its childern ids in level+1. If none exits it returns NULL.

void vtkAMRInformation::PrintParentChildInfo ( unsigned int  level,
unsigned int  index 
)

Prints the parents and children of a requested block (Debug Routine)

void vtkAMRInformation::GenerateParentChildInformation ( )

Generate the parent/child relationships - needed to be called before GetParents or GetChildren can be used!

bool vtkAMRInformation::Audit ( )

Checks whether the meta data is internally consistent.

bool vtkAMRInformation::FindCell ( double  q[3],
unsigned int  level,
unsigned int  index,
int &  cellIdx 
)

Given a point q, find whether q is bounded by the data set at (level,index). If it is, set cellIdx to the cell index and return true; otherwise return false

bool vtkAMRInformation::FindGrid ( double  q[3],
int  level,
unsigned int &  gridId 
)

find the grid that contains the point q at the specified level

bool vtkAMRInformation::FindGrid ( double  q[3],
unsigned int &  level,
unsigned int &  gridId 
)

Given a point q, find the highest level grid that contains it.

const std::vector<int>& vtkAMRInformation::GetNumBlocks ( ) const
inline

Returns internal arrays.

Definition at line 188 of file vtkAMRInformation.h.

std::vector<std::vector<unsigned int> >& vtkAMRInformation::GetChildrenAtLevel ( unsigned int  i)
inline

Definition at line 192 of file vtkAMRInformation.h.

void vtkAMRInformation::DeepCopy ( vtkAMRInformation other)

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