Add comprehensive DAE initialization documentation #812
+217
−0
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
- Document all available initialization algorithms with citations - Include detailed examples for each algorithm - Add troubleshooting and performance tips - Add to navigation in Features section
- Reference docstrings for algorithm documentation - Keep examples and troubleshooting sections - Add algorithm selection guide table - More concise while maintaining all useful information
- Add prominent danger box warning about NoInit risks - Clarify that issues using NoInit will be closed immediately - Update examples to show CheckInit as recommended alternative - Mark NoInit as AVOID in algorithm selection table - Emphasize that NoInit with inconsistent conditions leads to undefined behavior
- Add section explaining higher-index DAE issues - Document how to check if DAE is index-1 (Jacobian singularity test) - Show ModelingToolkit solution for index reduction - Link initialization convergence issues to potential index problems
- Remove dae_index_lowering() call as structural_simplify handles it in v10+ - Update both examples to use just structural_simplify - Cleaner, more modern syntax
- Use !!!warn instead of !!!danger for consistency with documentation style - Maintains the same strong warning message about NoInit risks
- Combine OrdinaryDiffEq and Sundials sections to show they support the same interface - Show both DFBDF() and IDA() examples side by side - Move extended versions to separate subsection (OrdinaryDiffEq only) - Emphasize that both packages support the same initialization algorithms
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 comprehensive documentation for DAE initialization algorithms, explaining the new interface introduced in DiffEqBase v6.190.0.
Changes
Created
features/dae_initialization.md:Updated navigation:
pages.jlContent Overview
Algorithms Documented
DefaultInit(): Automatic algorithm selectionCheckInit(): Verification-only modeNoInit(): Skip initializationBrownBasicInit(): Brown et al. (1998) algorithmShampineCollocationInit(): Shampine (2001) collocation methodExamples Included
Additional Content
Related PRs
🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com