Skip to content

Commit

Permalink
regenerate the defaults for the docs (#268)
Browse files Browse the repository at this point in the history
  • Loading branch information
@zingale
zingale authored Sep 14, 2024
1 parent 8a731ce commit 2541fad
Show file tree
Hide file tree
Showing 19 changed files with 532 additions and 522 deletions.
146 changes: 76 additions & 70 deletions docs/source/_defaults.inc
View file
Original file line number Diff line number Diff line change
@@ -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) |
+----------------------------------+------------------+----------------------------------------------------+

48 changes: 24 additions & 24 deletions docs/source/advection_defaults.inc
View file
Original file line number Diff line number Diff line change
@@ -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`` | |
+----------------------------------+------------------+----------------------------------------------------+

Loading

0 comments on commit 2541fad

Please sign in to comment.