Skip to content

Commit 60b01b8

Browse files
zingalezingale
committed
script to write sphinx tables of parameters
1 parent 2af36d8 commit 60b01b8

15 files changed

Lines changed: 461 additions & 0 deletions

‎docs/source/advection._defaults.inc‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
**advection**
3+
4+
+----------------------------------+------------+----------------------------------------------------+
5+
| option | value | description |
6+
+==================================+============+====================================================+
7+
| u | 1.0 | advective velocity in x-direction |
8+
+----------------------------------+------------+----------------------------------------------------+
9+
| v | 1.0 | advective velocity in y-direction |
10+
+----------------------------------+------------+----------------------------------------------------+
11+
| limiter | 2 | limiter (0 = none, 1 = 2nd order, 2 = 4th order) |
12+
+----------------------------------+------------+----------------------------------------------------+
13+
14+
**driver**
15+
16+
+----------------------------------+------------+----------------------------------------------------+
17+
| option | value | description |
18+
+==================================+============+====================================================+
19+
| cfl | 0.8 | advective CFL number |
20+
+----------------------------------+------------+----------------------------------------------------+
21+
22+
**particles**
23+
24+
+----------------------------------+------------+----------------------------------------------------+
25+
| option | value | description |
26+
+==================================+============+====================================================+
27+
| do_particles | 0 | |
28+
+----------------------------------+------------+----------------------------------------------------+
29+
| particle_generator | grid | |
30+
+----------------------------------+------------+----------------------------------------------------+

‎docs/source/advection_fv4._defaults.inc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
**advection**
3+
4+
+----------------------------------+------------+----------------------------------------------------+
5+
| option | value | description |
6+
+==================================+============+====================================================+
7+
| u | 1.0 | advective velocity in x-direction |
8+
+----------------------------------+------------+----------------------------------------------------+
9+
| v | 1.0 | advective velocity in y-direction |
10+
+----------------------------------+------------+----------------------------------------------------+
11+
| limiter | 1 | limiter (0 = none, 1 = ppm) |
12+
+----------------------------------+------------+----------------------------------------------------+
13+
| temporal_method | RK4 | integration method (see mesh/integrators/.py) |
14+
+----------------------------------+------------+----------------------------------------------------+
15+
16+
**driver**
17+
18+
+----------------------------------+------------+----------------------------------------------------+
19+
| option | value | description |
20+
+==================================+============+====================================================+
21+
| cfl | 0.8 | advective CFL number |
22+
+----------------------------------+------------+----------------------------------------------------+

‎docs/source/advection_nonuniform._defaults.inc‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
**advection**
3+
4+
+----------------------------------+------------+----------------------------------------------------+
5+
| option | value | description |
6+
+==================================+============+====================================================+
7+
| u | 1.0 | advective velocity in x-direction |
8+
+----------------------------------+------------+----------------------------------------------------+
9+
| v | 1.0 | advective velocity in y-direction |
10+
+----------------------------------+------------+----------------------------------------------------+
11+
| limiter | 2 | limiter (0 = none, 1 = 2nd order, 2 = 4th order) |
12+
+----------------------------------+------------+----------------------------------------------------+
13+
14+
**driver**
15+
16+
+----------------------------------+------------+----------------------------------------------------+
17+
| option | value | description |
18+
+==================================+============+====================================================+
19+
| cfl | 0.8 | advective CFL number |
20+
+----------------------------------+------------+----------------------------------------------------+
21+
22+
**particles**
23+
24+
+----------------------------------+------------+----------------------------------------------------+
25+
| option | value | description |
26+
+==================================+============+====================================================+
27+
| do_particles | 0 | |
28+
+----------------------------------+------------+----------------------------------------------------+
29+
| particle_generator | grid | |
30+
+----------------------------------+------------+----------------------------------------------------+

