PLUTO
globals.h File Reference

Collects global variables definitions. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Variables

int SZ
 
int SZ_stagx
 
int SZ_stagy
 
int SZ_stagz
 
int SZ_float
 
int SZ_char
 
int SZ_Float_Vect
 
int SZ_rgb
 
int SZ_short
 
int prank
 Processor rank. More...
 
long int IBEG
 Lower grid index of the computational domain in the the X1 direction for the local processor. More...
 
long int IEND
 Upper grid index of the computational domain in the the X1 direction for the local processor. More...
 
long int JBEG
 Lower grid index of the computational domain in the the X2 direction for the local processor. More...
 
long int JEND
 Upper grid index of the computational domain in the the X2 direction for the local processor. More...
 
long int KBEG
 Lower grid index of the computational domain in the the X3 direction for the local processor. More...
 
long int KEND
 Upper grid index of the computational domain in the the X3 direction for the local processor. More...
 
long int NX1
 Number of interior zones in the X1 directions (boundaries excluded) for the local processor. More...
 
long int NX2
 Number of interior zones in the X2 directions (boundaries excluded) for the local processor. More...
 
long int NX3
 Number of interior zones in the X3 directions (boundaries excluded) for the local processor. More...
 
long int NX1_TOT
 Total number of zones in the X1 direction (boundaries included) for the local processor. More...
 
long int NX2_TOT
 Total number of zones in the X2 direction (boundaries included) for the local processor. More...
 
long int NX3_TOT
 Total number of zones in the X3 direction (boundaries included) for the local processor. More...
 
long int NMAX_POINT
 Maximum number of points among the three directions, boundaries excluded. More...
 
int g_i
 x1 grid index when sweeping along the x2 or x3 direction. More...
 
int g_j
 x2 grid index when sweeping along the x1 or x3 direction. More...
 
int g_k
 x3 grid index when sweeping along the x1 or x2 direction. More...
 
int g_dir
 Specifies the current sweep or direction of integration. More...
 
int g_maxRiemannIter
 Maximum number of iterations for iterative Riemann Solver. More...
 
int g_maxRootIter
 Maximum number of iterations for root finder. More...
 
long int g_usedMemory
 Amount of used memory in bytes. More...
 
long int g_stepNumber
 Gives the current integration step number. More...
 
int g_intStage
 Gives the current integration stage of the time stepping method (predictor = 0, 1st corrector = 1, and so on). More...
 
int g_operatorStep
 Gives the current operator step. More...
 
double g_maxCoolingRate = 0.1
 The maximum fractional variation due to cooling from one step to the next. More...
 
double g_minCoolingTemp = 50.0
 The minimum temperature (in K) below which cooling is suppressed. More...
 
double g_smallDensity = 1.e-12
 Small value for density fix. More...
 
double g_smallPressure = 1.e-12
 Small value for pressure fix. More...
 
double g_gamma = 5./3.
 
double g_time
 The current integration time. More...
 
double g_dt
 The current integration time step. More...
 
double g_maxMach
 The maximum Mach number computed during integration. More...
 
double g_domBeg [3]
 Lower limits of the computational domain. More...
 
double g_domEnd [3]
 Upper limits of the computational domain. More...
 
double g_inputParam [32]
 Array containing the user-defined parameters. More...
 
Direction-dependent Vector Labels

Vector indices permuted during sweeps are used to distinguish between normal ("n"), tangent ("t") and bi-tangent ("b") directions. In vector notations, $ \hvec{b} = \hvec{n} \times \hvec{t} $, they form a right-handed triad. Values are set in the SetIndex() function before commencing integration.

int VXn
 
int VXt
 
int VXb
 
int MXn
 
int MXt
 
int MXb
 
int BXn
 
int BXt
 
int BXb
 
int VXn_D
 
int VXt_D
 
int VXb_D
 
int MXn_D
 
int MXt_D
 
int MXb_D
 

Detailed Description

Collects global variables definitions.

This file contains definitions for all global variables (visible anywhere in the code) used by PLUTO. Global variables names, by convention, are prefixed with a "g_" unless they're used as constants throughout the code in which case they keep the full-capitalized notation typical of macros.

For modules, global variables are prefixed with the initial letters of the module name, e.g., sb_vy or glm_ch.

In the following "local" means "for the local processor". "Interior" means inside the computational domain.

Author
A. Mignone (migno.nosp@m.ne@p.nosp@m.h.uni.nosp@m.to.i.nosp@m.t)
Date
Sep 16, 2012

Definition in file globals.h.

Variable Documentation

int BXb

Definition at line 75 of file globals.h.

int BXn

Definition at line 75 of file globals.h.

int BXt

Definition at line 75 of file globals.h.

int g_dir

Specifies the current sweep or direction of integration.

Its value is set usually in the time stepping functions and can take the values

  • IDIR, for integration in the X1 dir;
  • JDIR, for integration in the X2 dir;
  • KDIR, for integration in the X3 dir;

Definition at line 86 of file globals.h.

double g_domBeg[3]

Lower limits of the computational domain.

Definition at line 125 of file globals.h.

double g_domEnd[3]

