From 2541fad23d1c8a18a64011215ec89fc5a6055cbe Mon Sep 17 00:00:00 2001 From: Michael Zingale Date: Sat, 14 Sep 2024 15:14:37 -0400 Subject: [PATCH] regenerate the defaults for the docs (#268) --- docs/source/_defaults.inc | 146 +++++++++--------- docs/source/advection_defaults.inc | 48 +++--- docs/source/advection_fv4_defaults.inc | 36 ++--- docs/source/advection_nonuniform_defaults.inc | 48 +++--- docs/source/advection_rk_defaults.inc | 36 ++--- docs/source/advection_weno_defaults.inc | 42 ++--- docs/source/burgers_defaults.inc | 40 ++--- docs/source/compressible_defaults.inc | 94 +++++------ docs/source/compressible_fv4_defaults.inc | 66 ++++---- docs/source/compressible_react_defaults.inc | 68 ++++---- docs/source/compressible_rk_defaults.inc | 74 ++++----- docs/source/compressible_sdc_defaults.inc | 66 ++++---- docs/source/diffusion_defaults.inc | 24 +-- docs/source/incompressible_defaults.inc | 44 +++--- .../incompressible_viscous_defaults.inc | 70 ++++----- docs/source/lm_atm_defaults.inc | 44 +++--- docs/source/swe_defaults.inc | 56 +++---- docs/source/viscous_burgers_defaults.inc | 44 +++--- pyro/util/runparams.py | 8 +- 19 files changed, 532 insertions(+), 522 deletions(-) diff --git a/docs/source/_defaults.inc b/docs/source/_defaults.inc index 3ca870a47..3872ccbae 100644 --- a/docs/source/_defaults.inc +++ b/docs/source/_defaults.inc @@ -1,80 +1,86 @@ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | tmax | ``1.0`` | maximum simulation time to evolve | - +----------------------------------+----------------+----------------------------------------------------+ - | max_steps | ``10000`` | maximum number of steps to take | - +----------------------------------+----------------+----------------------------------------------------+ - | fix_dt | ``-1.0`` | | - +----------------------------------+----------------+----------------------------------------------------+ - | init_tstep_factor | ``0.01`` | first timestep = init_tstep_factor * CFL timestep | - +----------------------------------+----------------+----------------------------------------------------+ - | max_dt_change | ``2.0`` | max amount the timestep can change between steps | - +----------------------------------+----------------+----------------------------------------------------+ - | verbose | ``1.0`` | verbosity | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | tmax | ``1.0`` | maximum simulation time to evolve | + +----------------------------------+------------------+----------------------------------------------------+ + | max_steps | ``10000`` | maximum number of steps to take | + +----------------------------------+------------------+----------------------------------------------------+ + | fix_dt | ``-1.0`` | | + +----------------------------------+------------------+----------------------------------------------------+ + | init_tstep_factor | ``0.01`` | first timestep = init_tstep_factor * CFL timestep | + +----------------------------------+------------------+----------------------------------------------------+ + | max_dt_change | ``2.0`` | max amount the timestep can change between steps | + +----------------------------------+------------------+----------------------------------------------------+ + | verbose | ``1.0`` | verbosity | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [io] +* section: ``[io]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | basename | ``pyro_`` | basename for output files | - +----------------------------------+----------------+----------------------------------------------------+ - | dt_out | ``0.1`` | simulation time between writing output files | - +----------------------------------+----------------+----------------------------------------------------+ - | n_out | ``10000`` | number of timesteps between writing output files | - +----------------------------------+----------------+----------------------------------------------------+ - | do_io | ``1`` | do we output at all? | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | basename | ``pyro_`` | basename for output files | + +----------------------------------+------------------+----------------------------------------------------+ + | dt_out | ``0.1`` | simulation time between writing output files | + +----------------------------------+------------------+----------------------------------------------------+ + | n_out | ``10000`` | number of timesteps between writing output files | + +----------------------------------+------------------+----------------------------------------------------+ + | do_io | ``1`` | do we output at all? | + +----------------------------------+------------------+----------------------------------------------------+ + | force_final_output | ``0`` | regardless of do_io, do we output when the | + | | | simulation ends? | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [mesh] +* section: ``[mesh]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | xmin | ``0.0`` | domain minimum x-coordinate | - +----------------------------------+----------------+----------------------------------------------------+ - | xmax | ``1.0`` | domain maximum x-coordinate | - +----------------------------------+----------------+----------------------------------------------------+ - | ymin | ``0.0`` | domain minimum y-coordinate | - +----------------------------------+----------------+----------------------------------------------------+ - | ymax | ``1.0`` | domain maximum y-coordinate | - +----------------------------------+----------------+----------------------------------------------------+ - | xlboundary | ``reflect`` | minimum x BC ('reflect', 'outflow', or 'periodic') | - +----------------------------------+----------------+----------------------------------------------------+ - | xrboundary | ``reflect`` | maximum x BC ('reflect', 'outflow', or 'periodic') | - +----------------------------------+----------------+----------------------------------------------------+ - | ylboundary | ``reflect`` | minimum y BC ('reflect', 'outflow', or 'periodic') | - +----------------------------------+----------------+----------------------------------------------------+ - | yrboundary | ``reflect`` | maximum y BC ('reflect', 'outflow', or 'periodic') | - +----------------------------------+----------------+----------------------------------------------------+ - | nx | ``25`` | number of zones in the x-direction | - +----------------------------------+----------------+----------------------------------------------------+ - | ny | ``25`` | number of zones in the y-direction | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | grid_type | ``Cartesian2d`` | Geometry of the Grid ('Cartesian2d' or | + | | | 'SphericalPolar') | + +----------------------------------+------------------+----------------------------------------------------+ + | xmin | ``0.0`` | domain minimum x-coordinate | + +----------------------------------+------------------+----------------------------------------------------+ + | xmax | ``1.0`` | domain maximum x-coordinate | + +----------------------------------+------------------+----------------------------------------------------+ + | ymin | ``0.0`` | domain minimum y-coordinate | + +----------------------------------+------------------+----------------------------------------------------+ + | ymax | ``1.0`` | domain maximum y-coordinate | + +----------------------------------+------------------+----------------------------------------------------+ + | xlboundary | ``reflect`` | minimum x BC ('reflect', 'outflow', or 'periodic') | + +----------------------------------+------------------+----------------------------------------------------+ + | xrboundary | ``reflect`` | maximum x BC ('reflect', 'outflow', or 'periodic') | + +----------------------------------+------------------+----------------------------------------------------+ + | ylboundary | ``reflect`` | minimum y BC ('reflect', 'outflow', or 'periodic') | + +----------------------------------+------------------+----------------------------------------------------+ + | yrboundary | ``reflect`` | maximum y BC ('reflect', 'outflow', or 'periodic') | + +----------------------------------+------------------+----------------------------------------------------+ + | nx | ``25`` | number of zones in the x-direction | + +----------------------------------+------------------+----------------------------------------------------+ + | ny | ``25`` | number of zones in the y-direction | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [particles] +* section: ``[particles]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | do_particles | ``0`` | include particles? (1=yes, 0=no) | - +----------------------------------+----------------+----------------------------------------------------+ - | n_particles | ``100`` | number of particles | - +----------------------------------+----------------+----------------------------------------------------+ - | particle_generator | ``random`` | how do we generate particles? (random, grid) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | do_particles | ``0`` | include particles? (1=yes, 0=no) | + +----------------------------------+------------------+----------------------------------------------------+ + | n_particles | ``100`` | number of particles | + +----------------------------------+------------------+----------------------------------------------------+ + | particle_generator | ``random`` | how do we generate particles? (random, grid) | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [vis] +* section: ``[vis]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | dovis | ``1`` | runtime visualization? (1=yes, 0=no) | - +----------------------------------+----------------+----------------------------------------------------+ - | store_images | ``0`` | store vis images to files (1=yes, 0=no) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | dovis | ``1`` | runtime visualization? (1=yes, 0=no) | + +----------------------------------+------------------+----------------------------------------------------+ + | store_images | ``0`` | store vis images to files (1=yes, 0=no) | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/advection_defaults.inc b/docs/source/advection_defaults.inc index 0c3f45025..a3b795d5a 100644 --- a/docs/source/advection_defaults.inc +++ b/docs/source/advection_defaults.inc @@ -1,30 +1,30 @@ -* section: [advection] +* section: ``[advection]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | u | ``1.0`` | advective velocity in x-direction | - +----------------------------------+----------------+----------------------------------------------------+ - | v | ``1.0`` | advective velocity in y-direction | - +----------------------------------+----------------+----------------------------------------------------+ - | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | u | ``1.0`` | advective velocity in x-direction | + +----------------------------------+------------------+----------------------------------------------------+ + | v | ``1.0`` | advective velocity in y-direction | + +----------------------------------+------------------+----------------------------------------------------+ + | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | advective CFL number | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | advective CFL number | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [particles] +* section: ``[particles]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | do_particles | ``0`` | | - +----------------------------------+----------------+----------------------------------------------------+ - | particle_generator | ``grid`` | | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | do_particles | ``0`` | | + +----------------------------------+------------------+----------------------------------------------------+ + | particle_generator | ``grid`` | | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/advection_fv4_defaults.inc b/docs/source/advection_fv4_defaults.inc index 6adb76a1f..94e8f073d 100644 --- a/docs/source/advection_fv4_defaults.inc +++ b/docs/source/advection_fv4_defaults.inc @@ -1,22 +1,22 @@ -* section: [advection] +* section: ``[advection]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | u | ``1.0`` | advective velocity in x-direction | - +----------------------------------+----------------+----------------------------------------------------+ - | v | ``1.0`` | advective velocity in y-direction | - +----------------------------------+----------------+----------------------------------------------------+ - | limiter | ``1`` | limiter (0 = none, 1 = ppm) | - +----------------------------------+----------------+----------------------------------------------------+ - | temporal_method | ``RK4`` | integration method (see mesh/integrators.py) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | u | ``1.0`` | advective velocity in x-direction | + +----------------------------------+------------------+----------------------------------------------------+ + | v | ``1.0`` | advective velocity in y-direction | + +----------------------------------+------------------+----------------------------------------------------+ + | limiter | ``1`` | limiter (0 = none, 1 = ppm) | + +----------------------------------+------------------+----------------------------------------------------+ + | temporal_method | ``RK4`` | integration method (see mesh/integrators.py) | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | advective CFL number | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | advective CFL number | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/advection_nonuniform_defaults.inc b/docs/source/advection_nonuniform_defaults.inc index 0c3f45025..a3b795d5a 100644 --- a/docs/source/advection_nonuniform_defaults.inc +++ b/docs/source/advection_nonuniform_defaults.inc @@ -1,30 +1,30 @@ -* section: [advection] +* section: ``[advection]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | u | ``1.0`` | advective velocity in x-direction | - +----------------------------------+----------------+----------------------------------------------------+ - | v | ``1.0`` | advective velocity in y-direction | - +----------------------------------+----------------+----------------------------------------------------+ - | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | u | ``1.0`` | advective velocity in x-direction | + +----------------------------------+------------------+----------------------------------------------------+ + | v | ``1.0`` | advective velocity in y-direction | + +----------------------------------+------------------+----------------------------------------------------+ + | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | advective CFL number | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | advective CFL number | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [particles] +* section: ``[particles]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | do_particles | ``0`` | | - +----------------------------------+----------------+----------------------------------------------------+ - | particle_generator | ``grid`` | | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | do_particles | ``0`` | | + +----------------------------------+------------------+----------------------------------------------------+ + | particle_generator | ``grid`` | | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/advection_rk_defaults.inc b/docs/source/advection_rk_defaults.inc index f89bd7980..4441dda77 100644 --- a/docs/source/advection_rk_defaults.inc +++ b/docs/source/advection_rk_defaults.inc @@ -1,22 +1,22 @@ -* section: [advection] +* section: ``[advection]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | u | ``1.0`` | advective velocity in x-direction | - +----------------------------------+----------------+----------------------------------------------------+ - | v | ``1.0`` | advective velocity in y-direction | - +----------------------------------+----------------+----------------------------------------------------+ - | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | - +----------------------------------+----------------+----------------------------------------------------+ - | temporal_method | ``RK4`` | integration method (see mesh/integrators.py) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | u | ``1.0`` | advective velocity in x-direction | + +----------------------------------+------------------+----------------------------------------------------+ + | v | ``1.0`` | advective velocity in y-direction | + +----------------------------------+------------------+----------------------------------------------------+ + | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | + +----------------------------------+------------------+----------------------------------------------------+ + | temporal_method | ``RK4`` | integration method (see mesh/integrators.py) | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | advective CFL number | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | advective CFL number | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/advection_weno_defaults.inc b/docs/source/advection_weno_defaults.inc index ccae6d82b..f14b8080d 100644 --- a/docs/source/advection_weno_defaults.inc +++ b/docs/source/advection_weno_defaults.inc @@ -1,25 +1,25 @@ -* section: [advection] +* section: ``[advection]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | u | ``1.0`` | advective velocity in x-direction | - +----------------------------------+----------------+----------------------------------------------------+ - | v | ``1.0`` | advective velocity in y-direction | - +----------------------------------+----------------+----------------------------------------------------+ - | limiter | ``0`` | Unused here, but needed to inherit from advection | - | | | base class | - +----------------------------------+----------------+----------------------------------------------------+ - | weno_order | ``3`` | k in WENO scheme | - +----------------------------------+----------------+----------------------------------------------------+ - | temporal_method | ``RK4`` | integration method (see mesh/integrators.py) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | u | ``1.0`` | advective velocity in x-direction | + +----------------------------------+------------------+----------------------------------------------------+ + | v | ``1.0`` | advective velocity in y-direction | + +----------------------------------+------------------+----------------------------------------------------+ + | limiter | ``0`` | Unused here, but needed to inherit from advection | + | | | base class | + +----------------------------------+------------------+----------------------------------------------------+ + | weno_order | ``3`` | k in WENO scheme | + +----------------------------------+------------------+----------------------------------------------------+ + | temporal_method | ``RK4`` | integration method (see mesh/integrators.py) | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.5`` | advective CFL number | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.5`` | advective CFL number | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/burgers_defaults.inc b/docs/source/burgers_defaults.inc index 40f5d81c4..3e6e8546e 100644 --- a/docs/source/burgers_defaults.inc +++ b/docs/source/burgers_defaults.inc @@ -1,26 +1,26 @@ -* section: [advection] +* section: ``[advection]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | advective CFL number | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | advective CFL number | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [particles] +* section: ``[particles]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | do_particles | ``0`` | | - +----------------------------------+----------------+----------------------------------------------------+ - | particle_generator | ``grid`` | | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | do_particles | ``0`` | | + +----------------------------------+------------------+----------------------------------------------------+ + | particle_generator | ``grid`` | | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/compressible_defaults.inc b/docs/source/compressible_defaults.inc index a9218020f..4505e8867 100644 --- a/docs/source/compressible_defaults.inc +++ b/docs/source/compressible_defaults.inc @@ -1,48 +1,48 @@ -* section: [compressible] - - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | use_flattening | ``1`` | apply flattening at shocks (1) | - +----------------------------------+----------------+----------------------------------------------------+ - | z0 | ``0.75`` | flattening z0 parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | z1 | ``0.85`` | flattening z1 parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | delta | ``0.33`` | flattening delta parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | cvisc | ``0.1`` | artificial viscosity coefficient | - +----------------------------------+----------------+----------------------------------------------------+ - | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | - +----------------------------------+----------------+----------------------------------------------------+ - | grav | ``0.0`` | gravitational acceleration (in y-direction) | - +----------------------------------+----------------+----------------------------------------------------+ - | riemann | ``HLLC`` | HLLC or CGF | - +----------------------------------+----------------+----------------------------------------------------+ - -* section: [driver] - - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | | - +----------------------------------+----------------+----------------------------------------------------+ - -* section: [eos] - - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | gamma | ``1.4`` | pres = rho ener (gamma - 1) | - +----------------------------------+----------------+----------------------------------------------------+ - -* section: [particles] - - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | do_particles | ``0`` | | - +----------------------------------+----------------+----------------------------------------------------+ - | particle_generator | ``grid`` | | - +----------------------------------+----------------+----------------------------------------------------+ +* section: ``[compressible]`` + + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | use_flattening | ``1`` | apply flattening at shocks (1) | + +----------------------------------+------------------+----------------------------------------------------+ + | z0 | ``0.75`` | flattening z0 parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | z1 | ``0.85`` | flattening z1 parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | delta | ``0.33`` | flattening delta parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | cvisc | ``0.1`` | artificial viscosity coefficient | + +----------------------------------+------------------+----------------------------------------------------+ + | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | + +----------------------------------+------------------+----------------------------------------------------+ + | grav | ``0.0`` | gravitational acceleration (in y-direction) | + +----------------------------------+------------------+----------------------------------------------------+ + | riemann | ``HLLC`` | HLLC or CGF | + +----------------------------------+------------------+----------------------------------------------------+ + +* section: ``[driver]`` + + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | | + +----------------------------------+------------------+----------------------------------------------------+ + +* section: ``[eos]`` + + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | gamma | ``1.4`` | pres = rho ener (gamma - 1) | + +----------------------------------+------------------+----------------------------------------------------+ + +* section: ``[particles]`` + + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | do_particles | ``0`` | | + +----------------------------------+------------------+----------------------------------------------------+ + | particle_generator | ``grid`` | | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/compressible_fv4_defaults.inc b/docs/source/compressible_fv4_defaults.inc index 2efdd05c7..7e02623d8 100644 --- a/docs/source/compressible_fv4_defaults.inc +++ b/docs/source/compressible_fv4_defaults.inc @@ -1,38 +1,40 @@ -* section: [compressible] +* section: ``[compressible]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | use_flattening | ``1`` | apply flattening at shocks (1) | - +----------------------------------+----------------+----------------------------------------------------+ - | z0 | ``0.75`` | flattening z0 parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | z1 | ``0.85`` | flattening z1 parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | delta | ``0.33`` | flattening delta parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | cvisc | ``0.1`` | artificial viscosity coefficient | - +----------------------------------+----------------+----------------------------------------------------+ - | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | - +----------------------------------+----------------+----------------------------------------------------+ - | temporal_method | ``RK4`` | integration method (see mesh/integration.py) | - +----------------------------------+----------------+----------------------------------------------------+ - | grav | ``0.0`` | gravitational acceleration (in y-direction) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | use_flattening | ``1`` | apply flattening at shocks (1) | + +----------------------------------+------------------+----------------------------------------------------+ + | z0 | ``0.75`` | flattening z0 parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | z1 | ``0.85`` | flattening z1 parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | delta | ``0.33`` | flattening delta parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | cvisc | ``0.1`` | artificial viscosity coefficient | + +----------------------------------+------------------+----------------------------------------------------+ + | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | + +----------------------------------+------------------+----------------------------------------------------+ + | temporal_method | ``RK4`` | integration method (see mesh/integration.py) | + +----------------------------------+------------------+----------------------------------------------------+ + | grav | ``0.0`` | gravitational acceleration (in y-direction) | + +----------------------------------+------------------+----------------------------------------------------+ + | riemann | ``CGF`` | | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [eos] +* section: ``[eos]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | gamma | ``1.4`` | pres = rho ener (gamma - 1) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | gamma | ``1.4`` | pres = rho ener (gamma - 1) | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/compressible_react_defaults.inc b/docs/source/compressible_react_defaults.inc index 0f5d92c55..7944192e6 100644 --- a/docs/source/compressible_react_defaults.inc +++ b/docs/source/compressible_react_defaults.inc @@ -1,40 +1,40 @@ -* section: [compressible] +* section: ``[compressible]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | use_flattening | ``1`` | apply flattening at shocks (1) | - +----------------------------------+----------------+----------------------------------------------------+ - | z0 | ``0.75`` | flattening z0 parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | z1 | ``0.85`` | flattening z1 parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | delta | ``0.33`` | flattening delta parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | cvisc | ``0.1`` | artificial viscosity coefficient | - +----------------------------------+----------------+----------------------------------------------------+ - | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | - +----------------------------------+----------------+----------------------------------------------------+ - | temporal_method | ``RK4`` | integration method (see mesh/integration.py) | - +----------------------------------+----------------+----------------------------------------------------+ - | grav | ``0.0`` | gravitational acceleration (in y-direction) | - +----------------------------------+----------------+----------------------------------------------------+ - | riemann | ``HLLC`` | HLLC or CGF | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | use_flattening | ``1`` | apply flattening at shocks (1) | + +----------------------------------+------------------+----------------------------------------------------+ + | z0 | ``0.75`` | flattening z0 parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | z1 | ``0.85`` | flattening z1 parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | delta | ``0.33`` | flattening delta parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | cvisc | ``0.1`` | artificial viscosity coefficient | + +----------------------------------+------------------+----------------------------------------------------+ + | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | + +----------------------------------+------------------+----------------------------------------------------+ + | temporal_method | ``RK4`` | integration method (see mesh/integration.py) | + +----------------------------------+------------------+----------------------------------------------------+ + | grav | ``0.0`` | gravitational acceleration (in y-direction) | + +----------------------------------+------------------+----------------------------------------------------+ + | riemann | ``HLLC`` | HLLC or CGF | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [eos] +* section: ``[eos]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | gamma | ``1.4`` | pres = rho ener (gamma - 1) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | gamma | ``1.4`` | pres = rho ener (gamma - 1) | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/compressible_rk_defaults.inc b/docs/source/compressible_rk_defaults.inc index 572c01fa3..63f1a1c56 100644 --- a/docs/source/compressible_rk_defaults.inc +++ b/docs/source/compressible_rk_defaults.inc @@ -1,43 +1,43 @@ -* section: [compressible] +* section: ``[compressible]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | use_flattening | ``1`` | apply flattening at shocks (1) | - +----------------------------------+----------------+----------------------------------------------------+ - | z0 | ``0.75`` | flattening z0 parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | z1 | ``0.85`` | flattening z1 parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | delta | ``0.33`` | flattening delta parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | cvisc | ``0.1`` | artificial viscosity coefficient | - +----------------------------------+----------------+----------------------------------------------------+ - | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | - +----------------------------------+----------------+----------------------------------------------------+ - | temporal_method | ``RK4`` | integration method (see mesh/integration.py) | - +----------------------------------+----------------+----------------------------------------------------+ - | grav | ``0.0`` | gravitational acceleration (in y-direction) | - +----------------------------------+----------------+----------------------------------------------------+ - | riemann | ``HLLC`` | HLLC or CGF | - +----------------------------------+----------------+----------------------------------------------------+ - | well_balanced | ``0`` | use a well-balanced scheme to keep the model in | - | | | hydrostatic equilibrium | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | use_flattening | ``1`` | apply flattening at shocks (1) | + +----------------------------------+------------------+----------------------------------------------------+ + | z0 | ``0.75`` | flattening z0 parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | z1 | ``0.85`` | flattening z1 parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | delta | ``0.33`` | flattening delta parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | cvisc | ``0.1`` | artificial viscosity coefficient | + +----------------------------------+------------------+----------------------------------------------------+ + | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | + +----------------------------------+------------------+----------------------------------------------------+ + | temporal_method | ``RK4`` | integration method (see mesh/integration.py) | + +----------------------------------+------------------+----------------------------------------------------+ + | grav | ``0.0`` | gravitational acceleration (in y-direction) | + +----------------------------------+------------------+----------------------------------------------------+ + | riemann | ``HLLC`` | HLLC or CGF | + +----------------------------------+------------------+----------------------------------------------------+ + | well_balanced | ``0`` | use a well-balanced scheme to keep the model in | + | | | hydrostatic equilibrium | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [eos] +* section: ``[eos]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | gamma | ``1.4`` | pres = rho ener (gamma - 1) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | gamma | ``1.4`` | pres = rho ener (gamma - 1) | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/compressible_sdc_defaults.inc b/docs/source/compressible_sdc_defaults.inc index 2efdd05c7..7e02623d8 100644 --- a/docs/source/compressible_sdc_defaults.inc +++ b/docs/source/compressible_sdc_defaults.inc @@ -1,38 +1,40 @@ -* section: [compressible] +* section: ``[compressible]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | use_flattening | ``1`` | apply flattening at shocks (1) | - +----------------------------------+----------------+----------------------------------------------------+ - | z0 | ``0.75`` | flattening z0 parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | z1 | ``0.85`` | flattening z1 parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | delta | ``0.33`` | flattening delta parameter | - +----------------------------------+----------------+----------------------------------------------------+ - | cvisc | ``0.1`` | artificial viscosity coefficient | - +----------------------------------+----------------+----------------------------------------------------+ - | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | - +----------------------------------+----------------+----------------------------------------------------+ - | temporal_method | ``RK4`` | integration method (see mesh/integration.py) | - +----------------------------------+----------------+----------------------------------------------------+ - | grav | ``0.0`` | gravitational acceleration (in y-direction) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | use_flattening | ``1`` | apply flattening at shocks (1) | + +----------------------------------+------------------+----------------------------------------------------+ + | z0 | ``0.75`` | flattening z0 parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | z1 | ``0.85`` | flattening z1 parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | delta | ``0.33`` | flattening delta parameter | + +----------------------------------+------------------+----------------------------------------------------+ + | cvisc | ``0.1`` | artificial viscosity coefficient | + +----------------------------------+------------------+----------------------------------------------------+ + | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | + +----------------------------------+------------------+----------------------------------------------------+ + | temporal_method | ``RK4`` | integration method (see mesh/integration.py) | + +----------------------------------+------------------+----------------------------------------------------+ + | grav | ``0.0`` | gravitational acceleration (in y-direction) | + +----------------------------------+------------------+----------------------------------------------------+ + | riemann | ``CGF`` | | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [eos] +* section: ``[eos]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | gamma | ``1.4`` | pres = rho ener (gamma - 1) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | gamma | ``1.4`` | pres = rho ener (gamma - 1) | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/diffusion_defaults.inc b/docs/source/diffusion_defaults.inc index deb0b256c..baf3e5115 100644 --- a/docs/source/diffusion_defaults.inc +++ b/docs/source/diffusion_defaults.inc @@ -1,16 +1,16 @@ -* section: [diffusion] +* section: ``[diffusion]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | k | ``1.0`` | conductivity | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | k | ``1.0`` | conductivity | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | diffusion CFL number | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | diffusion CFL number | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/incompressible_defaults.inc b/docs/source/incompressible_defaults.inc index 13b196527..bccf05d1d 100644 --- a/docs/source/incompressible_defaults.inc +++ b/docs/source/incompressible_defaults.inc @@ -1,28 +1,28 @@ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [incompressible] +* section: ``[incompressible]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | - +----------------------------------+----------------+----------------------------------------------------+ - | proj_type | ``2`` | what are we projecting? 1 includes -Gp term in U* | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | + +----------------------------------+------------------+----------------------------------------------------+ + | proj_type | ``2`` | what are we projecting? 1 includes -Gp term in U* | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [particles] +* section: ``[particles]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | do_particles | ``0`` | | - +----------------------------------+----------------+----------------------------------------------------+ - | particle_generator | ``grid`` | | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | do_particles | ``0`` | | + +----------------------------------+------------------+----------------------------------------------------+ + | particle_generator | ``grid`` | | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/incompressible_viscous_defaults.inc b/docs/source/incompressible_viscous_defaults.inc index d0ed65d04..f2851ffa6 100644 --- a/docs/source/incompressible_viscous_defaults.inc +++ b/docs/source/incompressible_viscous_defaults.inc @@ -1,36 +1,36 @@ -* section: [driver] - - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | | - +----------------------------------+----------------+----------------------------------------------------+ - -* section: [incompressible] - - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | - +----------------------------------+----------------+----------------------------------------------------+ - | proj_type | ``2`` | what are we projecting? 1 includes -Gp term in U* | - +----------------------------------+----------------+----------------------------------------------------+ - -* section: [incompressible_viscous] - - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | viscosity | ``0.1`` | kinematic viscosity of the fluid (units L^2/T) | - +----------------------------------+----------------+----------------------------------------------------+ - -* section: [particles] - - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | do_particles | ``0`` | | - +----------------------------------+----------------+----------------------------------------------------+ - | particle_generator | ``grid`` | | - +----------------------------------+----------------+----------------------------------------------------+ +* section: ``[driver]`` + + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | | + +----------------------------------+------------------+----------------------------------------------------+ + +* section: ``[incompressible]`` + + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | + +----------------------------------+------------------+----------------------------------------------------+ + | proj_type | ``2`` | what are we projecting? 1 includes -Gp term in U* | + +----------------------------------+------------------+----------------------------------------------------+ + +* section: ``[incompressible_viscous]`` + + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | viscosity | ``0.1`` | kinematic viscosity of the fluid (units L^2/T) | + +----------------------------------+------------------+----------------------------------------------------+ + +* section: ``[particles]`` + + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | do_particles | ``0`` | | + +----------------------------------+------------------+----------------------------------------------------+ + | particle_generator | ``grid`` | | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/lm_atm_defaults.inc b/docs/source/lm_atm_defaults.inc index da1065b03..2b57c4dc2 100644 --- a/docs/source/lm_atm_defaults.inc +++ b/docs/source/lm_atm_defaults.inc @@ -1,28 +1,28 @@ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [eos] +* section: ``[eos]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | gamma | ``1.4`` | pres = rho ener (gamma - 1) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | gamma | ``1.4`` | pres = rho ener (gamma - 1) | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [lm-atmosphere] +* section: ``[lm-atmosphere]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | - +----------------------------------+----------------+----------------------------------------------------+ - | proj_type | ``2`` | what are we projecting? 1 includes -Gp term in U* | - +----------------------------------+----------------+----------------------------------------------------+ - | grav | ``-2.0`` | | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | + +----------------------------------+------------------+----------------------------------------------------+ + | proj_type | ``2`` | what are we projecting? 1 includes -Gp term in U* | + +----------------------------------+------------------+----------------------------------------------------+ + | grav | ``-2.0`` | | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/swe_defaults.inc b/docs/source/swe_defaults.inc index 5d85299c0..10a12137a 100644 --- a/docs/source/swe_defaults.inc +++ b/docs/source/swe_defaults.inc @@ -1,34 +1,34 @@ -* section: [driver] +* section: ``[driver]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [particles] +* section: ``[particles]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | do_particles | ``0`` | | - +----------------------------------+----------------+----------------------------------------------------+ - | particle_generator | ``grid`` | | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | do_particles | ``0`` | | + +----------------------------------+------------------+----------------------------------------------------+ + | particle_generator | ``grid`` | | + +----------------------------------+------------------+----------------------------------------------------+ -* section: [swe] +* section: ``[swe]`` - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | use_flattening | ``0`` | apply flattening at shocks (1) | - +----------------------------------+----------------+----------------------------------------------------+ - | cvisc | ``0.1`` | artificial viscosity coefficient | - +----------------------------------+----------------+----------------------------------------------------+ - | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | - +----------------------------------+----------------+----------------------------------------------------+ - | grav | ``1.0`` | gravitational acceleration (in y-direction) | - +----------------------------------+----------------+----------------------------------------------------+ - | riemann | ``Roe`` | HLLC or Roe | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | use_flattening | ``0`` | apply flattening at shocks (1) | + +----------------------------------+------------------+----------------------------------------------------+ + | cvisc | ``0.1`` | artificial viscosity coefficient | + +----------------------------------+------------------+----------------------------------------------------+ + | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | + +----------------------------------+------------------+----------------------------------------------------+ + | grav | ``1.0`` | gravitational acceleration (in y-direction) | + +----------------------------------+------------------+----------------------------------------------------+ + | riemann | ``Roe`` | HLLC or Roe | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/docs/source/viscous_burgers_defaults.inc b/docs/source/viscous_burgers_defaults.inc index 6308266a3..ec2190f02 100644 --- a/docs/source/viscous_burgers_defaults.inc +++ b/docs/source/viscous_burgers_defaults.inc @@ -1,34 +1,34 @@ * section: [advection] - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | + +----------------------------------+------------------+----------------------------------------------------+ * section: [diffusion] - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | eps | ``0.005`` | Viscosity for diffusion | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | eps | ``0.005`` | Viscosity for diffusion | + +----------------------------------+------------------+----------------------------------------------------+ * section: [driver] - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | cfl | ``0.8`` | advective CFL number | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | cfl | ``0.8`` | advective CFL number | + +----------------------------------+------------------+----------------------------------------------------+ * section: [particles] - +----------------------------------+----------------+----------------------------------------------------+ - | option | value | description | - +==================================+================+====================================================+ - | do_particles | ``0`` | | - +----------------------------------+----------------+----------------------------------------------------+ - | particle_generator | ``grid`` | | - +----------------------------------+----------------+----------------------------------------------------+ + +----------------------------------+------------------+----------------------------------------------------+ + | option | value | description | + +==================================+==================+====================================================+ + | do_particles | ``0`` | | + +----------------------------------+------------------+----------------------------------------------------+ + | particle_generator | ``grid`` | | + +----------------------------------+------------------+----------------------------------------------------+ diff --git a/pyro/util/runparams.py b/pyro/util/runparams.py index 4f69a3617..53023d693 100644 --- a/pyro/util/runparams.py +++ b/pyro/util/runparams.py @@ -289,14 +289,14 @@ def print_sphinx_tables(self, outfile="params-sphinx.inc"): # find all the sections secs = {q for (q, _) in [k.split(".") for k in all_keys]} - heading = " +=" + 32*"=" + "=+=" + 14*"=" + "=+=" + 50*"=" + "=+" + "\n" - separator = " +-" + 32*"-" + "-+-" + 14*"-" + "-+-" + 50*"-" + "-+" + "\n" - entry = " | {:32} | {:14} | {:50} |\n" + heading = " +=" + 32*"=" + "=+=" + 16*"=" + "=+=" + 50*"=" + "=+" + "\n" + separator = " +-" + 32*"-" + "-+-" + 16*"-" + "-+-" + 50*"-" + "-+" + "\n" + entry = " | {:32} | {:16} | {:50} |\n" for sec in sorted(secs): keys = [q for q in all_keys if q.startswith(f"{sec}.")] - head = f"* section: [{sec.strip()}]" + head = f"* section: ``[{sec.strip()}]``" f.write(f"{head}\n\n") #f.write(len(head)*"^"+"\n\n")