Skip to content

minor manual clarification #6906

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gassmoeller merged 3 commits into from
Mar 20, 2026
+5 −2
Merged

minor manual clarification #6906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bbf4e4a
mend
maxrudolph Mar 19, 2026
e837c25
indent
maxrudolph Mar 19, 2026
758ca40
fix parameters
gassmoeller Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/modules/changes/20260318_maxrudolph
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Changed: Clarify the default filename for user termination in the manual
<br>
(Max Rudolph, 2026/03/18)
2 changes: 1 addition & 1 deletion doc/sphinx/parameters/Termination_20criteria.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The criterion considers the total heat flux over all boundaries listed by their

&lsquo;steady state velocity&rsquo;: A criterion that terminates the simulation when the RMS of the velocity field stays within a certain range for a specified period of time.

&lsquo;user request&rsquo;: Terminate the simulation gracefully when a file with a specified name appears in the output directory. This allows the user to gracefully exit the simulation at any time by simply creating such a file using, for example, `touch output/terminate`. The file&rsquo;s location is chosen to be in the output directory, rather than in a generic location such as the ASPECT directory, so that one can run multiple simulations at the same time (which presumably write to different output directories) and can selectively terminate a particular one.
&lsquo;user request&rsquo;: Terminate the simulation gracefully when a file with a specified name appears in the output directory. This allows the user to gracefully exit the simulation at any time by simply creating such a file using, for example, `touch output/terminate-aspect`. The file&rsquo;s location is chosen to be in the output directory, rather than in a generic location such as the ASPECT directory, so that one can run multiple simulations at the same time (which presumably write to different output directories) and can selectively terminate a particular one.

&lsquo;wall time&rsquo;: Terminate the simulation once the wall time limit has reached.
::::
Expand Down
2 changes: 1 addition & 1 deletion source/termination_criteria/user_request.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ namespace aspect
"Terminate the simulation gracefully when a file with a specified "
"name appears in the output directory. This allows the user to "
"gracefully exit the simulation at any time by simply creating "
"such a file using, for example, \\texttt{touch output/terminate}. "
"such a file using, for example, \\texttt{touch output/terminate-aspect}. "
"The file's location is chosen to be in the output directory, "
"rather than in a generic location such as the ASPECT directory, "
"so that one can run multiple simulations at the same time (which "
Expand Down