grmhd
This page contains a full reference of all parameters available for the grmhd module. At the bottom of the page you can find an example parameter block that can be used in your parameter file.
grmhd
GRMHD
Name:
bc_kindType:
keyword
Default:
outgoing
Range:
outgoing, none
Description:
Boundary conditions
Name:
id_typeType:
keyword
Default:
minkowski_vacuum
Range:
minkowski_vacuum, shocktube, magnetic_rotor, bondi_flow, orszag_tang_vortex, fmtorus, tov, blastwave, gas_cloud, puncture, lorene_bns, two_punctures, fuka
Description:
Initial data type
atmosphere
Parameters describing atmosphere conditions
Name:
rho_flType:
double
Default:
1e-14
Range:
[0,*)
Description:
Rest mass density floor
Name:
ye_flType:
double
Default:
0.0
Range:
[0,*)
Description:
Ye floor (if not beta_eq)
Name:
temp_flType:
double
Default:
0.0
Range:
[0,*)
Description:
temperature floor
Name:
rho_scalingType:
double
Default:
0.0
Range:
(*,*)
Description:
Atmosphere density is rho_fl * r^(rho_scaling)
Name:
temp_scalingType:
double
Default:
0.0
Range:
(*,*)
Description:
Atmosphere temperature is temp_fl * r^(temp_scaling)
Name:
atmosphere_is_beta_eqType:
bool
Default:
True
Description:
Override ye_fl with beta equilibrium ye at atmosphere conditions
Name:
atmo_tolType:
double
Default:
1e-3
Range:
[0,*)
Description:
When setting points to atmosphere, check if rho < rho_atm * (1+tol)
excision
Parameters describing excision conditions
Name:
excision_criterionType:
keyword
Default:
lapse
Range:
lapse, radius
Description:
Either excise when alpha<alpha_exc or r<r_exc
Name:
excision_lapseType:
double
Default:
0.05
Range:
(0,*)
Description:
If excision criterion is lapse, where to excise
Name:
excision_radiusType:
double
Default:
1.0
Range:
(0,*)
Description:
If excision criterion is radius, where to excise
c2p
Parameters that control the behaviour of the c2p
Name:
toleranceType:
double
Default:
1e-10
Range:
(0,*)
Description:
Tolerance for accepting c2p inversion
Name:
max_lorentzType:
double
Default:
50
Range:
[1,*)
Description:
Maximum allowed Lorentz factor
Name:
max_sigmaType:
double
Default:
100
Range:
[0,*)
Description:
Maximum allowed magnetization
Name:
use_c2p_entropy_backupType:
bool
Default:
True
Description:
Fall back to entropy prescription on c2p failure
Name:
beta_fallbackType:
double
Default:
1e-2
Range:
[0,*)
Description:
Directly use entropy backup if beta<fallback_threshold
Name:
bh_alp_threshType:
double
Default:
0.2
Range:
(0,*)
Description:
If alp <= thresh we are inside a BH and c2p errors become lenient
Name:
B_field_initializationType:
keyword
Default:
none
Range:
none, from_Avec, direct
Description:
How should we initialize the magnetic field?
Avec_ID
Parameters for initialization of vector potential at cell edges
Name:
Avec_kindType:
keyword
Default:
poloidal_confined
Range:
poloidal_confined
Description:
Avec prescription
Name:
cutoff_varType:
string
Default:
press
Description:
Variable on which A depends
Name:
cutoff_factType:
double
Default:
0.02
Range:
(0,1)
Description:
Fraction of max(var) at below which A is zero
Name:
Bmax_targetType:
double
Default:
0.0
Range:
[0,*)
Description:
Target |B|_max at cell center, in code units
Name:
A_nType:
double
Default:
1.0
Range:
[0,*)
Description:
Power law index of A(var) dependence
Name:
is_binaryType:
bool
Default:
False
Description:
Is initial data a binary system?
Name:
x_c_1Type:
double
Default:
0.0
Range:
(*,*)
Description:
Center around which A is set (if binary center of star 1)
Name:
y_c_1Type:
double
Default:
0.0
Range:
(*,*)
Description:
Center around which A is set (if binary center of star 1)
Name:
z_c_1Type:
double
Default:
0.0
Range:
(*,*)
Description:
Only for binary: center of second star
Name:
radius_1Type:
double
Default:
100
Range:
(0,*)
Description:
Approximate radius of star 1, must not overlap with companion, must contain star.
Name:
x_c_2Type:
double
Default:
0.0
Range:
(*,*)
Description:
Only for binary: center of second star
Name:
y_c_2Type:
double
Default:
0.0
Range:
(*,*)
Description:
Only for binary: center of second star
Name:
z_c_2Type:
double
Default:
0.0
Range:
(*,*)
Description:
Only for binary: center of second star
Name:
radius_2Type:
double
Default:
1
Range:
(0,*)
Description:
Approximate radius of star 2, must not overlap with companion, must contain star.
bondi_flow
Parameters for Bondi ID
Name:
r_cType:
double
Default:
8.0
Range:
(0,*)
Description:
Critical radius
Name:
KType:
double
Default:
1.0
Range:
(0,*)
Description:
Initial data adiabat
Name:
gammaType:
double
Default:
1.3333
Range:
(1,*)
Description:
Initial data gamma
Name:
temp_minType:
double
Default:
0.01
Range:
(0,*)
Description:
Lower bound for T
Name:
temp_maxType:
double
Default:
10
Range:
(0,*)
Description:
Upper bound of T
Name:
spinType:
double
Default:
0.0
Range:
[0,1)
Description:
Black hole spin
Name:
spec_ang_momType:
double
Default:
0.0
Range:
[0,*)
Description:
Specific angular momentum
Name:
spec_ang_mom_scalingType:
double
Default:
0.0
Range:
(*,*)
Description:
Scaling of j with theta
Name:
is_magnetizedType:
bool
Default:
False
Description:
Add a radial monopole B field?
Name:
beta_cType:
double
Default:
0.246
Range:
(0,*)
Description:
Plasma beta at rc for B field normalization
vacuum
Parameters for minkowski constant state
Name:
rho_floorType:
double
Default:
1e-15
Range:
(0,*)
Description:
Rest mass density
Name:
press_floorType:
double
Default:
1e-15
Range:
(0,*)
Description:
Pressure
Name:
velocity_xType:
double
Default:
0.0
Range:
(*,*)
Description:
v^x
Name:
velocity_yType:
double
Default:
0.0
Range:
(*,*)
Description:
v^y
Name:
velocity_zType:
double
Default:
0.0
Range:
(*,*)
Description:
v^z
shocktube
Parameters for shocktube problem
Name:
press_LType:
double
Default:
13.3
Range:
(0,*)
Description:
Pressure in left state
Name:
press_RType:
double
Default:
6.6e-07
Range:
(0,*)
Description:
Pressure in right state
Name:
rho_LType:
double
Default:
10.0
Range:
(0,*)
Description:
Rest mass density in left state
Name:
rho_RType:
double
Default:
1.0
Range:
(0,*)
Description:
Rest mass density in right state
Name:
Bx_LType:
double
Default:
0.0
Range:
(*,*)
Description:
B^x in left state (note you must set B_initialization to direct)
Name:
Bx_RType:
double
Default:
0.0
Range:
(*,*)
Description:
B^x in right state (note you must set B_initialization to direct)
Name:
By_LType:
double
Default:
0.0
Range:
(*,*)
Description:
B^y in left state (note you must set B_initialization to direct)
Name:
By_RType:
double
Default:
0.0
Range:
(*,*)
Description:
B^y in right state (note you must set B_initialization to direct)
Name:
Bz_LType:
double
Default:
0.0
Range:
(*,*)
Description:
B^z in left state (note you must set B_initialization to direct)
Name:
Bz_RType:
double
Default:
0.0
Range:
(*,*)
Description:
B^z in right state (note you must set B_initialization to direct)
magnetic_rotor
Parameters for magnetic rotor test
Name:
rho_inType:
double
Default:
10.0
Range:
(0,*)
Description:
Density inside cylinder
Name:
rho_outType:
double
Default:
1.0
Range:
(0,*)
Description:
Density outside cylinder
Name:
pressType:
double
Default:
1.0
Range:
(0,*)
Description:
Pressure
Name:
B0Type:
double
Default:
1.0
Range:
(*,*)
Description:
B^x
orszag_tang_vortex
Parameters for Orszag-Tang vortex test
Name:
pressType:
double
Default:
10.0
Range:
(0,*)
Description:
Pressure
Name:
rhoType:
double
Default:
1.0
Range:
(0,*)
Description:
density
fmtorus
Parameters for Fishborne Moncrief torus
Name:
a_BHType:
double
Default:
0.9375
Range:
(0,1)
Description:
Black hole spin
Name:
rho_minType:
double
Default:
1e-05
Range:
(0,*)
Description:
Minimum density
Name:
rho_maxType:
double
Default:
1.0
Range:
(0,*)
Description:
Maximum density
Name:
lapse_minType:
double
Default:
0.2
Range:
(0,*)
Description:
Minimum lapse
Name:
press_minType:
double
Default:
3.33e-08
Range:
(0,*)
Description:
Minimum pressure
Name:
r_inType:
double
Default:
6.0
Range:
(0,*)
Description:
Radius of inner edge
Name:
r_at_max_densityType:
double
Default:
12.0
Range:
(0,*)
Description:
Radius of max density location
Name:
gammaType:
double
Default:
1.333333
Range:
(1,*)
Description:
Gamma of initial data EOS (polytrope selected by rho_max/press_max)
Name:
max_inverse_betaType:
double
Default:
100
Range:
[0,*)
Description:
Scale of magnetic field
Name:
perturbation_amplitudeType:
double
Default:
0.0
Range:
[0,*)
Description:
Pressure perturbation scale, currently broken
Name:
rho_powerType:
double
Default:
-1.5
Range:
(*,*)
Description:
Power law decay in rho
Name:
press_powerType:
double
Default:
-2.5
Range:
(*,*)
Description:
Power law decay in press
lorene_bns
Lorene BNS ID
Name:
filenameType:
string
Default:
./id.res
Description:
Filename containing initial data for LORENE ID
Name:
set_shift_to_zeroType:
bool
Default:
False
Description:
Initially set the shift to zero?
Name:
reset_epsType:
bool
Default:
False
Description:
Recompute eps after initial data?
fuka
FUKA ID
Name:
filenameType:
string
Description:
Filename containing initial data for FUKA ID
Name:
id_dirType:
string
Description:
Directory containing the FUKA ID
Name:
fuka_id_typeType:
keyword
Default:
BNS
Range:
BH, BBH, NS, BNS, BHNS
Description:
type of FUKA data
Name:
id_interpolation_offsetType:
double
Default:
0.0
Range:
[0,*)
Description:
Offset applied during ID interpolation
Name:
junk_interp_orderType:
int
Default:
8
Range:
[3,8]
Description:
Interpolation order used for junk radiation removal
Name:
delta_r_relType:
double
Default:
0.3
Range:
(0,*)
Description:
Relative radial offset for interpolation grid adjustment
Name:
set_shift_to_zeroType:
bool
Default:
True
Description:
set the initial shift to zero (recommended)
two_punctures
Parameters for TwoPunctures initial data
Name:
par_bType:
double
Default:
1
Range:
(0,*)
Description:
Distance of the two punctures along the x axis
Name:
target_M_plusType:
double
Default:
1
Range:
(0,*)
Description:
ADM mass of the first puncture
Name:
par_P_plus_xType:
double
Default:
0
Range:
(*,*)
Description:
Momentum of the first puncture along x
Name:
par_P_plus_yType:
double
Default:
0
Range:
(*,*)
Description:
Momentum of the first puncture along y
Name:
par_P_plus_zType:
double
Default:
0
Range:
(*,*)
Description:
Momentum of the first puncture along z
Name:
par_S_plus_xType:
double
Default:
0
Range:
(*,*)
Description:
Angular momentum of the first puncture along x
Name:
par_S_plus_yType:
double
Default:
0
Range:
(*,*)
Description:
Angular momentum of the first puncture along y
Name:
par_S_plus_zType:
double
Default:
0
Range:
(*,*)
Description:
Angular momentum of the first puncture along z
Name:
target_M_minusType:
double
Default:
1
Range:
(0,*)
Description:
ADM mass of the second puncture
Name:
par_P_minus_xType:
double
Default:
0
Range:
(*,*)
Description:
Momentum of the second puncture along x
Name:
par_P_minus_yType:
double
Default:
0
Range:
(*,*)
Description:
Momentum of the second puncture along y
Name:
par_P_minus_zType:
double
Default:
0
Range:
(*,*)
Description:
Momentum of the second puncture along z
Name:
par_S_minus_xType:
double
Default:
0
Range:
(*,*)
Description:
Angular momentum of the second puncture along x
Name:
par_S_minus_yType:
double
Default:
0
Range:
(*,*)
Description:
Angular momentum of the second puncture along y
Name:
par_S_minus_zType:
double
Default:
0
Range:
(*,*)
Description:
Angular momentum of the second puncture along z
Name:
npoints_AType:
unsigned int
Default:
30
Range:
(0,*)
Description:
Number of points on grid for first puncture
Name:
npoints_BType:
unsigned int
Default:
30
Range:
(0,*)
Description:
Number of points on grid for second puncture
Name:
npoints_phiType:
unsigned int
Default:
16
Range:
(0,*)
Description:
Number of points on phi grid, must be multiple of 4
Name:
TP_epsilonType:
double
Default:
0
Range:
[0,*)
Description:
A small number to smooth out singularities at the puncture locations
tov
TOV initial data
Name:
rho_cType:
double
Default:
0.00128
Range:
(0,*)
Description:
Central density of the TOV
Name:
press_floorType:
double
Default:
1e-6
Range:
(0,*)
Description:
Floor of the pressure
Name:
drType:
double
Default:
1e-3
Range:
(0,*)
Description:
Radial grid spacing
Name:
pert_ampType:
double
Default:
0.0
Range:
(*,*)
Description:
Radial velocity perturbation amplitude