Skip to content

Commit 62f7670

Browse files
Merge pull request #1050 from AayushSabharwal/as/bad-error
docs: update incorrect references to `BrownBasicInit`
2 parents 06cad10 + 9e404c4 commit 62f7670

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

src/callbacks.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Contains a single callback whose `condition` is a continuous function. The callb
102102
The effect of using a callback with a DAE needs to be done with care because the solution
103103
`u` needs to satisfy the algebraic constraints before taking the next step. For this reason,
104104
a consistent initialization calculation must be run after running the callback. If the
105-
chosen initialization alg is `BrownBasicInit()` (the default for `solve`), then the initialization
105+
chosen initialization alg is `BrownFullBasicInit()` (the default for `solve`), then the initialization
106106
will change the algebraic variables to satisfy the conditions. Thus if `x` is an algebraic
107107
variable and the callback performs `x+=1`, the initialization may "revert" the change to
108108
satisfy the constraints. This behavior can be removed by setting `initializealg = CheckInit()`,
@@ -331,7 +331,7 @@ DiscreteCallback(condition, affect!;
331331
The effect of using a callback with a DAE needs to be done with care because the solution
332332
`u` needs to satisfy the algebraic constraints before taking the next step. For this reason,
333333
a consistent initialization calculation must be run after running the callback. If the
334-
chosen initialization alg is `BrownBasicInit()` (the default for `solve`), then the initialization
334+
chosen initialization alg is `BrownFullBasicInit()` (the default for `solve`), then the initialization
335335
will change the algebraic variables to satisfy the conditions. Thus if `x` is an algebraic
336336
variable and the callback performs `x+=1`, the initialization may "revert" the change to
337337
satisfy the constraints. This behavior can be removed by setting `initializealg = CheckInit()`,

src/initialization.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ function Base.showerror(io::IO, e::CheckInitFailureError)
8989
print(io,
9090
"""
9191
If you wish for the system to automatically change the algebraic variables to \
92-
satisfy the algebraic constraints, please pass `initializealg = BrownBasicInit()` \
92+
satisfy the algebraic constraints, please pass `initializealg = BrownFullBasicInit()` \
9393
to solve (this option will require `using OrdinaryDiffEqNonlinearSolve`). If you \
9494
wish to perform an initialization on the complete u0, please pass \
9595
`initializealg = ShampineCollocationInit()` to `solve`. Note that initialization \

0 commit comments

Comments
 (0)