Skip to content

Commit

Permalink
update docs for runtime parameters (#697)
Browse files Browse the repository at this point in the history
### Description
This add `temperature_floor` to the list of runtime parameters in the
documentation and removes the `*_ceiling` parameters, since those have
been removed.

### Related issues
N/A

### Checklist
_Before this pull request can be reviewed, all of these tasks should be
completed. Denote completed tasks with an `x` inside the square brackets
`[ ]` in the Markdown source below:_
- [x] I have added a description (see above).
- [ ] I have added a link to any related issues see (see above).
- [x] I have read the [Contributing
Guide](https://github.com/quokka-astro/quokka/blob/development/CONTRIBUTING.md).
- [ ] I have added tests for any new physics that this PR adds to the
code.
- [ ] I have tested this PR on my local computer and all tests pass.
- [ ] I have manually triggered the GPU tests with the magic comment
`/azp run`.
- [x] I have requested a reviewer for this PR.
  • Loading branch information
BenWibking authored Aug 1, 2024
1 parent 2cc68d8 commit 9e20d50
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions docs/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,9 @@ These parameters are read in the `AMRSimulation<problem_t>::readParameters()` fu
* - density_floor
- Float
- The minimum density value allowed in the simulation. Enforced through EnforceLimits.
* - temperature_ceiling
* - temperature_floor
- Float
- The ceiling on temperature values in the simulation. Enforced through EnforceLimits.
* - speed_ceiling
- Float
- The ceiling on the absolute value of the fluid velocity in the simulation. Enforced through EnforceLimits.
- The minimum temperature value allowed in the simulation. Enforced through EnforceLimits.
* - max_walltime
- String
- The maximum walltime for the simulation in the format DD:HH:SS (days/hours/seconds). After 90% of this walltime elapses, the simulation will automatically stop and exit.
Expand Down

0 comments on commit 9e20d50

Please sign in to comment.