#!/usr/bin/env python
# coding: utf-8

# <script async src="https://www.googletagmanager.com/gtag/js?id=UA-59152712-8"></script>
# <script>
#   window.dataLayer = window.dataLayer || [];
#   function gtag(){dataLayer.push(arguments);}
#   gtag('js', new Date());
# 
#   gtag('config', 'UA-59152712-8');
# </script>
# 
# # Tutorial-IllinoisGRMHD: IllinoisGRMHD_headers.h
# 
# ## Authors: Leo Werneck & Zach Etienne
# 
# <font color='red'>**This module is currently under development**</font>
# 
# ## In this tutorial module we explain the main `IllinoisGRMHD` header file. This module will likely be absorbed by another one by the time we finish documenting the code
# 
# ### Required and recommended citations:
# 
# * **(Required)** Etienne, Z. B., Paschalidis, V., Haas R., Mösta P., and Shapiro, S. L. IllinoisGRMHD: an open-source, user-friendly GRMHD code for dynamical spacetimes. Class. Quantum Grav. 32 (2015) 175009. ([arxiv:1501.07276](http://arxiv.org/abs/1501.07276)).
# * **(Required)** Noble, S. C., Gammie, C. F., McKinney, J. C., Del Zanna, L. Primitive Variable Solvers for Conservative General Relativistic Magnetohydrodynamics. Astrophysical Journal, 641, 626 (2006) ([astro-ph/0512420](https://arxiv.org/abs/astro-ph/0512420)).
# * **(Recommended)** Del Zanna, L., Bucciantini N., Londrillo, P. An efficient shock-capturing central-type scheme for multidimensional relativistic flows - II. Magnetohydrodynamics. A&A 400 (2) 397-413 (2003). DOI: 10.1051/0004-6361:20021641 ([astro-ph/0210618](https://arxiv.org/abs/astro-ph/0210618)).

# <a id='toc'></a>
# 
# # Table of Contents
# $$\label{toc}$$
# 
# This module is organized as follows
# 
# 0. [Step 0](#src_dir): **Source directory creation**
# 1. [Step 1](#introduction): **Introduction**
# 1. [Step 2](#igm_headers__h): **`IllinoisGRMHD_headers.h`**
# 1. [Step n-1](#code_validation): **Code validation**
# 1. [Step n](#latex_pdf_output): **Output this notebook to $\LaTeX$-formatted PDF file**

# <a id='src_dir'></a>
# 
# # Step 0: Source directory creation \[Back to [top](#toc)\]
# $$\label{src_dir}$$
# 
# We will now use the [cmdline_helper.py NRPy+ module](Tutorial-Tutorial-cmdline_helper.ipynb) to create the source directory within the `IllinoisGRMHD` NRPy+ directory, if it does not exist yet.

# In[1]:


# Step 0: Creation of the IllinoisGRMHD source directory
# Step 0a: Add NRPy's directory to the path
# https://stackoverflow.com/questions/16780014/import-file-from-parent-directory
import os,sys
nrpy_dir_path = os.path.join("..","..")
if nrpy_dir_path not in sys.path:
    sys.path.append(nrpy_dir_path)

# Step 0b: Load up cmdline_helper and create the directory
import cmdline_helper as cmd
IGM_src_dir_path = os.path.join("..","src")
cmd.mkdir(IGM_src_dir_path)

# Step 0c: Create the output file path
outfile_path__IllinoisGRMHD_headers__h = os.path.join(IGM_src_dir_path,"IllinoisGRMHD_headers.h")


# <a id='introduction'></a>
# 
# # Step 1: Introduction \[Back to [top](#toc)\]
# $$\label{introduction}$$

# <a id='igm_headers__h'></a>
# 
# # Step 2: `IllinoisGRMHD_headers.h` \[Back to [top](#toc)\]
# $$\label{igm_headers__h}$$

# In[2]:


get_ipython().run_cell_magic('writefile', '$outfile_path__IllinoisGRMHD_headers__h', '// To safeguard against double-including this header file:\n#ifndef ILLINOISGRMHD_HEADERS_H_\n#define ILLINOISGRMHD_HEADERS_H_\n\n#define MIN(a,b) ( ((a) < (b)) ? (a) : (b) )\n#define MAX(a,b) ( ((a) > (b)) ? (a) : (b) )\n#define SQR(x) ((x) * (x))\n#define ONE_OVER_SQRT_4PI 0.282094791773878143474039725780\n\n#define VERR_DEF_PARAMS __LINE__, __FILE__, CCTK_THORNSTRING\n\n// The order here MATTERS, as we assume that GUPXX+1=GUPYY, etc.\nstatic const int PHI=0,PSI=1,GXX=2,GXY=3,GXZ=4,GYY=5,GYZ=6,GZZ=7,\n  LAPM1=8,SHIFTX=9,SHIFTY=10,SHIFTZ=11,GUPXX=12,GUPYY=13,GUPZZ=14,\n  NUMVARS_FOR_METRIC_FACEVALS=15; //<-- Be _sure_ to set this correctly, or you\'ll have memory access bugs!\n\n// These are not used for facevals in the reconstruction step, but boy are they useful anyway.\nstatic const int GUPXY=15,GUPXZ=16,GUPYZ=17,\n  NUMVARS_FOR_METRIC=18; //<-- Be _sure_ to set this correctly, or you\'ll have memory access bugs!\n\n// The order here MATTERS, and must be consistent with the order in the in_prims[] array in driver_evaluate_MHD_rhs.C.\nstatic const int RHOB=0,PRESSURE=1,VX=2,VY=3,VZ=4,\n  BX_CENTER=5,BY_CENTER=6,BZ_CENTER=7,BX_STAGGER=8,BY_STAGGER=9,BZ_STAGGER=10,\n  VXR=11,VYR=12,VZR=13,VXL=14,VYL=15,VZL=16,MAXNUMVARS=17;  //<-- Be _sure_ to define MAXNUMVARS appropriately!\n\nstatic const int UT=0,UX=1,UY=2,UZ=3;\n\n// The "I" suffix denotes interpolation. In other words, these\n//    definitions are used for interpolation ONLY. The order here\n//    matters as well!\nstatic const int SHIFTXI=0,SHIFTYI=1,SHIFTZI=2,GUPXXI=3,GUPXYI=4,GUPXZI=5,GUPYYI=6,GUPYZI=7,GUPZZI=8,\n  PSII=9,LAPM1I=10,A_XI=11,A_YI=12,A_ZI=13,LAPSE_PSI2I=14,LAPSE_OVER_PSI6I=15,MAXNUMINTERP=16;\n\n// Again, the order here MATTERS, since we assume in the code that, e.g., smallb[0]=b^t, smallb[3]=b^z, etc.\nstatic const int SMALLBT=0,SMALLBX=1,SMALLBY=2,SMALLBZ=3,SMALLB2=4,NUMVARS_SMALLB=5;\n\n// Again, the order here MATTERS, since we assume in the code that, CONSERV[STILDEX+1] = \\tilde{S}_y\nstatic const int RHOSTAR=0,STILDEX=1,STILDEY=2,STILDEZ=3,TAUENERGY=4,NUM_CONSERVS=5;\n\nstatic const int LAPSE=0,PSI2=1,PSI4=2,PSI6=3,PSIM4=4,LAPSEINV=5,NUMVARS_METRIC_AUX=6;\n#define SET_LAPSE_PSI4(array_name,METRIC)   {                   \\\n      array_name[LAPSE] = METRIC[LAPM1]+1.0;                    \\\n      array_name[PSI2]  = exp(2.0*METRIC[PHI]);                 \\\n      array_name[PSI4]  = SQR(array_name[PSI2]);                \\\n      array_name[PSI6]  = array_name[PSI4]*array_name[PSI2];    \\\n      array_name[PSIM4]  = 1.0/array_name[PSI4];                \\\n      array_name[LAPSEINV]  = 1.0/array_name[LAPSE];            \\\n  }\n\n// Keeping track of ghostzones between routines is a nightmare, so\n//   we instead attach ghostzone info to each gridfunction and set\n//   the ghostzone information correctly within each routine.\nstruct gf_and_gz_struct {\n  CCTK_REAL *gf;\n  int gz_lo[4],gz_hi[4];\n};\n\n#define MAX_EOS_PARAMS 10\nstruct eos_struct {\n  int neos;\n  CCTK_REAL rho_ppoly_tab[MAX_EOS_PARAMS-1];\n  CCTK_REAL eps_integ_const[MAX_EOS_PARAMS],K_ppoly_tab[MAX_EOS_PARAMS],Gamma_ppoly_tab[MAX_EOS_PARAMS];\n};\n\nstruct output_stats {\n  int font_fixed,vel_limited,failure_checker;\n  long n_iter;\n};\n\n\n// FIXME: For cosmetic purposes, we might want to make everything either zero-offset or one-offset, instead of a mixture.\nconst int kronecker_delta[4][3] = { { 0,0,0 },\n                                    { 1,0,0 },\n                                    { 0,1,0 },\n                                    { 0,0,1 } };\n\n/* PUBLIC FUNCTIONS, USED OUTSIDE IllinoisGRMHD AS WELL */\nvoid IllinoisGRMHD_enforce_limits_on_primitives_and_recompute_conservs(const int already_computed_physical_metric_and_inverse,CCTK_REAL *U,struct output_stats &stats,eos_struct &eos,\n                                                                       CCTK_REAL *METRIC,CCTK_REAL g4dn[4][4],CCTK_REAL g4up[4][4], CCTK_REAL *TUPMUNU,CCTK_REAL *TDNMUNU,CCTK_REAL *CONSERVS);\n\nvoid IllinoisGRMHD_convert_ADM_to_BSSN__enforce_detgtij_eq_1__and_compute_gtupij\n(const cGH *cctkGH,const int *cctk_lsh,\n CCTK_REAL *gxx,CCTK_REAL *gxy,CCTK_REAL *gxz,CCTK_REAL *gyy,CCTK_REAL *gyz,CCTK_REAL *gzz,CCTK_REAL *alp,\n CCTK_REAL *gtxx,CCTK_REAL *gtxy,CCTK_REAL *gtxz,CCTK_REAL *gtyy,CCTK_REAL *gtyz,CCTK_REAL *gtzz,\n CCTK_REAL *gtupxx,CCTK_REAL *gtupxy,CCTK_REAL *gtupxz,CCTK_REAL *gtupyy,CCTK_REAL *gtupyz,CCTK_REAL *gtupzz,\n CCTK_REAL *phi,CCTK_REAL *psi,CCTK_REAL *lapm1);\n\nvoid IllinoisGRMHD_set_symmetry_gzs_staggered(const cGH *cctkGH, const int *cctk_lsh,CCTK_REAL *X,CCTK_REAL *Y,CCTK_REAL *Z,  CCTK_REAL *gridfunc,\n                                              CCTK_REAL *gridfunc_syms,int stagger_x,int stagger_y,int stagger_z);\n\n#include "IllinoisGRMHD_EoS_lowlevel_functs.C"\n#endif // ILLINOISGRMHD_HEADERS_H\n\n')


