global.nondepmnemonics.h

Go to the documentation of this file.

#include "metric.h"
#include "coord.h"





// define how to access symmetric matrices with size 4x4 without redundant elements

// 1) regexp: gcov\[\([_>a-zA-Z0-9+-\ ()]+\)\]\[\([_>a-zA-Z0-9+-\ ()]+\)\] -> gcov[GIND(\1,\2)]
// Then revert: gcov\[GIND( *NDIM *, *NDIM *)\] -> gcov[SYMMATRIXNDIM] since otherwise will be 1 larger than required
// also need to catch: localgcon gcon gcovinfunc gcovtovks gcovbhks gcovmcoord gcovmid tmpgcov gcovprim tmpgcon glgen ghgen
// 2) Then need to replace any multi-D pointer arg type with simple arg type:
// FTYPE (**localgcov)[NDIM] -> FTYPE **localgcov
// 3) Then need to get all global variables with [NDIM][NDIM]
// 4) Also get *gcov type things:  (\*gcov)\[NDIM\] -> *gcov
//    also need to catch: gcon gcovinfunc gcovinfuncprim gcovprim gconprim gcovmcoord gcovptr gconptr
// 5) If making assignment TO something using GIND(), then must control loops.
//    E.g. tetrad.c:tetr_func_frommetric(): newgcov[GIND(jj,kk)] +=
//   Find some maybe by doing: grep -e "+ \{0,\}=" *.c *.h | grep GIND
// Compared new and old codes by doing:
// for fil in `ls -d *.c *.h`; do echo $fil; diff -bBdpy -W 600 --suppress-common-lines $fil $1/$fil >>newcodediff.txt ; done ; less newcodediff.txt
// Check for name mangling: grep "gcov" newcodediff.txt | grep "gcon" | less

// below are non-conditional ways of getting same result as:
//#define GCOVI(i,j) (i>=j) ? i : j
//#define GCOVJ(i,j) (i>=j) ? j : i
#define GCOVI(i,j) (((i)>=(j))*((i)-(j)) + (j))
#define GCOVJ(i,j) (((i)>=(j))*((j)-(i)) + (i))
#define GIND(i,j) GCOVJ(i,j)*4 + GCOVI(i,j) - MAX(GCOVJ(i,j),0) - MAX(GCOVJ(i,j)-1,0) - MAX(GCOVJ(i,j)-2,0)

#define GINDASSIGNFACTOR(i,j) (1.0*((i)>=(j)))
//#if(PRODUCTION==0)
//#define GINDASSIGNMAC(name,i,j) (i>=j ? name[GIND(i,j)] : SHOULDNOTREACHHEREEVERBUGYOUHAVE())
//#else
//#define GINDASSIGNMAC(name,i,j) name[GIND(i,j)]
//#endif


#define USEGSL (USINGGSL)


#define NRANC 64



#define NUMJETS 2
#define INNERJET 0
#define OUTERJET 1


#define QUASISTRANG 0
#define UNSPLIT 1
#define PERFECTUNSPLIT 2


#define NUMENERREGIONS 8

#define NULLENERREGIONS -2 // indicates avoid processes that operate on this region
#define ALLENERREGIONS -1 // to indicate not just one region
#define GLOBALENERREGION 0 // standard computational grid

#define OUTSIDEHORIZONENERREGION 1 // "outside" horizon: i>ihorizon


#define TRUEGLOBALENERREGION 2 // max(0,ihorizon-nbnd)
#define TRUEGLOBALWITHBNDENERREGION 3 // outside horizon with boundary cells: max(-nbnd,ihorizon-2*nbnd)

#define ACTIVEREGION 4  // only active computational cells
#define ACTIVEWITHBNDREGION 5  // ACTIVEREGION+required boundary cells

#define INNERJETREGION 6 // lower-\theta jet region
#define OUTERJETREGION 7 // upper-\theta jet region


#define VERYLOCALVCHAR 0
#define LOCALVCHAR 1
#define GLOBALVCHAR 2

#define MINDTSET(dt1,dt2,dt3) (1.0/(1.0/(dt1) + 1.0/(dt2) + 1.0/(dt3)))

//#define MINDTSET(dt1,dt2,dt3) (MIN(MIN((dt1),(dt2)),(dt3)))

// relativistically inspired (based upon RADBEAMFLAT)
// This is more strict in that it presumes that if one direction is relativistic one should really limit things because full (here) 2D effects really imply the general 2D characteristic (not just the i or j char) is probably v~c.  That is, it's bad to assume that just because exactly along y it's v~c/2 and exactly along x it's v~c that this represents a *smooth* ~linear version for any other direction.  E.g., at other angles, it should be still v~c despite beaming effects.  In that sense, looking at exactly y-direction is degenerate and highly non-representative.
// Note that NR1997 Eq19.3.11 suggests dt<delta/(\sqrt{N} |v|) for N dimensions and absolute magnitude of velocity v.  This is much higher dt than required for stability of many problems, perhaps related to non-linear multi-D coupling in relativistic case.
//#define MINDTSET(dt1,dt2,dt3) (MIN(MIN((dt1),(dt2)),(dt3))/(FTYPE)(N1NOT1+N2NOT1+N3NOT1))


#define NUMOTHERSTATERESULTS 2
#define OTHERGAMMA 0
#define OTHERQSQ 1


