PLUTO  4.4-patch2
Data Fields
Grid Struct Reference

#include <structs.h>

Data Fields

double xend [3]
 
double xend_glob [3]
 
double * x_glob [3]
 
double * xr_glob [3]
 
double * xl_glob [3]
 
double * dx_glob [3]
 
double * xgc [3]
 
double *** dV
 
double *** A [3]
 
double ** dx_dl [3]
 
double * rt
 
double * sp
 
double * s
 
double * inv_dx [3]
 
double * inv_dxi [3]
 
double dl_min [3]
 
int np_tot_glob [3]
 
int np_int_glob [3]
 
int np_tot [3]
 
int np_int [3]
 
int nghost [3]
 
int lbound [3]
 
int rbound [3]
 
int gbeg [3]
 
int gend [3]
 
int beg [3]
 
int end [3]
 
int lbeg [3]
 
int lend [3]
 
int nproc [3]
 
int rank_coord [3]
 
int level
 
int * ring_av_csize
 

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.

Field Documentation

◆ A

double*** A[3]

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

◆ beg

int beg[3]

Global start index for the local array.

◆ dl_min

double dl_min[3]

minimum cell length (e.g. min[dr, r*dth, r*sin(th)*dphi] (GLOBAL DOMAIN).

◆ dV

double*** dV

Cell volume.

◆ dx_dl

double** dx_dl[3]

dx/dl (dl = length), used for gradient-like operators

◆ dx_glob

double * dx_glob[3]

Cell width.

◆ end

int end[3]

Global end index for the local array.

◆ gbeg

int gbeg[3]

Global start index for the global array.

◆ gend

int gend[3]

Global end index for the global array.

◆ inv_dx

double* inv_dx[3]

< In spherical coordinates, gives the volume = fabs(cos(th_m) - cos(th_p))

◆ inv_dxi

double* inv_dxi[3]

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

◆ lbeg

int lbeg[3]

Local start index for the local array.

◆ lbound

int lbound[3]

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.

◆ lend

int lend[3]

Local end index for the local array.

◆ level

int level

The current refinement level (chombo only).

◆ nghost

int nghost[3]

Number of ghost zones.

◆ np_int

int np_int[3]

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

◆ np_int_glob

int np_int_glob[3]

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

◆ np_tot

int np_tot[3]

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

◆ np_tot_glob

int np_tot_glob[3]

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

◆ nproc

int nproc[3]

number of processors for this grid.

◆ rank_coord

int rank_coord[3]

Parallel coordinate in a Cartesian topology.

◆ rbound

int rbound[3]

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

◆ ring_av_csize

int* ring_av_csize

The chunk size when RING_AVERAGE is turned on

◆ rt

double* rt

In spherical coordinates, gives {r}

◆ s

double* s

In spherical coordinates, gives fabs(sin(th)) at the cell center

◆ sp

double* sp

In spherical coordinates, gives fabs(sin(th)) at a j+1/2 interface

◆ x_glob

double * x_glob[3]

Cell geometrical central points.

◆ xend

double xend[3]

Leftmost and rightmost points in local domain.

◆ xend_glob

double xend_glob[3]

Leftmost and rightmost point in the global domain.

◆ xgc

double* xgc[3]

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

◆ xl_glob

double * xl_glob[3]

Cell left interface.

◆ xr_glob

double * xr_glob[3]

Cell right interface.


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