-
-
Notifications
You must be signed in to change notification settings - Fork 214
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
docs v7 rework #2317
docs v7 rework #2317
Conversation
Yes exactly. |
I came up with a way to automate the same example over all the libs, but it's a pretty ugly hack. |
Looks like it works, I'll take it. |
That's a regression |
Are the RKO65
RKM
MSRK*
PSRK*
Alshina6 |
IIRc they are non-adaptive. You can check the perform_step! on whether they calculate an EEst. |
How does |
Yes they aren't recommended for most things. DP8 is legacy fallback to dop853 but Verner is just generally better unless you really need a non-lazy interpolation. |
Seems weird to me the 5 from AB5 does not occur anywhere in the description. |
5th Order Adams-Bashforth method. History is prestarted using Ralston's 3rd order Runge-Kutta method. |
I'm not sure what of this OrdinaryDiffEq.jl/lib/OrdinaryDiffEqNordsieck/src/algorithms.jl Lines 7 to 20 in dc0e1e7
And even less sure what then should be in that string. |
It should have a warning as experimental. JVODE is an adaptive BDF implementation in Nordsieck form, similar to VODE. However, FBDF is recommended in almost all scenarios, and so this is more of a development artifact. |
We should also audit to ensure that every algorithm has its source reference in the docstring. I think almost all do, but a few may be missing some. |
@mortenpi we have some large pages in these docs. On Windows I need to do |
No. We should be normalizing the paths so they work cross-platform. Do you mind opening an issue? Just to clarify: if you use the Unix-y path ( |
@@ -334,10 +367,19 @@ function KYKSSPRK42(stage_limiter!, step_limiter! = trivial_limiter!) | |||
False()) | |||
end | |||
|
|||
@doc explicit_rk_docstring("TBD", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like this got deleted.
"KYKSSPRK42") | ||
@doc explicit_rk_docstring( | ||
"Low dissipation and dispersion Runge-Kutta schemes for computational acoustics", | ||
"SHLDDRK_2N", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should have been moved to low storage RK.
Is this template what you had in mind @ChrisRackauckas?