#define ERRORCODEBELOWCLEANFINISH 1000

#define MAXFILENAME 200

#define MAXFILENAMELONG 2000

#define FILENOTFOUND 2490834

#define VEL4 0
#define VEL3 1
#define VELREL4 2

#define WITHGDET 0
#define WITHNOGDET 1
#define WITHSINSQ 2

#define NOGDETRHO 0
#define NOGDETU0 0
#define NOGDETU1 1 // U1 and U2 are only reasonable choices in SPC
#define NOGDETU2 1
#define NOGDETU3 0
#define NOGDETB1 0
#define NOGDETB2 0
#define NOGDETB3 0
#define NOGDETURAD0 0
#define NOGDETURAD1 1 // URAD1 and URAD2 are only reasonable choices in SPC
#define NOGDETURAD2 1
#define NOGDETURAD3 0
#define NOGDETENTROPY 0
#define NOGDETYFL1 0
#define NOGDETYFL2 0
#define NOGDETYFL3 0
#define NOGDETYFL4 0
#define NOGDETYFL5 0
#define NOGDETYL 0
#define NOGDETYNU 0




#define GENMAXWELL 0
#define PRIMMAXWELL 1


#define RELEOM 0
#define NONRELEOM 1 // NOT FINISHED // NOT RIGHT // NOT NEEDED


 // do nothing in Utoprimgen() assuming already effectively or actually did the inversion.
#define EOMDIDFFDE -6
#define EOMDIDFFDE2 -5
#define EOMDIDCOLDGRMHD -4
#define EOMDIDENTROPYGRMHD -3
#define EOMDIDGRMHD -2
#define EOMDONOTHING(eomtype) (eomtype<=EOMDIDGRMHD)
#define EOMDEFAULT -1 // choose to do default behavior without any forced EOM
#define NUMEOMTYPES 5
#define EOMFFDE 0
#define EOMFFDE2 1
#define EOMCOLDGRMHD 2
#define EOMENTROPYGRMHD 3
#define EOMGRMHD 4

#define MODEDEFAULT -1
#define MODEENERGY 0
#define MODEENTROPY 1
#define MODESWITCH 2
#define MODEPICKREVERT 3
#define MODEPICKBEST 4
#define MODEPICKBESTSIMPLE 5
#define MODEPICKBESTSIMPLE2 6
#define MODEENERGYRAMESH 7

#define CAPTYPEBASIC 0
#define CAPTYPEFIX1 1
#define CAPTYPEFIX2 2

#define ENTROPYFIXGUESS 1



#define ORIGINALFLUXCALC 0
#define NEWFLUXCALC 1



#define NOCOOLING 0
#define COOLGAMMIETHINDISK 1
#define COOLEOSGENERAL 2
#define COOLREBECCATHINDISK 3
#define COOLUSER 10 // user-defined cooling function
#define KORAL 101


#define NUMEOSS 5 // number of EOS types

#define COLDEOS 0
#define IDEALGAS 1
#define MIGNONE 2
#define GRBPWF99 3
#define KAZFULL 4



#define DONOENTROPY  0
#define DOEVOLVEENTROPY 1 // generic activation of entropy variable in conservation laws, etc.

#define DONOYFL 0
#define DOEVOLVEYFL 1

#define DONOYL 0
#define DOEVOLVEYL 1

#define DONOYNU 0
#define DOEVOLVEYNU 1


#define EVOLVENOENTROPY 0
#define EVOLVESIMPLEENTROPY 1 // should be used with DOENTROPY==DOEVOLVECOMPAREENTOPY
#define EVOLVEFULLENTROPY 2 // should only be used with DOENTROPY==DOEVOLVEDIRECTENTROPY or DOENTROPY==DOEVOLVECOMPAREENTOPY



#define EVOLVEUTOPRIM 0
#define OTHERUTOPRIM 1


#define UEVOLVE 0
#define UDIAG 1
#define UNOTHING 2
#define UENTROPY 3 // implicit UNOTHING but cons UU is overwritten by cons entropy (see primtoflux() in phys.c as used by utoprim() in utoprim.c)




#define LIMITERFIXED 0
#define LIMITERBSQORHO 1
#define LIMITERBSQOU 2
#define LIMITERBSQORHOANDU 3

#define FLUXFIXED 0 // (see get_bsqflags() in fixup.c)
#define FLUXBSQORHO 1
#define FLUXBSQOU 2
#define FLUXBSQORHOANDU 3


#define UTOPRIMRETURNNOTADJUSTED 0
#define UTOPRIMRETURNADJUSTED 1



#define UTOPRIMSTATIC 0
#define UTOPRIMAVG 1


#define LINEARTYPE 0
#define LOGTYPE 1
#define QUADRATICTYPE 2 // includes limiters to ovoid overshoots and new extremums within 3 point domain


#define MODIFYEMF 0
#define MODIFYVPOT 1

#define NUMENOINTERPTYPES 12

#define NONENOINTERPTYPE 0
#define ENOINTERPTYPE 1 // ce2
#define ENOINTERPTYPE4EMF 2 // f2corn
#define ENOFLUXRECONTYPE 3
#define ENOFLUXRECONTYPEGHOSTACTIVE 4 // used at t=0 where *construct* Uavg in ghost+active region and for dofluxreconevolvepointfield==0 for EMFs
#define ENOFLUXSPLITTYPE 5
#define ENOAVG2CENTTYPE 6
#define ENOCENT2AVGTYPE 7
#define ENOFLUXAVG1TYPE 8
#define ENOFLUXAVG2TYPE 9
#define ENOFLUXAVG3TYPE 10
#define ENOQUASIFIELDFLUXRECONTYPE 11


