PLUTO
GRID Struct Reference

#include <structs.h>

Public Attributes

double xi
 
double xf
 Leftmost and rightmost point in the local domain. More...
 
double * x
 
double * x_glob
 Cell geometrical central points. More...
 
double * xr
 
double * xr_glob
 Cell right interface. More...
 
double * xl
 
double * xl_glob
 Cell left interface. More...
 
double * dx
 
double * dx_glob
 Cell size. More...
 
double * xgc
 Cell volumetric centroid (!= x when geometry != CARTESIAN). More...
 
double * dV
 Cell volume. More...
 
double * A
 Right interface area, A[i] = $A_{i+\HALF}$. More...
 
double * r_1
 Geometrical factor 1/r. More...
 
double * ct
 Geometrical factor cot(theta). More...
 
double * inv_dx
 
double * inv_dxi
 inverse of the distance between the center of two cells, inv_dxi = $\DS \frac{2}{\Delta x_i + \Delta x_{i+1}}$. More...
 
double dl_min
 minimum cell length (e.g. More...
 
int np_tot_glob
 Total number of points in the global domain (boundaries included). More...
 
int np_int_glob
 Total number of points in the global domain (boundaries excluded). More...
 
int np_tot
 Total number of points in the local domain (boundaries included). More...
 
int np_int
 Total number of points in the local domain (boundaries excluded). More...
 
int nghost
 Number of ghost zones. More...
 
int lbound
 When different from zero, it specifies the boundary condition to be applied at leftmost grid side where the physical boundary is located. More...
 
int rbound
 Same as lbound, but for the right edge of the grid. More...
 
int gbeg
 Global start index for the global array. More...
 
int gend
 Global end index for the global array. More...
 
int beg
 Global start index for the local array. More...
 
int end
 Global end index for the local array. More...
 
int lbeg
 Local start index for the local array. More...
 
int lend
 Local end index for the local array. More...
 
int uniform
 
int nproc
 number of processors for this grid. More...
 
int rank_coord
 Parallel coordinate in a Cartesian topology. More...
 
int level
 The current refinement level (chombo only). More...
 
char fill [40]
 

Detailed Description

The PLUTO Grid structure contains information pertaining to the computational mesh in a specific 1D coordinate direction. Since PLUTO assumes a logically rectangular system of coordinates, the whole computational domain is obtained as the cartesian product of 2 or 3 grid structures.
In parallel, each processor owns a different portion of the domain and the grid structures will be different. For this reason, in the following member description, we use the word "global" or "local" to refer the the whole computational domain or to the sub-domain owned by a single processor.

Similarly, variables ending with a "glob" suffix are intended to be global, i.e., they refer to the whole computational stencil and not to the local processor sub-domain.

Definition at line 78 of file structs.h.

Member Data Documentation

double* GRID::A

Right interface area, A[i] = $A_{i+\HALF}$.

Definition at line 87 of file structs.h.

int GRID::beg

Global start index for the local array.

Definition at line 115 of file structs.h.

double* GRID::ct

Geometrical factor cot(theta).

Definition at line 89 of file structs.h.

double GRID::dl_min

minimum cell length (e.g.

min[dr, r*dth, r*sin(th)*dphi] (GLOBAL DOMAIN).

Definition at line 94 of file structs.h.

double* GRID::dV

Cell volume.

Definition at line 86 of file structs.h.

double* GRID::dx

Definition at line 83 of file structs.h.

double * GRID::dx_glob

Cell size.

Definition at line 83 of file structs.h.

int GRID::end

Global end index for the local array.

Definition at line 116 of file structs.h.

char GRID::fill[40]

Definition at line 123 of file structs.h.

int GRID::gbeg

Global start index for the global array.

Definition at line 113 of file structs.h.

int GRID::gend

Global end index for the global array.

Definition at line 114 of file structs.h.

double* GRID::inv_dx

Definition at line 90 of file structs.h.

double* GRID::inv_dxi

inverse of the distance between the center of two cells, inv_dxi = $\DS \frac{2}{\Delta x_i + \Delta x_{i+1}}$.

Definition at line 91 of file structs.h.

int GRID::lbeg

Local start index for the local array.

Definition at line 117 of file structs.h.

int GRID::lbound

When different from zero, it specifies the boundary condition to be applied at leftmost grid side where the physical boundary is located.

Otherwise, it equals zero if the current processor does not touch the leftmost physical boundary. This evantuality (lbound = 0) is possible only in PARALLEL mode.

Definition at line 105 of file structs.h.

int GRID::lend

Local end index for the local array.

Definition at line 118 of file structs.h.

int GRID::level

The current refinement level (chombo only).

Definition at line 122 of file structs.h.

int GRID::nghost

Number of ghost zones.

Definition at line 104 of file structs.h.

int GRID::np_int

Total number of points in the local domain (boundaries excluded).

Definition at line 102 of file structs.h.

int GRID::np_int_glob

Total number of points in the global domain (boundaries excluded).

Definition at line 98 of file structs.h.

int GRID::np_tot

Total number of points in the local domain (boundaries included).

Definition at line 100 of file structs.h.

int GRID::np_tot_glob

Total number of points in the global domain (boundaries included).

Definition at line 96 of file structs.h.

int GRID::nproc

number of processors for this grid.

Definition at line 120 of file structs.h.

double* GRID::r_1

Geometrical factor 1/r.

Definition at line 88 of file structs.h.

int GRID::rank_coord

Parallel coordinate in a Cartesian topology.

Definition at line 121 of file structs.h.

int GRID::rbound

Same as lbound, but for the right edge of the grid.

Definition at line 112 of file structs.h.

int GRID::uniform

Definition at line 119 of file structs.h.

double* GRID::x

Definition at line 80 of file structs.h.

double * GRID::x_glob

Cell geometrical central points.

Definition at line 80 of file structs.h.

double GRID::xf

Leftmost and rightmost point in the local domain.

Definition at line 79 of file structs.h.

double* GRID::xgc

Cell volumetric centroid (!= x when geometry != CARTESIAN).

Definition at line 84 of file structs.h.

double GRID::xi

Definition at line 79 of file structs.h.

double* GRID::xl

Definition at line 82 of file structs.h.

double * GRID::xl_glob

Cell left interface.

Definition at line 82 of file structs.h.

double* GRID::xr

Definition at line 81 of file structs.h.

double * GRID::xr_glob

Cell right interface.

Definition at line 81 of file structs.h.


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