RBox Struct Reference

#include <pluto.h>

Data Fields
int	ib
int	ie
int	jb
int	je
int	kb
int	ke
int	di
int	dj
int	dk
int	vpos

Detailed Description

The RBox (= Rectangular Box) defines a rectangular portion of the domain in terms of the grid indices [ib,jb,kb] corresponding to the lower corner and [ie,je,ke] corresponding to the upper corner. The integer vpos specifies the variable location with respect to the grid (e.g. center/staggered).

Note

The lower and upper grid indices may also be reversed (e.g. box->ib > box->ie). In this case the macro BOX_LOOP automatically reset the directional increment (box->di) to -1.

Field Documentation

int di

Directional increment (+1 or -1) when looping over the 1st dimension of the box. Automatically set by the BOX_LOOP macro.

int dj

Directional increment (+1 or -1) when looping over the 2nd dimension of the box. Automatically set by the BOX_LOOP macro.

int dk

Directional increment (+1 or -1) when looping over the 3rd dimension of the box. Automatically set by the BOX_LOOP macro.

int ib

Lower corner index in the x1 direction.

int ie

Upper corner index in the x1 direction.

int jb

Lower corner index in the x2 direction.

int je

Upper corner index in the x2 direction.

int kb

Lower corner index in the x3 direction.

int ke

Upper corner index in the x3 direction.

int vpos

Location of the variable inside the cell.

---

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

• /home/Andrea/PLUTO/Src/pluto.h