#define ENOSOURCETERM 0
#define ENOCONSERVED  1
#define ENOPRIMITIVE  2
#define ENOFLUX       3
#define ENOMAFLUX     4
#define ENOSMOOTHFLUX 5
#define ENOSMOOTHCONSERVED  6


#define NOENOFLUX 0
#define ENOFLUXRECON 1
#define ENOFLUXSPLIT 2
#define ENOFINITEVOLUME 3

#define NUMDFS 5
#define DFONESIDED 0
#define DFCENT 1
#define DFMONO 2
#define DF2OFMONO 3
#define DF2OFONESIDED 4
#define DFCENT2APART 5

#define NUMMONOINDICATORS 3

#define MONOINDTYPE 0 // -1,0,1 for rough, ambiguous, monotonic
#define MONOLEFTSET 1 // whether left interface (or central for a2c/c2a) was set to MONO value
#define MONORIGHTSET 2 // whether right interface was set to MONO value



#define WEIGHT_CALC 1
#define RECON_CALC 2
#define ALL_CALC (WEIGHT_CALC | RECON_CALC)  //compute everything


#define CVT_A2C 0
#define CVT_C2A 1
#define CVT_C2L 2
#define CVT_C2R 3
#define CVT_C2DER1 4
#define CVT_C2DER2 5
#define CVT_C2DER3 6
#define CVT_C2DER4 7



#define CVT_C2E CVT_C2L //use the same number as CVT_C2L because does not add a new reconstruction type

#define NOSPLITA2C 0
#define MINIMIZE_ALL_WEIGHTS 1
#define ENERGY_CONTROLS_ALL_WEIGHTS 2 // as below
#define ENERGY_IS_ALL_WEIGHTS 3 // means T^i_i for flux and T^t_t for energy
#define MASSENERGYMOMENTUM_IS_COUPLED_WEIGHTS 4 // means lock \rho u^i , T^i_i and T^i_t all together to help with relativistic flows to maintain consistency
#define MASSENERGYMOMENTUM_IS_COUPLED_WEIGHTS_OLD 5 // means lock \rho u^i , T^i_i and T^i_t all together to help with relativistic flows to maintain consistency
#define GENFUN_IS_ALL_WEIGHTS 5
#define CONSTANT_ALL_WEIGHTS 6 // forces MONO and equal weights for all


#define NOMONOINTERP 0
#define JMONOINTERP 1
#define SMONOINTERP 2

#define ISMAONLY 0
#define ISEMONLY 1
#define ISMAANDEM 2
#define ISRADONLY 3



#define DISSSIMPLEINVCO 0
#define DISSFULLINVCO 1
#define DISSENTROPYCO 2
#define DISSSIMPLEINVCONOMAX 3 
#define DISSFULLINVCONOMAX 4
#define DISSENTROPYCONOMAX 5
#define DISSSIMPLEINVLAB1 6
#define DISSFULLINVLAB1 7
#define DISSENTROPYLAB1 8
#define DISSSIMPLEINVLAB1NOMAX 9
#define DISSFULLINVLAB1NOMAX 10
#define DISSENTROPYLAB1NOMAX 11
#define DISSSIMPLEINVLAB2 12
#define DISSFULLINVLAB2 13
#define DISSENTROPYLAB2 14
#define DISSSIMPLEINVLAB2NOMAX 15
#define DISSFULLINVLAB2NOMAX 16
#define DISSENTROPYLAB2NOMAX 17

#define DISSFAILUREINV 18

#define NUMDISSVERSIONS 18 // for consistent restart output, this number can't change
#define NUMDISSFUNPOS (NUMDISSVERSIONS+1)  // includes failure indicator


#define NUMPOS4EMF 3
#define LEFT4EMF 0 // left or -
#define RIGHT4EMF 1 // right or +
#define CENT4EMF 2  // centered position
#define START4EMF LEFT4EMF // which is 0
#define END4EMF CENT4EMF // which is last value


#define NUMFLUXLOOPNUMBERS 10
#define FIDEL 0
#define FJDEL 1
#define FKDEL 2
#define FFACE 3
#define FIS 4
#define FIE 5
#define FJS 6
#define FJE 7
#define FKS 8
#define FKE 9


#define CHECKONINVERSIONDEFAULT (-1)

#define NUMINVPROPERTY 13

#define CURRENTCALC0 0
#define CURRENTCALC1 1
#define CURRENTCALC2 2



#define CURRENTPRECALCTYPES 5

#define CURTYPET 0
#define CURTYPEX 1
#define CURTYPEY 2
#define CURTYPEZ 3
#define CURTYPEFARADAY 4


#define FIXUP1ZONE 0
#define FIXUPALLZONES 1
#define FIXUPNOZONES 2



#define LAXFFLUX 0
#define HLLFLUX 1
#define FORCEFLUX 2
#define MUSTAFLUX 3 // not yet working
#define HLLLAXF1FLUX 4


#define FLUXCTHLL 0
#define FLUXCTTOTH 1
#define FLUXCD 2
#define ATHENA1 3
#define ATHENA2 4
#define FLUXCTSTAG 5
/* these are different ways of calculating the EMFs */