Upper limits of the computational domain.

Definition at line 126 of file globals.h.

double g_dt

The current integration time step.

Definition at line 118 of file globals.h.

double g_gamma = 5./3.

Definition at line 112 of file globals.h.

int g_i

x1 grid index when sweeping along the x2 or x3 direction.

Definition at line 82 of file globals.h.

double g_inputParam[32]

Array containing the user-defined parameters.

The index names of this array are defined in definitions.h through the python interface.

Definition at line 131 of file globals.h.

int g_intStage

Gives the current integration stage of the time stepping method (predictor = 0, 1st corrector = 1, and so on).

Definition at line 98 of file globals.h.

int g_j

x2 grid index when sweeping along the x1 or x3 direction.

Definition at line 83 of file globals.h.

int g_k

x3 grid index when sweeping along the x1 or x2 direction.

Definition at line 84 of file globals.h.

double g_maxCoolingRate = 0.1

The maximum fractional variation due to cooling from one step to the next.

Definition at line 104 of file globals.h.

double g_maxMach

The maximum Mach number computed during integration.

Definition at line 119 of file globals.h.

int g_maxRiemannIter

Maximum number of iterations for iterative Riemann Solver.

Definition at line 93 of file globals.h.

int g_maxRootIter

Maximum number of iterations for root finder.

Definition at line 95 of file globals.h.

double g_minCoolingTemp = 50.0

The minimum temperature (in K) below which cooling is suppressed.

Definition at line 106 of file globals.h.

int g_operatorStep

Gives the current operator step.

(HYPERBOLIC_STEP/PARABOLIC_STEP/SOURCE_STEP).

Definition at line 101 of file globals.h.

double g_smallDensity = 1.e-12

Small value for density fix.

Definition at line 109 of file globals.h.

double g_smallPressure = 1.e-12

Small value for pressure fix.

Definition at line 110 of file globals.h.

long int g_stepNumber

Gives the current integration step number.

Definition at line 97 of file globals.h.

double g_time

The current integration time.

Definition at line 117 of file globals.h.

long int g_usedMemory

Amount of used memory in bytes.

Definition at line 96 of file globals.h.

long int IBEG

Lower grid index of the computational domain in the the X1 direction for the local processor.

Definition at line 35 of file globals.h.

long int IEND

Upper grid index of the computational domain in the the X1 direction for the local processor.

Definition at line 37 of file globals.h.

long int JBEG

Lower grid index of the computational domain in the the X2 direction for the local processor.

Definition at line 39 of file globals.h.

long int JEND

Upper grid index of the computational domain in the the X2 direction for the local processor.

Definition at line 41 of file globals.h.

long int KBEG

Lower grid index of the computational domain in the the X3 direction for the local processor.

Definition at line 43 of file globals.h.

long int KEND

Upper grid index of the computational domain in the the X3 direction for the local processor.

Definition at line 45 of file globals.h.

int MXb

Definition at line 74 of file globals.h.

int MXb_D

Definition at line 78 of file globals.h.

int MXn

Definition at line 74 of file globals.h.

int MXn_D

Definition at line 78 of file globals.h.

int MXt

Definition at line 74 of file globals.h.

int MXt_D

Definition at line 78 of file globals.h.

long int NMAX_POINT

Maximum number of points among the three directions, boundaries excluded.

Definition at line 62 of file globals.h.

long int NX1

Number of interior zones in the X1 directions (boundaries excluded) for the local processor.

Definition at line 48 of file globals.h.

long int NX1_TOT

Total number of zones in the X1 direction (boundaries included) for the local processor.

Definition at line 55 of file globals.h.

long int NX2

Number of interior zones in the X2 directions (boundaries excluded) for the local processor.

Definition at line 50 of file globals.h.

long int NX2_TOT

Total number of zones in the X2 direction (boundaries included) for the local processor.

Definition at line 57 of file globals.h.

long int NX3

Number of interior zones in the X3 directions (boundaries excluded) for the local processor.

Definition at line 52 of file globals.h.

long int NX3_TOT

Total number of zones in the X3 direction (boundaries included) for the local processor.

Definition at line 59 of file globals.h.

int prank

Processor rank.

In serial mode it is defined to be 0.

Definition at line 33 of file globals.h.

int SZ

Definition at line 23 of file globals.h.

int SZ_char

Definition at line 28 of file globals.h.

int SZ_float

Definition at line 27 of file globals.h.

int SZ_Float_Vect

Definition at line 29 of file globals.h.

int SZ_rgb

Definition at line 30 of file globals.h.

int SZ_short

Definition at line 31 of file globals.h.

int SZ_stagx

Definition at line 24 of file globals.h.

int SZ_stagy

Definition at line 25 of file globals.h.

int SZ_stagz

Definition at line 26 of file globals.h.

int VXb

Definition at line 73 of file globals.h.

int VXb_D

Definition at line 77 of file globals.h.

int VXn

Definition at line 73 of file globals.h.

int VXn_D

Definition at line 77 of file globals.h.

int VXt

Definition at line 73 of file globals.h.

int VXt_D

Definition at line 77 of file globals.h.