-
Notifications
You must be signed in to change notification settings - Fork 192
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
Rename some of the time steppers #4366
Rename some of the time steppers #4366
Conversation
How do I fix Unit.Options.Python.ExtractInputSourceYAMLFromH5? I assume I have to regenerate the h5 file it's reading, but I don't see instructions for how to do that. |
@wthrowe ? import h5py
h5file = h5py.File("SurfaceTestData0.h5", "a")
input_file_str = h5file.attrs['InputSource.yaml'][0]
h5file.attrs['InputSource.yaml'] = [input_file_str.replace("AdamsBashforthN", "AdamsBashforth")]
h5file.close() |
Reading a bit more on the CERK terminology:
So I see a definition of CERK requiring the truncation error to be at least the local truncation error (Orwen), an example of a CERK method with it the global truncation error (DP), and a definition of "continuous" placing no specific requirements on accuracy (Hairer). In light of this, I think it would be good to somehow explicitly include the higher-order property in the names of the classes, but I'm not coming up with anything reasonable. |
Ooof, that's confusing... What if we do something like |
Here's what I'm going with:
It is still unclear to me how important dense-output order is. (I think I'd need to go through the Gassner reference in detail.) The methods that have dense output of lower order than the method order are As for using
(I'm also a bit confused by interest in this property, since it is not obviously desirable. As far as I can tell, those methods avoid requiring extra evaluations by doing more evaluations for the non-dense output, rather than fewer for the dense output.) I will also add something to the docs for |
That all sounds good to me. A couple thoughts:
|
Make it clear that this is "the" Runge-Kutta 4 method, since we have another Runge-Kutta 4 method (Cerk4).
This is the standard Huen's method. Keeping the order in the name seems like it may be convenient.
The N has always seemed unnecessary, and since I'm renaming other time steppers might as well do this one too.
No one seems to agree on what a "continuous" method is. The two cited papers don't even agree on what CERK stands for. Rename after the earlier reference.
To distinguish it from the myriad other third-order RK methods out there.
74045c3
to
494d796
Compare
Updated with all the new names. For |
Proposed changes
This renames
Of the remaining classes, DormandPrince5 seems fine, and the others I don't know better names for:
Note to reviewers: The changes that are not straight find-replace/formatting are the removal of two unnecessary "\file" comments and rewording the help string for Heun.
Upgrade instructions
Some of the time steppers have been renamed. Update your input files accordingly:
Code review checklist
make doc
to generate the documentation locally intoBUILD_DIR/docs/html
.Then open
index.html
.code review guide.
bugfix
ornew feature
if appropriate.Further comments