#define UTOPRIM5D1 0

#define UTOPRIMLDZ 1

#define UTOPRIM2D 2

#define UTOPRIM1D 3

#define UTOPRIM1DOPT 4

#define UTOPRIM1DFINAL 5

#define UTOPRIM2DFINAL 6

#define UTOPRIM5D2 7

#define UTOPRIMJONNONRELCOMPAT 8

#define UTOPRIMCOLDGRMHD 20

#define UTOPRIMFFDE 21

#define UTOPRIMCOMPARE 100


// mnemonics for slope limiter

#define NLIM    -1 // no limiter
#define NLIMCENT    -2 // no limiter
#define NLIMUP    -3 // no limiter
#define NLIMDOWN    -4 // no limiter
#define NUMNEGINTERPS 4


#define DONOR 0

#define VANL 1
#define MINM 2
#define MC      3
#define PARA    4
#define PARAFLAT 5
#define MCSTEEP 6 // uses 3-point limiter, but other features of PARAFLAT
#define CSSLOPE      7 // not tested/compared against others
#define MP5 8
#define EPPM 9

#define WENO3 20
#define WENO4 21
#define WENO5  22
#define WENO6  23
#define WENO7  24
#define WENO8  25
#define WENO9  26
#define ENO3 27
#define ENO5 28
#define WENO5FLAT 29
#define WENO5BND 30
#define WENO5BNDPLUSMIN 31

#define PARALINE 40

#define FIRSTWENO WENO3
#define LASTWENO WENO5BNDPLUSMIN

#define FIRSTINTERPLINE WENO3
#define LASTINTERPLINE PARALINE

#define NUMPOSINTERPS LASTINTERPLINE // not number, just last, ok if some entries are not any limiter

#define NUMINTERPS (1 + NUMPOSINTERPS + NUMNEGINTERPS)


#define WENOINTERPTYPE(lim) (lim>=FIRSTWENO && lim<=LASTWENO)

#define WENOBNDPINTERPTYPE(lim) (lim==WENO5BND || lim==WENO5BNDPLUSMIN)

#define LINEINTERPTYPE(lim) (lim>=FIRSTINTERPLINE && lim<=LASTINTERPLINE)



#define MAXSPACEORDER 15 // maximum number of points in stencil
//#define MAXSPACESHIFT ((MAXSPACEORDER-1)/2) // center point for symmetric stencil

#define STARTTIME 0
#define CHECKTIME 1
#define SPEEDTIME 2
#define STOPTIME 3
#define REPORTTIME 4
#define DIAGSTARTTIME 5
#define DIAGSTOPTIME 6
#define INITSTARTTIME 7
#define INITSTOPTIME 8


#define MAXTIMEORDER 5 // 5 now needed for EOMRADTYPE!=EOMRADNONE, but only affects memory in that case.

#define NUMPREDTCUFS (4) // see step_ch.c

#define NUMDTCUFS (NUMPREDTCUFS+MAXTIMEORDER) // see step_ch.c

//#define TIMEORDER 3


#define SOURCEMETHODNONE 0
#define SOURCEMETHODEXPLICIT 1
#define SOURCEMETHODEXPLICITSUBCYCLE 2
#define SOURCEMETHODIMPLICIT 3
#define SOURCEMETHODIMPLICITEXPLICITCHECK 4
#define SOURCEMETHODEXPLICITREVERSIONFROMIMPLICIT 5
#define SOURCEMETHODEXPLICITSUBCYCLEREVERSIONFROMIMPLICIT 6
#define SOURCEMETHODEXPLICITCHECKSFROMIMPLICIT 7
#define SOURCEMETHODEXPLICITSUBCYCLECHECKSFROMIMPLICIT 8


#define METRICTETRAD 0
#define NONMETRICTETRIC 1


#define PRIMTOINTERP -1
#define PRIMTOINTERP_JONRESCALED1 0
#define CONSTOINTERP 1
#define PRIMTOINTERPLGDEN 2
#define PRIMTOINTERP_LGDEN_RHOU 3
#define PRIMTOINTERP_RHOU 4
#define PRIMTOINTERP_VSQ 5
#define PRIMTOINTERP_3VEL_GAMMA 6
#define PRIMTOINTERP_RHOV_GAMMA 7
#define PRIMTOINTERP_VELREL4SQ 8
#define PRIMTOINTERP_3VELREL_GAMMAREL 9
#define PRIMTOINTERP_RAMESH1 10
#define PRIMTOINTERP_3VELREL_GAMMAREL_DXDXP 11
#define PRIMTOINTERP_GDETFULLVERSION 12
#define PRIMTOINTERP_GDETFULLVERSION_WALD 13

#define NOFIELDRESCALE -1
#define NOSPECIALFIELD 0
#define PULSARFIELD 1
#define PULSARFIELD2 2
#define PULSARFIELD3 3
#define GDETVERSION 4
#define GDETFULLVERSION 5



#define WENO_REDUCE_TYPE_DEFAULT 0 
#define WENO_REDUCE_TYPE_PPM 1

#define MINMODB(a,b) ( (fabs(a)<fabs(b)) ? (a) : (b) )
#define MINMOD(a,b) ( ((a)*(b)<=0) ? 0.0 : MINMODB(a,b) )
//#define MINMOD3( x, y, z )   ( 0.25 * (sign(x) + sign(y)) * (sign(x) + sign(z)) * MIN( MIN(fabs(x), fabs(y)), fabs(z)) )    

