Skip to content
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

Jump to bottom

Update documentation of save_start and save_end #560

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Update documentation of save_start and save_end #560

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/src/interfaces/Common_Keywords.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,14 @@ section at the end of this page for some example usage.
settings of `dense`, `saveat` and `save_everystep` and is used by some applications
to manually turn off saving temporarily. Everyday use of the solvers should leave
this unchanged. Defaults to `true`.
* `save_start`: Denotes whether the initial condition should be included in
the solution type as the first timepoint. Defaults to `true`.
* `save_end`: Denotes whether the final timepoint is forced to be saved,
regardless of the other saving settings. Defaults to `true`.
* `save_start`: Denotes whether the initial condition should be included in the solution
type as the first timepoint. This setting overrides `saveat` when set to `false`.
Defaults to
`save_everystep || isempty(saveat) || saveat isa Number || prob.tspan[1] in saveat`.
* `save_end`: Denotes whether the final condition should be included in the solution type
as the final timepoint. This setting is overridden by other saving settings when set to
`false`. Defaults to
`save_everystep || isempty(saveat) || saveat isa Number || prob.tspan[2] in saveat`.
* `initialize_save`: Denotes whether to save after the callback initialization
phase (when `u_modified=true`). Defaults to `true`.

Expand Down