‎docs/source/advection_rk._defaults.inc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
**advection**
3+
4+
+----------------------------------+------------+----------------------------------------------------+
5+
| option | value | description |
6+
+==================================+============+====================================================+
7+
| u | 1.0 | advective velocity in x-direction |
8+
+----------------------------------+------------+----------------------------------------------------+
9+
| v | 1.0 | advective velocity in y-direction |
10+
+----------------------------------+------------+----------------------------------------------------+
11+
| limiter | 2 | limiter (0 = none, 1 = 2nd order, 2 = 4th order) |
12+
+----------------------------------+------------+----------------------------------------------------+
13+
| temporal_method | RK4 | integration method (see mesh/integrators/.py) |
14+
+----------------------------------+------------+----------------------------------------------------+
15+
16+
**driver**
17+
18+
+----------------------------------+------------+----------------------------------------------------+
19+
| option | value | description |
20+
+==================================+============+====================================================+
21+
| cfl | 0.8 | advective CFL number |
22+
+----------------------------------+------------+----------------------------------------------------+

‎docs/source/advection_weno._defaults.inc‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
**advection**
3+
4+
+----------------------------------+------------+----------------------------------------------------+
5+
| option | value | description |
6+
+==================================+============+====================================================+
7+
| u | 1.0 | advective velocity in x-direction |
8+
+----------------------------------+------------+----------------------------------------------------+
9+
| v | 1.0 | advective velocity in y-direction |
10+
+----------------------------------+------------+----------------------------------------------------+
11+
| limiter | 0 | Unused here, but needed to inherit from advection base class |
12+
+----------------------------------+------------+----------------------------------------------------+
13+
| weno_order | 3 | k in WENO scheme |
14+
+----------------------------------+------------+----------------------------------------------------+
15+
| temporal_method | RK4 | integration method (see mesh/integrators/.py) |
16+
+----------------------------------+------------+----------------------------------------------------+
17+
18+
**driver**
19+
20+
+----------------------------------+------------+----------------------------------------------------+
21+
| option | value | description |
22+
+==================================+============+====================================================+
23+
| cfl | 0.5 | advective CFL number |
24+
+----------------------------------+------------+----------------------------------------------------+

‎docs/source/compressible._defaults.inc‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
2+
**compressible**
3+
4+
+----------------------------------+------------+----------------------------------------------------+
5+
| option | value | description |
6+
+==================================+============+====================================================+
7+
| use_flattening | 1 | apply flattening at shocks (1) |
8+
+----------------------------------+------------+----------------------------------------------------+
9+
| z0 | 0.75 | flattening z0 parameter |
10+
+----------------------------------+------------+----------------------------------------------------+
11+
| z1 | 0.85 | flattening z1 parameter |
12+
+----------------------------------+------------+----------------------------------------------------+
13+
| delta | 0.33 | flattening delta parameter |
14+
+----------------------------------+------------+----------------------------------------------------+
15+
| cvisc | 0.1 | artifical viscosity coefficient |
16+
+----------------------------------+------------+----------------------------------------------------+
17+
| limiter | 2 | limiter (0 = none, 1 = 2nd order, 2 = 4th order) |
18+
+----------------------------------+------------+----------------------------------------------------+
19+
| grav | 0.0 | gravitational acceleration (in y-direction) |
20+
+----------------------------------+------------+----------------------------------------------------+
21+
| riemann | HLLC | HLLC or CGF |
22+
+----------------------------------+------------+----------------------------------------------------+
23+
24+
**driver**
25+
26+
+----------------------------------+------------+----------------------------------------------------+
27+
| option | value | description |
28+
+==================================+============+====================================================+
29+
| cfl | 0.8 | |
30+
+----------------------------------+------------+----------------------------------------------------+
31+
32+
**eos**
33+
34+
+----------------------------------+------------+----------------------------------------------------+
35+
| option | value | description |
36+
+==================================+============+====================================================+
37+
| gamma | 1.4 | pres = rho ener (gamma - 1) |
38+
+----------------------------------+------------+----------------------------------------------------+
39+
40+
**particles**
41+
42+
+----------------------------------+------------+----------------------------------------------------+
43+
| option | value | description |
44+
+==================================+============+====================================================+
45+
| do_particles | 0 | |
46+
+----------------------------------+------------+----------------------------------------------------+
47+
| particle_generator | grid | |
48+
+----------------------------------+------------+----------------------------------------------------+

