Skip to content

Commit

Permalink
dry run noted in documentation (input file reference)
Browse files Browse the repository at this point in the history
  • Loading branch information
mbkuhn committed Oct 14, 2024
1 parent cbbbc1f commit f893b1f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/sphinx/user/inputs_incflo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,16 @@ as initial conditions and discretization options.
Godunov the default approach and has many advantages over the method of lines (MOL): better accuracy,
stability at larger CFL numbers, and greater computational efficiency. Setting this argument to false is
not recommended, and active use or development relying on the method of lines (MOL) is very sparse.

.. input_param:: incflo.dry_run

**type** Boolean, optional, default = false

Setting this option to true enables a "dry run" of the code. This is intended for checking if an input
file is set up properly and for investigating the initial state of a simulation. A dry run will make sure
that initial iterations and the initial projection are skipped, and it will complete no time steps. This is
to minimize the computational demands of such a run. A plot file with the prefix ``dry_run`` will be output
regardless of whether the simulation restarts from a checkpoint file or from scratch.

.. _inputs_incflo_advection:

Expand Down

0 comments on commit f893b1f

Please sign in to comment.