#define MINMODB(a,b) ( (fabs(a)<fabs(b)) ? (a) : (b) )
#define MINMODGEN(extremeallow,a,b) ( (!extremeallow && (a)*(b)<=0) ? 0.0 : MINMODB(a,b) )


#define REMOVEFROMNPR 0
#define RESTORENPR 1


#define PARA1 0 // old
#define PARA2 1 // works
#define PARA3 2 // broken
#define PARA4 3 // latest
#define PARAJON 4 // Created to do well with high \sigma monopole


// GODMARK: wth NUMREC had problems with large run (jetnewnoenv,jetnew on sauron)
// GODMARK: NUMREC not working right now after trying to make accurate
//#define CONNDERTYPE GAMMIEDERIVATIVE

#define DIFFGAMMIE 0 // use infinitesimal differences of analytical metric
#define DIFFNUMREC 1 // use advanced (but presently broken) uniformly accurate Numerical Recipies numerical derivatives
#define DIFFFINITE 2 // use previously defined gridded values of metric to compute finite differences (fastest)


#define INTERPPOINTTYPE 0
#define INTERPLINETYPE 1


#define TIMEIMPLICIT 0
#define TIMEEXPLICIT 1


#define NUMBOUNDTYPES 9
//
#define BOUNDPRIMTYPE 0
#define BOUNDPRIMSIMPLETYPE 1
#define BOUNDPSTAGTYPE 2
#define BOUNDPSTAGSIMPLETYPE 3
#define BOUNDINTTYPE 4 // always simple
#define BOUNDFLUXTYPE 5
#define BOUNDFLUXSIMPLETYPE 6
#define BOUNDVPOTTYPE 7
#define BOUNDVPOTSIMPLETYPE 8


#define BOUNDPRIMLOC 0
#define BOUNDPSTAGLOC 1


#define X1UP 0
#define X1DN 1
#define X2UP 2
#define X2DN 3
#define X3UP 4
#define X3DN 5

#define NUMUPDOWN 2
#define POINTUP 0
#define POINTDOWN 1

#define NUMLEFTRIGHT 2
#define ISLEFT 0
#define ISRIGHT 1
#define ISMIDDLE 2 // just macro, not used to access memory space and so why NUMLEFTRIGHT is still 2

#define FLUXNOTONGRID -100


#define DIRSIGN(dir) (1-2*((dir)%2 ))

#define DIMEN(dir) (1+(dir)/2)

#define DIRFROMDIMEN(dimen,dirsign) (( (dirsign==-1) + (dimen - 1) * 2))

#define POINTFROMDIR(dir) (DIRSIGN(dir)==-1 ? POINTDOWN : POINTUP)

# define M_El           2.7182818284590452353602874713526625L  /* e */
# define M_LOG2El       1.4426950408889634073599246810018922L  /* log_2 e */
# define M_LOG10El      0.4342944819032518276511289189166051L  /* log_10 e */
# define M_LN2l         0.6931471805599453094172321214581766L  /* log_e 2 */
# define M_LN10l        2.3025850929940456840179914546843642L  /* log_e 10 */

# define M_PIl          3.1415926535897932384626433832795029L  /* pi */
# define M_PI_2l        1.5707963267948966192313216916397514L  /* pi/2 */
# define M_PI_4l        0.7853981633974483096156608458198757L  /* pi/4 */
# define M_1_PIl        0.3183098861837906715377675267450287L  /* 1/pi */
# define M_2_PIl        0.6366197723675813430755350534900574L  /* 2/pi */
# define M_2_SQRTPIl    1.1283791670955125738961589031215452L  /* 2/sqrt(pi) */
# define M_SQRT2l       1.4142135623730950488016887242096981L  /* sqrt(2) */
# define M_SQRT1_2l     0.7071067811865475244008443621048490L  /* 1/sqrt(2) */
# define SIXTH          0.1666666666666666666666666666666666L  /* 1/6 */
# define FOURTHIRD      1.3333333333333333333333333333333333L  /* 4/3 */
# define THIRD          0.3333333333333333333333333333333333L  /* 1/3 */
# define ONE            1.0000000000000000000000000000000000L
# define PTFIVE         0.5L
# define TWO            2.0L
# define ONEPT25        1.25L
# define THREE          3.0L
# define SIX            6.0L
# define EIGHT          8.0L

#ifdef WIN32
# define M_PI           3.1415926535897932384626433832795029L  /* pi */
#endif



#define MAX(a,b) ( ((a) > (b)) ? (a) : (b) )
#define MIN(a,b) ( ((a) < (b)) ? (a) : (b) )
#define SIGNSINGLE(a) ( ((a) <0.) ? -1. : 1. )

#define ROUND2INT(x) ((int)((x)>0.0 ? (x)+0.5 : (x)-0.5))
#define ROUND2LONGLONGINT(x) ((long long int)((x)>0.0 ? (x)+0.5 : (x)-0.5))


#define DONOTACCESSMEMORY 0


#define PROGRADERISCO 0
#define RETROGRADERISCO 1

#define NUMTSCALES 4

