Skip to content

Commit 2541fad

Browse files
zingalezingale
authored
regenerate the defaults for the docs (#268)
1 parent 8a731ce commit 2541fad

19 files changed

Lines changed: 532 additions & 522 deletions

‎docs/source/_defaults.inc‎

Lines changed: 76 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,86 @@
1-
* section: [driver]
1+
* section: ``[driver]``
22

3-
+----------------------------------+----------------+----------------------------------------------------+
4-
| option | value | description |
5-
+==================================+================+====================================================+
6-
| tmax | ``1.0`` | maximum simulation time to evolve |
7-
+----------------------------------+----------------+----------------------------------------------------+
8-
| max_steps | ``10000`` | maximum number of steps to take |
9-
+----------------------------------+----------------+----------------------------------------------------+
10-
| fix_dt | ``-1.0`` | |
11-
+----------------------------------+----------------+----------------------------------------------------+
12-
| init_tstep_factor | ``0.01`` | first timestep = init_tstep_factor * CFL timestep |
13-
+----------------------------------+----------------+----------------------------------------------------+
14-
| max_dt_change | ``2.0`` | max amount the timestep can change between steps |
15-
+----------------------------------+----------------+----------------------------------------------------+
16-
| verbose | ``1.0`` | verbosity |
17-
+----------------------------------+----------------+----------------------------------------------------+
3+
+----------------------------------+------------------+----------------------------------------------------+
4+
| option | value | description |
5+
+==================================+==================+====================================================+
6+
| tmax | ``1.0`` | maximum simulation time to evolve |
7+
+----------------------------------+------------------+----------------------------------------------------+
8+
| max_steps | ``10000`` | maximum number of steps to take |
9+
+----------------------------------+------------------+----------------------------------------------------+
10+
| fix_dt | ``-1.0`` | |
11+
+----------------------------------+------------------+----------------------------------------------------+
12+
| init_tstep_factor | ``0.01`` | first timestep = init_tstep_factor * CFL timestep |
13+
+----------------------------------+------------------+----------------------------------------------------+
14+
| max_dt_change | ``2.0`` | max amount the timestep can change between steps |
15+
+----------------------------------+------------------+----------------------------------------------------+
16+
| verbose | ``1.0`` | verbosity |
17+
+----------------------------------+------------------+----------------------------------------------------+
1818

19-
* section: [io]
19+
* section: ``[io]``
2020

21-
+----------------------------------+----------------+----------------------------------------------------+
22-
| option | value | description |
23-
+==================================+================+====================================================+
24-
| basename | ``pyro_`` | basename for output files |
25-
+----------------------------------+----------------+----------------------------------------------------+
26-
| dt_out | ``0.1`` | simulation time between writing output files |
27-
+----------------------------------+----------------+----------------------------------------------------+
28-
| n_out | ``10000`` | number of timesteps between writing output files |
29-
+----------------------------------+----------------+----------------------------------------------------+
30-
| do_io | ``1`` | do we output at all? |
31-
+----------------------------------+----------------+----------------------------------------------------+
21+
+----------------------------------+------------------+----------------------------------------------------+
22+
| option | value | description |
23+
+==================================+==================+====================================================+
24+
| basename | ``pyro_`` | basename for output files |
25+
+----------------------------------+------------------+----------------------------------------------------+
26+
| dt_out | ``0.1`` | simulation time between writing output files |
27+
+----------------------------------+------------------+----------------------------------------------------+
28+
| n_out | ``10000`` | number of timesteps between writing output files |
29+
+----------------------------------+------------------+----------------------------------------------------+
30+
| do_io | ``1`` | do we output at all? |
31+
+----------------------------------+------------------+----------------------------------------------------+
32+
| force_final_output | ``0`` | regardless of do_io, do we output when the |
33+
| | | simulation ends? |
34+
+----------------------------------+------------------+----------------------------------------------------+
3235

33-
* section: [mesh]
36+
* section: ``[mesh]``
3437

35-
+----------------------------------+----------------+----------------------------------------------------+
36-
| option | value | description |
37-
+==================================+================+====================================================+
38-
| xmin | ``0.0`` | domain minimum x-coordinate |
39-
+----------------------------------+----------------+----------------------------------------------------+
40-
| xmax | ``1.0`` | domain maximum x-coordinate |
41-
+----------------------------------+----------------+----------------------------------------------------+
42-
| ymin | ``0.0`` | domain minimum y-coordinate |
43-
+----------------------------------+----------------+----------------------------------------------------+
44-
| ymax | ``1.0`` | domain maximum y-coordinate |
45-
+----------------------------------+----------------+----------------------------------------------------+
46-
| xlboundary | ``reflect`` | minimum x BC ('reflect', 'outflow', or 'periodic') |
47-
+----------------------------------+----------------+----------------------------------------------------+
48-
| xrboundary | ``reflect`` | maximum x BC ('reflect', 'outflow', or 'periodic') |
49-
+----------------------------------+----------------+----------------------------------------------------+
50-
| ylboundary | ``reflect`` | minimum y BC ('reflect', 'outflow', or 'periodic') |
51-
+----------------------------------+----------------+----------------------------------------------------+
52-
| yrboundary | ``reflect`` | maximum y BC ('reflect', 'outflow', or 'periodic') |
53-
+----------------------------------+----------------+----------------------------------------------------+
54-
| nx | ``25`` | number of zones in the x-direction |
55-
+----------------------------------+----------------+----------------------------------------------------+
56-
| ny | ``25`` | number of zones in the y-direction |
57-
+----------------------------------+----------------+----------------------------------------------------+
38+
+----------------------------------+------------------+----------------------------------------------------+
39+
| option | value | description |
40+
+==================================+==================+====================================================+
41+
| grid_type | ``Cartesian2d`` | Geometry of the Grid ('Cartesian2d' or |
42+
| | | 'SphericalPolar') |
43+
+----------------------------------+------------------+----------------------------------------------------+
44+
| xmin | ``0.0`` | domain minimum x-coordinate |
45+
+----------------------------------+------------------+----------------------------------------------------+
46+
| xmax | ``1.0`` | domain maximum x-coordinate |
47+
+----------------------------------+------------------+----------------------------------------------------+
48+
| ymin | ``0.0`` | domain minimum y-coordinate |
49+
+----------------------------------+------------------+----------------------------------------------------+
50+
| ymax | ``1.0`` | domain maximum y-coordinate |
51+
+----------------------------------+------------------+----------------------------------------------------+
52+
| xlboundary | ``reflect`` | minimum x BC ('reflect', 'outflow', or 'periodic') |
53+
+----------------------------------+------------------+----------------------------------------------------+
54+
| xrboundary | ``reflect`` | maximum x BC ('reflect', 'outflow', or 'periodic') |
55+
+----------------------------------+------------------+----------------------------------------------------+
56+
| ylboundary | ``reflect`` | minimum y BC ('reflect', 'outflow', or 'periodic') |
57+
+----------------------------------+------------------+----------------------------------------------------+
58+
| yrboundary | ``reflect`` | maximum y BC ('reflect', 'outflow', or 'periodic') |
59+
+----------------------------------+------------------+----------------------------------------------------+
60+
| nx | ``25`` | number of zones in the x-direction |
61+
+----------------------------------+------------------+----------------------------------------------------+
62+
| ny | ``25`` | number of zones in the y-direction |
63+
+----------------------------------+------------------+----------------------------------------------------+
5864

59-
* section: [particles]
65+
* section: ``[particles]``
6066

61-
+----------------------------------+----------------+----------------------------------------------------+
62-
| option | value | description |
63-
+==================================+================+====================================================+
64-
| do_particles | ``0`` | include particles? (1=yes, 0=no) |
65-
+----------------------------------+----------------+----------------------------------------------------+
66-
| n_particles | ``100`` | number of particles |
67-
+----------------------------------+----------------+----------------------------------------------------+
68-
| particle_generator | ``random`` | how do we generate particles? (random, grid) |
69-
+----------------------------------+----------------+----------------------------------------------------+
67+
+----------------------------------+------------------+----------------------------------------------------+
68+
| option | value | description |
69+
+==================================+==================+====================================================+
70+
| do_particles | ``0`` | include particles? (1=yes, 0=no) |
71+
+----------------------------------+------------------+----------------------------------------------------+
72+
| n_particles | ``100`` | number of particles |
73+
+----------------------------------+------------------+----------------------------------------------------+
74+
| particle_generator | ``random`` | how do we generate particles? (random, grid) |
75+
+----------------------------------+------------------+----------------------------------------------------+
7076

71-
* section: [vis]
77+
* section: ``[vis]``
7278

73-
+----------------------------------+----------------+----------------------------------------------------+
74-
| option | value | description |
75-
+==================================+================+====================================================+
76-
| dovis | ``1`` | runtime visualization? (1=yes, 0=no) |
77-
+----------------------------------+----------------+----------------------------------------------------+
78-
| store_images | ``0`` | store vis images to files (1=yes, 0=no) |
79-
+----------------------------------+----------------+----------------------------------------------------+
79+
+----------------------------------+------------------+----------------------------------------------------+
80+
| option | value | description |
81+
+==================================+==================+====================================================+
82+
| dovis | ``1`` | runtime visualization? (1=yes, 0=no) |
83+
+----------------------------------+------------------+----------------------------------------------------+
84+
| store_images | ``0`` | store vis images to files (1=yes, 0=no) |
85+
+----------------------------------+------------------+----------------------------------------------------+
8086

‎docs/source/advection_defaults.inc‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
* section: [advection]
1+
* 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

13-
* section: [driver]
13+
* 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

21-
* section: [particles]
21+
* 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

0 commit comments

Comments
 (0)