Skip to content

Commit 075ce40

Browse files
zingalezingale
authored
render the parameter names in code font (#271)
1 parent e4cb631 commit 075ce40

18 files changed

Lines changed: 445 additions & 445 deletions

‎docs/source/_defaults.inc‎

Lines changed: 71 additions & 71 deletions
Large diffs are not rendered by default.

‎docs/source/advection_defaults.inc‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
* section: ``[advection]``
22

3-
+----------------------------------+------------------+----------------------------------------------------+
4-
| option | value | description |
5-
+==================================+==================+====================================================+
6-
| u | ``1.0`` | advective velocity in x-direction |
7-
+----------------------------------+------------------+----------------------------------------------------+
8-
| v | ``1.0`` | advective velocity in y-direction |
9-
+----------------------------------+------------------+----------------------------------------------------+
10-
| limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) |
11-
+----------------------------------+------------------+----------------------------------------------------+
3+
+--------------------------------------+------------------+----------------------------------------------------+
4+
| option | value | description |
5+
+======================================+==================+====================================================+
6+
| ``u`` | ``1.0`` | advective velocity in x-direction |
7+
+--------------------------------------+------------------+----------------------------------------------------+
8+
| ``v`` | ``1.0`` | advective velocity in y-direction |
9+
+--------------------------------------+------------------+----------------------------------------------------+
10+
| ``limiter`` | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) |
11+
+--------------------------------------+------------------+----------------------------------------------------+
1212

1313
* section: ``[driver]``
1414

15-
+----------------------------------+------------------+----------------------------------------------------+
16-
| option | value | description |
17-
+==================================+==================+====================================================+
18-
| cfl | ``0.8`` | advective CFL number |
19-
+----------------------------------+------------------+----------------------------------------------------+
15+
+--------------------------------------+------------------+----------------------------------------------------+
16+
| option | value | description |
17+
+======================================+==================+====================================================+
18+
| ``cfl`` | ``0.8`` | advective CFL number |
19+
+--------------------------------------+------------------+----------------------------------------------------+
2020

2121
* section: ``[particles]``
2222

23-
+----------------------------------+------------------+----------------------------------------------------+
24-
| option | value | description |
25-
+==================================+==================+====================================================+
26-
| do_particles | ``0`` | |
27-
+----------------------------------+------------------+----------------------------------------------------+
28-
| particle_generator | ``grid`` | |
29-
+----------------------------------+------------------+----------------------------------------------------+
23+
+--------------------------------------+------------------+----------------------------------------------------+
24+
| option | value | description |
25+
+======================================+==================+====================================================+
26+
| ``do_particles`` | ``0`` | |
27+
+--------------------------------------+------------------+----------------------------------------------------+
28+
| ``particle_generator`` | ``grid`` | |
29+
+--------------------------------------+------------------+----------------------------------------------------+
3030

‎docs/source/advection_fv4_defaults.inc‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
* section: ``[advection]``
22

3-
+----------------------------------+------------------+----------------------------------------------------+
4-
| option | value | description |
5-
+==================================+==================+====================================================+
6-
| u | ``1.0`` | advective velocity in x-direction |
7-
+----------------------------------+------------------+----------------------------------------------------+
8-
| v | ``1.0`` | advective velocity in y-direction |
9-
+----------------------------------+------------------+----------------------------------------------------+
10-
| limiter | ``1`` | limiter (0 = none, 1 = ppm) |
11-
+----------------------------------+------------------+----------------------------------------------------+
12-
| temporal_method | ``RK4`` | integration method (see mesh/integrators.py) |
13-
+----------------------------------+------------------+----------------------------------------------------+
3+
+--------------------------------------+------------------+----------------------------------------------------+
4+
| option | value | description |
5+
+======================================+==================+====================================================+
6+
| ``u`` | ``1.0`` | advective velocity in x-direction |
7+
+--------------------------------------+------------------+----------------------------------------------------+
8+
| ``v`` | ``1.0`` | advective velocity in y-direction |
9+
+--------------------------------------+------------------+----------------------------------------------------+
10+
| ``limiter`` | ``1`` | limiter (0 = none, 1 = ppm) |
11+
+--------------------------------------+------------------+----------------------------------------------------+
12+
| ``temporal_method`` | ``RK4`` | integration method (see mesh/integrators.py) |
13+
+--------------------------------------+------------------+----------------------------------------------------+
1414

1515
* section: ``[driver]``
1616

17-
+----------------------------------+------------------+----------------------------------------------------+
18-
| option | value | description |
19-
+==================================+==================+====================================================+
20-
| cfl | ``0.8`` | advective CFL number |
21-
+----------------------------------+------------------+----------------------------------------------------+
17+
+--------------------------------------+------------------+----------------------------------------------------+
18+
| option | value | description |
19+
+======================================+==================+====================================================+
20+
| ``cfl`` | ``0.8`` | advective CFL number |
21+
+--------------------------------------+------------------+----------------------------------------------------+
2222