#define ALLTS 0 // full cumulative
#define ENERTS 1 // cumulative each dump_ener (over all grid)
#define IMAGETS 2 // cumulative each image dump (full grid)
#define DEBUGTS 3 // debug dump time scale (full grid)



#define NEGDENSITY_NEVERFIXUP -1
#define NEGDENSITY_ALWAYSFIXUP 0
#define NEGDENSITY_FIXONFULLSTEP 1




#define COUNTNOTHING -2
#define COUNTONESTEP -1 // used as control label, not counted
#define COUNTREALSTART 0 // marks when real counters begin
#define NUMFAILFLOORFLAGS 38

#define COUNTUTOPRIMFAILCONV 0 // if failed to converge
#define COUNTFLOORACT 1 // if floor activated
#define COUNTLIMITGAMMAACT 2 // if Gamma limiter activated
#define COUNTINFLOWACT 3 // if inflow check activated
#define COUNTUTOPRIMFAILRHONEG 4
#define COUNTUTOPRIMFAILUNEG 5
#define COUNTUTOPRIMFAILRHOUNEG 6
#define COUNTGAMMAPERC 7 // see fixup_checksolution()
#define COUNTUPERC 8 // see fixup_checksolution()
#define COUNTFFDE 9 // if originally MHD or ENTROPY, this is always referring to EOMFFDE2 or whatever set in utoprimgen.c
#define COUNTCOLD 10
#define COUNTENTROPY 11
#define COUNTHOT 12
#define COUNTEOSLOOKUPFAIL 13
#define COUNTBOUND1 14 // see bounds.tools.c (used when boundary code actually affects active zone values)
#define COUNTBOUND2 15
#define COUNTUCONSFIXUP 16

// IMPLICITs count normal and issues separately from utoprim failure because not a normal 1-step inversion
#define COUNTIMPLICITITERS 17
#define COUNTIMPLICITMHDSTEPS 18
#define COUNTIMPLICITERRORS0 19
#define COUNTIMPLICITERRORS1 20
#define COUNTIMPLICITNORMAL 21
#define COUNTEXPLICITNORMAL 22
#define COUNTIMPLICITBAD 23
#define COUNTEXPLICITBAD 24
#define COUNTIMPLICITENERGY 25
#define COUNTIMPLICITENTROPY 26
#define COUNTIMPLICITCOLDMHD 27
#define COUNTIMPLICITFAILED 28
#define COUNTIMPLICITPMHD 29
#define COUNTIMPLICITUMHD 30
#define COUNTIMPLICITPRAD 31
#define COUNTIMPLICITURAD 32
#define COUNTIMPLICITENTROPYUMHD 33
#define COUNTIMPLICITENTROPYPMHD 34
#define COUNTIMPLICITMODENORMAL 35
#define COUNTIMPLICITMODESTAGES 36
#define COUNTIMPLICITMODECOLD 37


#define AVOIDI -100
#define AVOIDJ -100
#define AVOIDK -100

#define NANPFLAG -100 // bad pflag
#define UTOPRIMFAILFIXEDBOUND2 (-6)
#define UTOPRIMFAILFIXEDBOUND1 (-5)
#define UTOPRIMFAILFIXEDENTROPY (-4)
#define UTOPRIMFAILFIXEDCOLD (-3)
#define UTOPRIMFAILFIXEDFFDE (-2)
#define UTOPRIMFAILFIXEDUTOPRIM -1
#define UTOPRIMNOFAIL 0
#define UTOPRIMFAILGENERIC 1 // just >UTOPRIMNOFAIL
#define UTOPRIMFAILCONV 1
#define UTOPRIMFAILCONVW     2
#define UTOPRIMFAILCONVUTSQ  3
#define UTOPRIMFAILCONVGUESSUTSQ 4
#define UTOPRIMFAILCONVUTSQVERYBAD 5
#define UTOPRIMFAILCONVBADINVERTCOMPARE 6
#define UTOPRIMFAILNANGUESS 7
#define UTOPRIMFAILNANRESULT 8
#define UTOPRIMFAILRHONEG 9
#define UTOPRIMFAILUNEG 10
#define UTOPRIMFAILRHOUNEG 11
#define UTOPRIMFAILGAMMAPERC 12
#define UTOPRIMFAILUPERC 13
#define UTOPRIMFAILU2AVG1 14
#define UTOPRIMFAILU2AVG2 15
#define UTOPRIMFAILU2AVG1FROMCOLD 16
#define UTOPRIMFAILU2AVG2FROMCOLD 17
#define UTOPRIMFAILURHO2AVG1FROMFFDE 18
#define UTOPRIMFAILFAKEVALUE 19
#define UTOPRIMFAILCONVRET   50


#define IFUTOPRIMFAILSOFTRHORELATED(pflag) (pflag==UTOPRIMFAILRHONEG || pflag==UTOPRIMFAILRHOUNEG)

#define IFUTOPRIMFAILSOFTNOTRHORELATED(pflag) (pflag==UTOPRIMFAILUNEG || pflag==UTOPRIMFAILGAMMAPERC  || pflag==UTOPRIMFAILUPERC  || pflag==UTOPRIMFAILU2AVG1  || pflag==UTOPRIMFAILU2AVG2 || pflag==UTOPRIMFAILU2AVG1FROMCOLD  || pflag==UTOPRIMFAILU2AVG2FROMCOLD || pflag==UTOPRIMFAILURHO2AVG1FROMFFDE)

