Skip to content

Clarify EEst handling in controller snapshot docstrings; note Forward… - #4972

Open
bobby404-K wants to merge 1 commit into
SciML:masterfrom
bobby404-K:docs/eest-snapshot-4964
Open

bobby404-K wants to merge 1 commit into
SciML:masterfrom
bobby404-K:docs/eest-snapshot-4964

Conversation

@bobby404-K

Copy link
Copy Markdown

Closes #4964.

Checklist

  • Appropriate tests were added — N/A, docs/metadata-only change
  • Any code changes were done in a way that does not break public API
  • All documentation related to code changes were updated
  • The new code follows the
    contributor guidelines, in particular the SciML Style Guide and
    COLPRAC.
  • Any new documentation only uses public API

Additional context

Addresses both follow-ups from the review of #4766:

  • snapshot_controller / restore_controller! docstrings (lib/OrdinaryDiffEqCore/src/integrators/controllers.jl): now state that the snapshot covers controller scratch state only and does not include EEst, which lives on the integrator. Added an example showing how callers preserve EEst while pseudo-stepping, mirroring what OrdinaryDiffEqTaylorSeries already does in its adaptive-order step.
  • ForwardDiff test dependency (lib/OrdinaryDiffEqTaylorSeries/Project.toml): added a comment noting it is MIT-licensed and used only in the "AdaptiveOrder Dual tspan derivative" test.

No functional code changes.

@singhharsh1708

Copy link
Copy Markdown
Member

The new text says EEst lives on the integrator, but get_EEst/set_EEst! read and write controller_cache.EEst (controllers.jl:171-186). It's left out of the snapshots because sync_controllers! only copies dtreject (:755), so that's what the sentence should say.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Follow-ups from review of #4766: clarify EEst in controller snapshot docstrings

2 participants