Skip to content

Commit 026e812

Browse files
Merge pull request #1214 from ChrisRackauckas-Claude/add-init-docstrings
Add comprehensive docstrings for all DAE initialization algorithms
2 parents bd07def + 8aaa38a commit 026e812

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

src/dae_initialization.jl

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# DAE Initialization Algorithms
22
# The base types are in SciMLBase, we just add the specific algorithms here
33

4-
import SciMLBase: DAEInitializationAlgorithm, initialize_dae!
4+
import SciMLBase: DAEInitializationAlgorithm, initialize_dae!, CheckInit, NoInit, OverrideInit
5+
6+
# Re-export the SciMLBase initialization algorithms for convenience
7+
# Note: Docstrings for these types should be added in SciMLBase where they are defined
8+
export CheckInit, NoInit, OverrideInit
59

610
"""
711
struct DefaultInit <: DAEInitializationAlgorithm

src/solve.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -439,6 +439,7 @@ explanations of the timestepping algorithms, see the
439439
- `DefaultInit()` (default): Automatically chooses the best initialization algorithm
440440
- `CheckInit()`: Only checks that initial conditions are consistent, errors if not
441441
- `NoInit()`: Skip initialization completely (for when you know conditions are consistent)
442+
- `OverrideInit()`: Use problem's initialization_data (typically from ModelingToolkit)
442443
- `BrownBasicInit()`: Brown's basic initialization algorithm for index-1 DAEs
443444
- `ShampineCollocationInit()`: Shampine's collocation initialization for general DAEs
444445
See the [DAE initialization documentation](https://docs.sciml.ai/DiffEqDocs/stable/features/dae_initialization/)

0 commit comments

Comments
 (0)