#define IFUTOPRIMFAILSOFT(pflag) (IFUTOPRIMFAILSOFTRHORELATED(pflag)||IFUTOPRIMFAILSOFTNOTRHORELATED(pflag))

#define IFUTOPRIMFAILFIXED(pflag) (pflag==UTOPRIMFAILFIXEDFFDE || pflag==UTOPRIMFAILFIXEDCOLD || pflag==UTOPRIMFAILFIXEDENTROPY || pflag==UTOPRIMFAILFIXEDUTOPRIM)

#define IFUTOPRIMNOFAILORFIXED(pflag) (pflag==UTOPRIMFAILFIXEDFFDE || pflag==UTOPRIMFAILFIXEDCOLD || pflag==UTOPRIMFAILFIXEDENTROPY || pflag==UTOPRIMFAILFIXEDUTOPRIM || pflag==UTOPRIMNOFAIL)

#define IFUTOPRIMNOFAIL(pflag) (pflag==UTOPRIMNOFAIL)

#define IFUTOPRIMFAIL(pflag) (pflag>UTOPRIMNOFAIL)

#define ENTROPYANYFAIL(pflag) (pflag>0)

#define HOTANYFAIL(pflag) (pflag>0)

#define COLDANYFAIL(pflag) (pflag>0 && pflag!=UTOPRIMFAILU2AVG1FROMCOLD && pflag!=UTOPRIMFAILU2AVG2FROMCOLD)

#define FFDEANYFAIL(pflag) (pflag>0 && pflag!=UTOPRIMFAILURHO2AVG1FROMFFDE)


#define UTOPRIMRADFAILFIXEDUTOPRIMRAD -1
#define UTOPRIMRADNOFAIL 0 // no radiation inversion failure


#define UTOPRIMRADFAILCASE1A 1 // 
#define UTOPRIMRADFAILCASE1B 2 //
#define UTOPRIMRADFAILCASE2A 3 //
#define UTOPRIMRADFAILCASE2B 4 //
#define UTOPRIMRADFAILCASE3A 5 //
#define UTOPRIMRADFAILCASE3B 6 //
#define UTOPRIMRADFAILERFNEG 7

#define UTOPRIMRADFAILBAD1 8 // not used yet
#define UTOPRIMRADFAILGAMMAHIGH   9

#define COUNTRADNOTHING -1
#define NUMRADFAILFLOORFLAGS 2  // no array for storage yet (or maybe ever)
#define COUNTRADLOCAL 0
#define COUNTRADNONLOCAL 1

#define IFUTOPRIMRADHARDFAIL(pflagrad) (pflagrad>UTOPRIMRADNOFAIL && pflagrad!=UTOPRIMRADFAILGAMMAHIGH && pflagrad!=UTOPRIMRADFAILERFNEG)
#define IFUTOPRIMRADSOFTFAIL(pflagrad) (pflagrad>UTOPRIMRADNOFAIL && (pflagrad==UTOPRIMRADFAILGAMMAHIGH || pflagrad==UTOPRIMRADFAILERFNEG))
#define IFUTOPRIMRADFAIL(pflagrad) (pflagrad>UTOPRIMRADNOFAIL)

#define IFUTOPRIMRADFAILFIXED(pflagrad) (pflagrad==UTOPRIMRADFAILFIXEDUTOPRIMRAD)
#define IFUTOPRIMRADNOFAIL(pflagrad) (pflagrad==UTOPRIMRADNOFAIL)

#define IFUTOPRIMRADNOFAILORFIXED(pflagrad) (pflagrad==UTOPRIMRADFAILFIXEDUTOPRIMRAD || pflagrad==UTOPRIMRADNOFAIL)

#define RADINVBAD(radinvmod) (radinvmod==UTOPRIMRADFAILERFNEG || radinvmod==UTOPRIMRADFAILBAD1 || radinvmod==UTOPRIMRADFAILGAMMAHIGH)
#define RADINVOK(radinvmod) (RADINVBAD(radinvmod)==0)



/* failure modes */
#define FAIL_UTOPRIM_NEG 1
#define FAILSTR01 "UTOPRIM_NEG"
#define FAIL_UTOPRIM_TEST 2
#define FAILSTR02 "UTOPRIM_TEST"
#define FAIL_VCHAR_DISCR 3
#define FAILSTR03 "VCHAR_DISCR"
#define FAIL_COEFF_NEG  4
#define FAILSTR04 "COEFF_NEG"
#define FAIL_COEFF_SUP  5
#define FAILSTR05 "COEFF_SUP"
#define FAIL_UTCALC_DISCR 6
#define FAILSTR06 "UTCALC_DISCR"
#define FAIL_LDZ         7
#define FAILSTR07 "FAIL_LDZ"
#define FAIL_BCFIX         8
#define FAILSTR08 "FAIL_BCFIX"
#define FAIL_VSQ_NEG         9
#define FAILSTR09 "FAIL_VSQ_NEG"

/* mnemonics for primitive vars; conserved vars */
#define VARNOTDEFINED -100
#define RHO 0
#define UU 1
#define U1 2
#define U2 3
#define U3 4
#define B1 5
#define B2 6
#define B3 7



#define CENTEREDPRIM 0
#define STAGGEREDPRIM 1


#define NDIM 4  /* number of total dimensions.  Never changes */
#define SYMMATRIXNDIM 10 // total number of independent elements of a symmetric matrix

