Update devdocs solver extension API and fix sync docstrings - #106
Closed
oscardssmith wants to merge 1 commit into
Closed
Update devdocs solver extension API and fix sync docstrings#106oscardssmith wants to merge 1 commit into
oscardssmith wants to merge 1 commit into
Conversation
The "Adding Solvers" example documented `advance_solution_to!`, which no longer exists, along with an `init_cache` signature taking `inner_caches` and alias flags. Rewrite it against the current API: `init_cache(f, alg; uprev, u)` plus `_perform_step!(parent, children, cache, dt)`, which reads the solution indices and synchronizers off `parent` and signals failure via `force_stepfail` instead of inspecting child retcodes inline. Add a section on what an adaptive splitting algorithm has to provide (`isadaptive`, `alg_adaptive_order`, writing `EEst`). Also attach the `forward_sync_subintegrator!` and `backward_sync_subintegrator!` docstrings: a blank line between each docstring and its function left both undocumented, so the `@docs` blocks on the devdocs page rendered empty. Their signature lines said `OperatorSplittingIntegrator` where the methods take `AnySplitIntegrator`. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
|
||
| # Done :) | ||
| function OS._perform_step!( | ||
| parent, children::Tuple, cache::MySimpleFirstOrderCache, dt |
Collaborator
There was a problem hiding this comment.
I think this is residual not cleaned up and a bit confusing. The first argument is the current integrator and the second the subintegrators.
Member
|
Superseded by #108, which puts the developer docstrings on their original generic definitions, adds a generic external-solver interface test, and removes the package-specific strict-QA exceptions. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The "Adding Solvers" example documented
advance_solution_to!, which no longer exists, along with aninit_cachesignature takinginner_cachesand alias flags. Rewrite it against the current API:init_cache(f, alg; uprev, u)plus_perform_step!(parent, children, cache, dt), which reads the solution indices and synchronizers offparentand signals failure viaforce_stepfailinstead of inspecting child retcodes inline. Add a section on what an adaptive splitting algorithm has to provide (isadaptive,alg_adaptive_order, writingEEst).Also attach docstrings: a blank line between each docstring and its function left both undocumented, so the
@docsblocks on the devdocs page rendered empty.