Document how to mutate parameters p in integrator #800
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add documentation explaining that parameters can be modified directly via `integrator.p = new_p`, unlike u and t which require setter functions. This addresses the user's question about how to change the differential equation parameters during integration, particularly in callbacks. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds documentation explaining how to modify parameters
pin the integrator interface, addressing issue #243.Problem
Users were unclear on how to change the differential equation parameters during integration. While the documentation showed
set_t\!,set_u\!, andset_ut\!for modifying state variables, it didn't explain how to modify parameters.Solution
Added a clear explanation in the integrator documentation that parameters can be modified directly via:
The documentation also explains why this is different from
uandt- changingpdoesn't affect the solver's internal state or accuracy, so it can be modified directly without a setter function.Context
As confirmed by @ChrisRackauckas in the issue comments, parameters can be directly assigned unlike
uort. The callback documentation already shows examples of this pattern being used inaffect\!functions.Fixes #243
🤖 Generated with Claude Code