#define NUMPFLAGS (6)
#define NUMFAILPFLAGS (2)


#define FLAGUTOPRIMFAIL 0 // changes behavior of fixup() on MHD quantities
#define FLAGUTOPRIMRADFAIL 1 // changes behavior of fixup() on radiation quantities

#define FLAGREALLIM 2 // value of limiter to be used
#define FLAGBSQORHO 3 // set when B^2/RHO > BSQORHOLIMIT ; currently changes  behavior of slope_lim
#define FLAGBSQOU 4 // set when B^2/u > BSQOULIMIT
#define FLAGREALFLUX 5 // type of flux to use




#define NUMSOURCES 3


#define GEOMSOURCE 0 // SHOULD ALWAYS BE 0 !
#define RADSOURCE 1
#define RADSOURCE2 2





#define NUMFLUXTERMS (7)


#define ORDERDEBUG 3

#define NUMENODEBUGS 6


#define MAXITERDTSTAGES 2



//#define NUMDTDS 11
//#define DTDUMP 0
//#define DTAVG 1
//#define DTENER 2
//#define DTIMAGE 3
//#define DTDEBUG 4
//#define DTDISS 5
//#define DTFIELDLINE 6
//#define DTFLUX 7
//#define DTOTHER 8
//#define DTEOS 9
//#define DTVPOT 10





#define TT 0
#define RR 1
#define TH 2
#define PH 3


#define NPG 8
#define NOWHERE -1 // tells a function that not necessarily requesting value at a standard grid location (unusual) -- this stores no memroy, so doesn't increase NPG
#define CENT    0
#define FACE1 1
#define FACE2 2
#define FACE3   3
#define CORN1 4 // corner in 2-3 plane
#define CORN2 5 // corner in 1-3 plane
#define CORN3 6 // corner in 1-2 plane
#define CORNT   7 // true corner: full 3D corner (only required for 3D)

#define NUMPRIMGRIDPOS 2
#define CENTGRID 0
#define STAGGRID 1

#define INIT_OUT 0
#define DUMP_OUT 1
#define IMAGE_OUT 1
#define LOG_OUT  1
#define FINAL_OUT 2
#define FUTURE_OUT      3

#define DOINGFUTUREOUT -100


#define SURFACETOTAL 0
#define VOLUMETOTAL 1

#define CONSTYPE 0
#define SURFACETYPE 1
#define CUMULATIVETYPE 2
#define CONSJETINNERTYPE 3
#define CONSJETOUTERTYPE 4
#define CUMULATIVETYPE2 5
#define CONSTYPE2 6
#define CUMULATIVETYPE3 7

#define NOTHINGHEAD -1
#define WRITEHEAD 0
#define READHEAD 1

#define TIMESERIESAREAMAP 0
#define FINALTDUMPAREAMAP 1

#define WRITEFILE 0
#define READFILE 1

#define ENERFNAME "ener.out"
#define GENERFNAME "gener.out"



#define NUMDUMPTYPES 22 // number of dump types listed below

#define RESTARTDUMPTYPE 0
#define RESTARTUPPERPOLEDUMPTYPE 1
#define RESTARTMETRICDUMPTYPE 2
#define IMAGEDUMPTYPE 3
#define MAINDUMPTYPE 4
#define GRIDDUMPTYPE 5
#define AVG1DUMPTYPE 6
#define AVG2DUMPTYPE 7 // used when needing AVG2DUMPTYPE to avoid too large a file size for avgdump
#define DEBUGDUMPTYPE 8
#define FIELDLINEDUMPTYPE 9
#define ENODEBUGDUMPTYPE 10
#define DISSDUMPTYPE 11
#define OTHERDUMPTYPE 12
#define FLUXDUMPTYPE 13
#define EOSDUMPTYPE 14
#define RADDUMPTYPE 15
#define VPOTDUMPTYPE 16
#define FAILFLOORDUDUMPTYPE 17
#define ENERDUMPTYPE 18
#define DISSMEASUREDUMPTYPE 19
#define FLUXSIMPLEDUMPTYPE 20
#define FAKEDUMPTYPE 21

#define MYDUMPNAMELIST {"RESTARTDUMPTYPE","RESTARTUPPERPOLEDUMPTYPE","RESTARTMETRICDUMPTYPE","IMAGEDUMPTYPE","MAINDUMPTYPE","GRIDDUMPTYPE","AVG1DUMPTYPE","AVG2DUMPTYPE","DEBUGDUMPTYPE","FIELDLINEDUMPTYPE","ENODEBUGDUMPTYPE","DISSDUMPTYPE","OTHERDUMPTYPE","FLUXDUMPTYPE","EOSDUMPTYPE","RADDUMPTYPE","VPOTDUMPTYPE","FAILFLOORDUDUMPTYPE","ENERDUMPTYPE","DISSMEASUREDUMPTYPE","FLUXSIMPLEDUMPTYPE","FAKEDUMPTYPE"}


#define NUMIMAGEPARMS 3

#define ORIGIN 0
#define LMIN 1
#define LMAX 2


// for rescale() in rescale_interp.c
#define DORESCALE 1
#define UNRESCALE -1

// for diag_fixup() in fixup.c
#define DOMODCONS 1
#define NOMODCONS 0
#define DOONESTEPCONS -1

#include "global.nondepmnemonics.rad.h" // KORAL