-
-
Notifications
You must be signed in to change notification settings - Fork 47
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
GeneralDomain documentation is unclear #133
Comments
The latter.
Yes, the residuals of the nonlinear system.
That's all it is. Though, we should probably extend this a little bit and change the nonlinear solving to use NonlinearSolve.jl. That would be a breaking change, but quite worth it because this code is really old. Make it so that way |
Clarify GeneralDomain docstring (#133)
@ArnoStrouwen can you tackle this one? |
The documentation for
GeneralDomain
shows the docstringwhich should now be
Moreover, it initially says that
g
should be of the formg(u, resid)
org(t, u, resid)
, and then later says it should beg(resid, u, p)
org(resid, u, p, t)
. What should it be? It's not exactly clear to me what the "residuals" are either: a vector that tests each component of the solution? A single value testing all components? I thought it would be the former, but the documentation sayswhich suggests the latter. I guess judging from
DiffEqCallbacks.jl/src/domain.jl
Lines 192 to 210 in f61c611
it should be that
g
isg(resid, u, p)
org(resid, u, p, t)
,and(doesn't seem likeresid
could actually be any mutable value, not necessarily withlength(resid) == length(u)
resid
can be defined manually directly actually, andtypeof(resid)
must== typeof(u)
).I'm also guessing that
p
is justintegrator.p
, or is there a way to add on extra parameters here without a closure?The text was updated successfully, but these errors were encountered: