
\section{Interfaces} 


\parskip = 0pt

\vspace{3mm} \subsection*{General}

\noindent {\bf Implements}: 

illinoisgrmhd
\vspace{2mm}

\noindent {\bf Inherits}: 

admbase

tmunubase

hydrobase

grhaylib
\vspace{2mm}
\subsection*{Grid Variables}
\vspace{5mm}\subsubsection{PRIVATE GROUPS}

\vspace{5mm}

\begin{tabular*}{150mm}{|c|c@{\extracolsep{\fill}}|rl|} \hline 
~ {\bf Group Names} ~ & ~ {\bf Variable Names} ~  &{\bf Details} ~ & ~\\ 
\hline 
grmhd\_velocities &  & compact & 0 \\ 
 & vx & description & Components of primitive three velocity v\^i. Note that v\^i is defined in terms of 4-velocity as: v\^i = u\^i/u\^0. Note that this definition differs from the Valencia formalism. \\ 
 & vy & dimensions & 3 \\ 
 & vz & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & InterpNumTimelevels=1 prolongation="none" \\ 
 &  & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
u0 & u0 & compact & 0 \\ 
 &  & description & 4-velocity component u\^0 \\ 
 &  & dimensions & 3 \\ 
 &  & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & InterpNumTimelevels=1 prolongation="none" checkpoint="no" \\ 
 &  & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
grmhd\_conservatives &  & compact & 0 \\ 
 & rho\_star & description & Evolved hydrodynamic variables \\ 
 & tau & dimensions & 3 \\ 
 & Stildex & distribution & DEFAULT \\ 
 & Stildey & group type & GF \\ 
 & Stildez & tags & prolongation="ENO" \\ 
 &  & timelevels & 3 \\ 
 &  & variable type & REAL \\ 
\hline 
ent\_star & ent\_star & compact & 0 \\ 
 &  & description & Evolved entropy variable \\ 
 &  & dimensions & 3 \\ 
 &  & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & prolongation="ENO" \\ 
 &  & timelevels & 3 \\ 
 &  & variable type & REAL \\ 
\hline 
ye\_star & Ye\_star & compact & 0 \\ 
 &  & description & Evolved electron fraction variable \\ 
 &  & dimensions & 3 \\ 
 &  & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & prolongation="ENO" \\ 
 &  & timelevels & 3 \\ 
 &  & variable type & REAL \\ 
\hline 
ax & Ax & compact & 0 \\ 
 &  & description & x-component of the vector potential \\ 
& ~ & description &  evolved when constrained\_transport\_scheme==3 \\ 
 &  & dimensions & 3 \\ 
 &  & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & Prolongation="STAGGER011" \\ 
 &  & timelevels & 3 \\ 
 &  & variable type & REAL \\ 
\hline 
\end{tabular*} 



\vspace{5mm}
\vspace{5mm}

\begin{tabular*}{150mm}{|c|c@{\extracolsep{\fill}}|rl|} \hline 
~ {\bf Group Names} ~ & ~ {\bf Variable Names} ~  &{\bf Details} ~ & ~ \\ 
\hline 
ay & Ay & compact & 0 \\ 
 &  & description & y-component of the vector potential \\ 
& ~ & description &  evolved when constrained\_transport\_scheme==3 \\ 
 &  & dimensions & 3 \\ 
 &  & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & Prolongation="STAGGER101" \\ 
 &  & timelevels & 3 \\ 
 &  & variable type & REAL \\ 
\hline 
az & Az & compact & 0 \\ 
 &  & description & z-component of the vector potential \\ 
& ~ & description &  evolved when constrained\_transport\_scheme==3 \\ 
 &  & dimensions & 3 \\ 
 &  & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & Prolongation="STAGGER110" \\ 
 &  & timelevels & 3 \\ 
 &  & variable type & REAL \\ 
\hline 
phitilde & phitilde & compact & 0 \\ 
 &  & description & sqrt\{gamma\} Phi \\ 
& ~ & description &  where Phi is the em scalar potential \\ 
 &  & dimensions & 3 \\ 
 &  & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & Prolongation="STAGGER111" \\ 
 &  & timelevels & 3 \\ 
 &  & variable type & REAL \\ 
\hline 
grmhd\_b\_stagger &  & compact & 0 \\ 
 & Bx\_stagger & description & Densitized B-field components defined at staggered points [Bx\_stagger at (i+1/2 \\ 
& ~ & description & j \\ 
 & Bx\_stagger & description & k) \\ 
 & Bx\_stagger & description & By\_stagger at (i \\ 
 & Bx\_stagger & description & j+1/2 \\ 
 & Bx\_stagger & description & k) \\ 
 & Bx\_stagger & description & Bz\_stagger at (i \\ 
 & Bx\_stagger & description & j \\ 
 & Bx\_stagger & description & k+1/2)]. \\ 
 & By\_stagger & dimensions & 3 \\ 
 & Bz\_stagger & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & InterpNumTimelevels=1 prolongation="none" \\ 
 &  & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
grmhd\_b\_center &  & compact & 0 \\ 
 & Bx\_center & description & B-field components defined at vertices. \\ 
 & By\_center & dimensions & 3 \\ 
 & Bz\_center & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & InterpNumTimelevels=1 prolongation="none" \\ 
 &  & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