‎docs/source/compressible_fv4._defaults.inc‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
2+
**compressible**
3+
4+
+----------------------------------+------------+----------------------------------------------------+
5+
| option | value | description |
6+
+==================================+============+====================================================+
7+
| use_flattening | 1 | apply flattening at shocks (1) |
8+
+----------------------------------+------------+----------------------------------------------------+
9+
| z0 | 0.75 | flattening z0 parameter |
10+
+----------------------------------+------------+----------------------------------------------------+
11+
| z1 | 0.85 | flattening z1 parameter |
12+
+----------------------------------+------------+----------------------------------------------------+
13+
| delta | 0.33 | flattening delta parameter |
14+
+----------------------------------+------------+----------------------------------------------------+
15+
| cvisc | 0.1 | artifical viscosity coefficient |
16+
+----------------------------------+------------+----------------------------------------------------+
17+
| limiter | 2 | limiter (0 = none, 1 = 2nd order, 2 = 4th order) |
18+
+----------------------------------+------------+----------------------------------------------------+
19+
| temporal_method | RK4 | integration method (see mesh/integration.py) |
20+
+----------------------------------+------------+----------------------------------------------------+
21+
| grav | 0.0 | gravitational acceleration (in y-direction) |
22+
+----------------------------------+------------+----------------------------------------------------+
23+
24+
**driver**
25+
26+
+----------------------------------+------------+----------------------------------------------------+
27+
| option | value | description |
28+
+==================================+============+====================================================+
29+
| cfl | 0.8 | |
30+
+----------------------------------+------------+----------------------------------------------------+
31+
32+
**eos**
33+
34+
+----------------------------------+------------+----------------------------------------------------+
35+
| option | value | description |
36+
+==================================+============+====================================================+
37+
| gamma | 1.4 | pres = rho ener (gamma - 1) |
38+
+----------------------------------+------------+----------------------------------------------------+

‎docs/source/compressible_react._defaults.inc‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
2+
**compressible**
3+
4+
+----------------------------------+------------+----------------------------------------------------+
5+
| option | value | description |
6+
+==================================+============+====================================================+
7+
| use_flattening | 1 | apply flattening at shocks (1) |
8+
+----------------------------------+------------+----------------------------------------------------+
9+
| z0 | 0.75 | flattening z0 parameter |
10+
+----------------------------------+------------+----------------------------------------------------+
11+
| z1 | 0.85 | flattening z1 parameter |
12+
+----------------------------------+------------+----------------------------------------------------+
13+
| delta | 0.33 | flattening delta parameter |
14+
+----------------------------------+------------+----------------------------------------------------+
15+
| cvisc | 0.1 | artifical viscosity coefficient |
16+
+----------------------------------+------------+----------------------------------------------------+
17+
| limiter | 2 | limiter (0 = none, 1 = 2nd order, 2 = 4th order) |
18+
+----------------------------------+------------+----------------------------------------------------+
19+
| temporal_method | RK4 | integration method (see mesh/integration.py) |
20+
+----------------------------------+------------+----------------------------------------------------+
21+
| grav | 0.0 | gravitational acceleration (in y-direction) |
22+
+----------------------------------+------------+----------------------------------------------------+
23+
| riemann | HLLC | HLLC or CGF |
24+
+----------------------------------+------------+----------------------------------------------------+
25+
26+
**driver**
27+
28+
+----------------------------------+------------+----------------------------------------------------+
29+
| option | value | description |
30+
+==================================+============+====================================================+
31+
| cfl | 0.8 | |
32+
+----------------------------------+------------+----------------------------------------------------+
33+
34+
**eos**
35+
36+
+----------------------------------+------------+----------------------------------------------------+
37+
| option | value | description |
38+
+==================================+============+====================================================+
39+
| gamma | 1.4 | pres = rho ener (gamma - 1) |
40+
+----------------------------------+------------+----------------------------------------------------+

0 commit comments

Comments
 (0)