# <a id='code_validation'></a>
# 
# # Step n-1: Code validation \[Back to [top](#toc)\]
# $$\label{code_validation}$$
# 
# First we download the original `IllinoisGRMHD` source code and then compare it to the source code generated by this tutorial notebook.

# In[3]:


# Verify if the code generated by this tutorial module
# matches the original IllinoisGRMHD source code

# First download the original IllinoisGRMHD source code
import urllib
from os import path

original_IGM_file_url  = "https://bitbucket.org/zach_etienne/wvuthorns/raw/5611b2f0b17135538c9d9d17c7da062abe0401b6/IllinoisGRMHD/src/IllinoisGRMHD_headers.h"
original_IGM_file_name = "IllinoisGRMHD_headers-original.h"
original_IGM_file_path = os.path.join(IGM_src_dir_path,original_IGM_file_name)

# Then download the original IllinoisGRMHD source code
# We try it here in a couple of ways in an attempt to keep
# the code more portable
try:
    original_IGM_file_code = urllib.request.urlopen(original_IGM_file_url).read().decode("utf-8")
    # Write down the file the original IllinoisGRMHD source code
    with open(original_IGM_file_path,"w") as file:
        file.write(original_IGM_file_code)
except:
    try:
        original_IGM_file_code = urllib.urlopen(original_IGM_file_url).read().decode("utf-8")
        # Write down the file the original IllinoisGRMHD source code
        with open(original_IGM_file_path,"w") as file:
            file.write(original_IGM_file_code)
    except:
        # If all else fails, hope wget does the job
        get_ipython().system('wget -O $original_IGM_file_path $original_IGM_file_url')

# Perform validation
Validation__IllinoisGRMHD_headers__h  = get_ipython().getoutput('diff $original_IGM_file_path $outfile_path__IllinoisGRMHD_headers__h')

if Validation__IllinoisGRMHD_headers__h == []:
    # If the validation passes, we do not need to store the original IGM source code file
    get_ipython().system('rm $original_IGM_file_path')
    print("Validation test for IllinoisGRMHD_headers.h: PASSED!")
else:
    # If the validation fails, we keep the original IGM source code file
    print("Validation test for IllinoisGRMHD_headers.h: FAILED!")
    # We also print out the difference between the code generated
    # in this tutorial module and the original IGM source code
    print("Diff:")
    for diff_line in Validation__IllinoisGRMHD_headers__h:
        print(diff_line)


# <a id='latex_pdf_output'></a>
# 
# # Step n: Output this notebook to $\LaTeX$-formatted PDF file \[Back to [top](#toc)\]
# $$\label{latex_pdf_output}$$
# 
# The following code cell converts this Jupyter notebook into a proper, clickable $\LaTeX$-formatted PDF file. After the cell is successfully run, the generated PDF may be found in the root NRPy+ tutorial directory, with filename
# [Tutorial-IllinoisGRMHD__IllinoisGRMHD_headers.pdf](Tutorial-IllinoisGRMHD__IllinoisGRMHD_headers.pdf) (Note that clicking on this link may not work; you may need to open the PDF file through another means).

# In[4]:


latex_nrpy_style_path = os.path.join(nrpy_dir_path,"latex_nrpy_style.tplx")
#!jupyter nbconvert --to latex --template $latex_nrpy_style_path --log-level='WARN' Tutorial-IllinoisGRMHD__IllinoisGRMHD_headers.ipynb
#!pdflatex -interaction=batchmode Tutorial-IllinoisGRMHD__IllinoisGRMHD_headers.tex
#!pdflatex -interaction=batchmode Tutorial-IllinoisGRMHD__IllinoisGRMHD_headers.tex
#!pdflatex -interaction=batchmode Tutorial-IllinoisGRMHD__IllinoisGRMHD_headers.tex
get_ipython().system('rm -f Tut*.out Tut*.aux Tut*.log')