grmhd\_conservatives\_rhs &  & compact & 0 \\ 
 & rho\_star\_rhs & description & Right-hand side for evolved conservative variables \\ 
 & tau\_rhs & dimensions & 3 \\ 
 & Stildex\_rhs & distribution & DEFAULT \\ 
 & Stildey\_rhs & group type & GF \\ 
 & Stildez\_rhs & tags & prolongation="none" Checkpoint="no" \\ 
 &  & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
\end{tabular*} 



\vspace{5mm}
\vspace{5mm}

\begin{tabular*}{150mm}{|c|c@{\extracolsep{\fill}}|rl|} \hline 
~ {\bf Group Names} ~ & ~ {\bf Variable Names} ~  &{\bf Details} ~ & ~ \\ 
\hline 
ent\_star\_rhs & ent\_star\_rhs & compact & 0 \\ 
 &  & description & Right-hand side for ent\_star \\ 
 &  & dimensions & 3 \\ 
 &  & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & prolongation="none" Checkpoint="no" \\ 
 &  & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
ye\_star\_rhs & Ye\_star\_rhs & compact & 0 \\ 
 &  & description & Right-hand side for Ye\_star \\ 
 &  & dimensions & 3 \\ 
 &  & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & prolongation="none" Checkpoint="no" \\ 
 &  & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
em\_rhs &  & compact & 0 \\ 
 & Ax\_rhs & description & Storage for the right-hand side of the partial\_t A equations and partial\_t (psi\^6 Phi) equation. \\ 
 & Ay\_rhs & dimensions & 3 \\ 
 & Az\_rhs & distribution & DEFAULT \\ 
 & phitilde\_rhs & group type & GF \\ 
 &  & tags & prolongation="none" Checkpoint="no" \\ 
 &  & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
grmhd\_cmin\_cmax\_temps &  & compact & 0 \\ 
 & cmin\_x & description & Store min and max characteristic speeds in all three directions. \\ 
 & cmax\_x & dimensions & 3 \\ 
 & cmin\_y & distribution & DEFAULT \\ 
 & cmax\_y & group type & GF \\ 
 & cmin\_z & tags & prolongation="none" Checkpoint="no" \\ 
 & cmax\_z & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
grmhd\_flux\_temps &  & compact & 0 \\ 
 & rho\_star\_flux & description & Flux variables for computing RHSs \\ 
 & tau\_flux & dimensions & 3 \\ 
 & Stildex\_flux & distribution & DEFAULT \\ 
 & Stildey\_flux & group type & GF \\ 
 & Stildez\_flux & tags & prolongation="none" Checkpoint="no" \\ 
 &  & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
ent\_star\_flux & ent\_star\_flux & compact & 0 \\ 
 &  & description & Flux variable for ent\_star \\ 
 &  & dimensions & 3 \\ 
 &  & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & prolongation="none" Checkpoint="no" \\ 
 &  & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
\end{tabular*} 



\vspace{5mm}
\vspace{5mm}

\begin{tabular*}{150mm}{|c|c@{\extracolsep{\fill}}|rl|} \hline 
~ {\bf Group Names} ~ & ~ {\bf Variable Names} ~  &{\bf Details} ~ & ~ \\ 
\hline 
ye\_star\_flux & Ye\_star\_flux & compact & 0 \\ 
 &  & description & Flux variable for Ye\_star \\ 
 &  & dimensions & 3 \\ 
 &  & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & prolongation="none" Checkpoint="no" \\ 
 &  & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
grmhd\_primitives\_reconstructed\_temps &  & compact & 0 \\ 
 & vxr & description & Temporary variables used for primitives reconstruction \\ 
 & vyr & dimensions & 3 \\ 
 & vzr & distribution & DEFAULT \\ 
 & vxl & group type & GF \\ 
 & vyl & tags & prolongation="none" Checkpoint="no" \\ 
 & vzl & timelevels & 1 \\ 
 & Bx\_staggerr & variable type & REAL \\ 
\hline 
failure\_checker & failure\_checker & compact & 0 \\ 
 &  & description & Gridfunction to track conservative-to-primitives solver fixes. Beware that this gridfunction is overwritten at each RK substep. \\ 
 &  & dimensions & 3 \\ 
 &  & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & prolongation="none" Checkpoint="no" InterpNumTimelevels=1 \\ 
 &  & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
em\_psi6phi &  & compact & 0 \\ 
 & psi6phi & description & Deprecated variable \\ 
 &  & dimensions & 3 \\ 
 &  & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & Prolongation="STAGGER111" \\ 
 &  & timelevels & 3 \\ 
 &  & variable type & REAL \\ 
\hline 
grmhd\_primitives\_allbutbi &  & compact & 0 \\ 
 & rho\_b & description & Deprecated variables \\ 
 & P & dimensions & 3 \\ 
 &  & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & InterpNumTimelevels=1 prolongation="none" \\ 
 &  & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
grmhd\_primitives\_bi &  & compact & 0 \\ 
 & Bx & description & Deprecated variables \\ 
 & By & dimensions & 3 \\ 
 & Bz & distribution & DEFAULT \\ 
 &  & group type & GF \\ 
 &  & tags & InterpNumTimelevels=1 prolongation="none" \\ 
 &  & timelevels & 1 \\ 
 &  & variable type & REAL \\ 
\hline 
\end{tabular*} 



\vspace{5mm}

\noindent {\bf Uses header}: 

Symmetry.h

GRHayLib.h
\vspace{2mm}\parskip = 10pt 
