vtkAMRBox Class Reference

#include <vtkAMRBox.h>

List of all members.

---

Detailed Description

represents a 3D uniform region in space

vtkAMRBox is similar to Chombo's Box. It represents a 3D region by storing indices for two corners (LoCorner, HiCorner). A few utility methods are provided.

Definition at line 51 of file vtkAMRBox.h.

Public Member Functions
	vtkAMRBox ()
	vtkAMRBox (int dimensionality, const int *loCorner, const int *hiCorner)
vtkIdType	GetNumberOfCells ()
void	Coarsen (int refinement)
void	Refine (int refinement)
int	DoesContainCell (int i, int j, int k)
int	DoesContainBox (vtkAMRBox const &box) const
void	Print (ostream &os)
bool	IsHiCorner (const int pos[3]) const
bool	IsLoCorner (const int pos[3]) const
Public Attributes
int	LoCorner [3]
int	HiCorner [3]

---

Constructor & Destructor Documentation

vtkAMRBox::vtkAMRBox

(

)

[inline]

Default constructor: lower corner box made of one cell.

Definition at line 68 of file vtkAMRBox.h.

vtkAMRBox::vtkAMRBox	(	int	dimensionality,
		const int *	loCorner,
		const int *	hiCorner
	)			[inline]

Constructor.

Precondition:

dimensionality >= 2 && dimensionality <= 3

Definition at line 76 of file vtkAMRBox.h.

---

Member Function Documentation

vtkIdType vtkAMRBox::GetNumberOfCells

(

)

[inline]

Returns the number of cells (aka elements, zones etc.) in the given region (for the specified refinement, see Coarsen() and Refine() ).

Definition at line 97 of file vtkAMRBox.h.

void vtkAMRBox::Coarsen

(

int

refinement

)

[inline]

Modify LoCorner and HiCorner by coarsening with the given refinement ratio.

Precondition:

valid_refinement: refinement>=2

Definition at line 111 of file vtkAMRBox.h.

void vtkAMRBox::Refine

(

int

refinement

)

[inline]

Modify LoCorner and HiCorner by refining with the given refinement ratio.

Precondition:

valid_refinement: refinement>=2

Definition at line 132 of file vtkAMRBox.h.

int vtkAMRBox::DoesContainCell	(	int	i,
		int	j,
		int	k
	)			[inline]

Returns non-zero if the box contains the cell with given indices.

Definition at line 146 of file vtkAMRBox.h.

int vtkAMRBox::DoesContainBox

(

vtkAMRBox const &

box

)

const [inline]

Returns non-zero if the box contains `box`

Definition at line 157 of file vtkAMRBox.h.

void vtkAMRBox::Print

(

ostream &

os

)

[inline]

Print LoCorner and HiCorner

Definition at line 171 of file vtkAMRBox.h.

bool vtkAMRBox::IsHiCorner

(

const int

pos[3]

)

const [inline]

Check if cell position is HiCorner

Definition at line 182 of file vtkAMRBox.h.

bool vtkAMRBox::IsLoCorner

(

const int

pos[3]

)

const [inline]

Check if cell position is LoCorner

Definition at line 192 of file vtkAMRBox.h.

---

Member Data Documentation

int vtkAMRBox::LoCorner[3]

Cell position of the lower cell and higher cell defining the box. Both cells are defined at the same level of refinement. The refinement level itself is not specified. Invariant: LoCorner<=HiCorner Eg. LoCorner = {0,0,0}, HiCorner = {0,0,0} is an AMRBox with 1 cell

Definition at line 62 of file vtkAMRBox.h.

int vtkAMRBox::HiCorner[3]

Cell position of the lower cell and higher cell defining the box. Both cells are defined at the same level of refinement. The refinement level itself is not specified. Invariant: LoCorner<=HiCorner Eg. LoCorner = {0,0,0}, HiCorner = {0,0,0} is an AMRBox with 1 cell

Definition at line 63 of file vtkAMRBox.h.

---

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

• dox/Filtering/vtkAMRBox.h