‎docs/source/advection_nonuniform_defaults.inc‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
* section: ``[advection]``
22

3-
+----------------------------------+------------------+----------------------------------------------------+
4-
| option | value | description |
5-
+==================================+==================+====================================================+
6-
| u | ``1.0`` | advective velocity in x-direction |
7-
+----------------------------------+------------------+----------------------------------------------------+
8-
| v | ``1.0`` | advective velocity in y-direction |
9-
+----------------------------------+------------------+----------------------------------------------------+
10-
| limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) |
11-
+----------------------------------+------------------+----------------------------------------------------+
3+
+--------------------------------------+------------------+----------------------------------------------------+
4+
| option | value | description |
5+
+======================================+==================+====================================================+
6+
| ``u`` | ``1.0`` | advective velocity in x-direction |
7+
+--------------------------------------+------------------+----------------------------------------------------+
8+
| ``v`` | ``1.0`` | advective velocity in y-direction |
9+
+--------------------------------------+------------------+----------------------------------------------------+
10+
| ``limiter`` | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) |
11+
+--------------------------------------+------------------+----------------------------------------------------+
1212

1313
* section: ``[driver]``
1414

15-
+----------------------------------+------------------+----------------------------------------------------+
16-
| option | value | description |
17-
+==================================+==================+====================================================+
18-
| cfl | ``0.8`` | advective CFL number |
19-
+----------------------------------+------------------+----------------------------------------------------+
15+
+--------------------------------------+------------------+----------------------------------------------------+
16+
| option | value | description |
17+
+======================================+==================+====================================================+
18+
| ``cfl`` | ``0.8`` | advective CFL number |
19+
+--------------------------------------+------------------+----------------------------------------------------+
2020

2121
* section: ``[particles]``
2222

23-
+----------------------------------+------------------+----------------------------------------------------+
24-
| option | value | description |
25-
+==================================+==================+====================================================+
26-
| do_particles | ``0`` | |
27-
+----------------------------------+------------------+----------------------------------------------------+
28-
| particle_generator | ``grid`` | |
29-
+----------------------------------+------------------+----------------------------------------------------+
23+
+--------------------------------------+------------------+----------------------------------------------------+
24+
| option | value | description |
25+
+======================================+==================+====================================================+
26+
| ``do_particles`` | ``0`` | |
27+
+--------------------------------------+------------------+----------------------------------------------------+
28+
| ``particle_generator`` | ``grid`` | |
29+
+--------------------------------------+------------------+----------------------------------------------------+
3030

‎docs/source/advection_rk_defaults.inc‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
* section: ``[advection]``
22

3-
+----------------------------------+------------------+----------------------------------------------------+
4-
| option | value | description |
5-
+==================================+==================+====================================================+
6-
| u | ``1.0`` | advective velocity in x-direction |
7-
+----------------------------------+------------------+----------------------------------------------------+
8-
| v | ``1.0`` | advective velocity in y-direction |
9-
+----------------------------------+------------------+----------------------------------------------------+
10-
| limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) |
11-
+----------------------------------+------------------+----------------------------------------------------+
12-
| temporal_method | ``RK4`` | integration method (see mesh/integrators.py) |
13-
+----------------------------------+------------------+----------------------------------------------------+
3+
+--------------------------------------+------------------+----------------------------------------------------+
4+
| option | value | description |
5+
+======================================+==================+====================================================+
6+
| ``u`` | ``1.0`` | advective velocity in x-direction |
7+
+--------------------------------------+------------------+----------------------------------------------------+
8+
| ``v`` | ``1.0`` | advective velocity in y-direction |
9+
+--------------------------------------+------------------+----------------------------------------------------+
10+
| ``limiter`` | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) |
11+
+--------------------------------------+------------------+----------------------------------------------------+
12+
| ``temporal_method`` | ``RK4`` | integration method (see mesh/integrators.py) |
13+
+--------------------------------------+------------------+----------------------------------------------------+
1414

1515
* section: ``[driver]``
1616

17-
+----------------------------------+------------------+----------------------------------------------------+
18-
| option | value | description |
19-
+==================================+==================+====================================================+
20-
| cfl | ``0.8`` | advective CFL number |
21-
+----------------------------------+------------------+----------------------------------------------------+
17+
+--------------------------------------+------------------+----------------------------------------------------+
18+
| option | value | description |
19+
+======================================+==================+====================================================+
20+
| ``cfl`` | ``0.8`` | advective CFL number |
21+
+--------------------------------------+------------------+----------------------------------------------------+
2222

0 commit comments

Comments
 (0)