RBOX Struct Reference

#include <structs.h>

Public Attributes
int	ib
	Lower corner index in the x1 direction. More...
int	ie
	Upper corner index in the x1 direction. More...
int	jb
	Lower corner index in the x2 direction. More...
int	je
	Upper corner index in the x2 direction. More...
int	kb
	Lower corner index in the x3 direction. More...
int	ke
	Upper corner index in the x3 direction. More...
int	di
	Directional increment (+1 or -1) when looping over the 1st dimension of the box. More...
int	dj
	Directional increment (+1 or -1) when looping over the 2nd dimension of the box. More...
int	dk
	Directional increment (+1 or -1) when looping over the 3rd dimension of the box. More...
int	vpos
	Location of the variable inside the cell. More...

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.

Definition at line 346 of file structs.h.

Member Data Documentation

int RBOX::di

Directional increment (+1 or -1) when looping over the 1st dimension of the box.

Automatically set by the BOX_LOOP macro.

Definition at line 353 of file structs.h.

int RBOX::dj

Directional increment (+1 or -1) when looping over the 2nd dimension of the box.

Automatically set by the BOX_LOOP macro.

Definition at line 355 of file structs.h.

int RBOX::dk

Directional increment (+1 or -1) when looping over the 3rd dimension of the box.

Automatically set by the BOX_LOOP macro.

Definition at line 357 of file structs.h.

int RBOX::ib

Lower corner index in the x1 direction.

Definition at line 347 of file structs.h.

int RBOX::ie

Upper corner index in the x1 direction.

Definition at line 348 of file structs.h.

int RBOX::jb

Lower corner index in the x2 direction.

Definition at line 349 of file structs.h.

int RBOX::je

Upper corner index in the x2 direction.

Definition at line 350 of file structs.h.

int RBOX::kb

Lower corner index in the x3 direction.

Definition at line 351 of file structs.h.

int RBOX::ke

Upper corner index in the x3 direction.

Definition at line 352 of file structs.h.

int RBOX::vpos

Location of the variable inside the cell.

Definition at line 359 of file structs.h.

---

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

• Src/structs.h