Skip to content
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

Add IMEX time-stepper interface and Heun2 IMEX #5617

Merged
merged 1 commit into from
Nov 30, 2023

Conversation

wthrowe
Copy link
Member

@wthrowe wthrowe commented Nov 7, 2023

Proposed changes

Upgrade instructions

Code review checklist

  • The code is documented and the documentation renders correctly. Run
    make doc to generate the documentation locally into BUILD_DIR/docs/html.
    Then open index.html.
  • The code follows the stylistic and code quality guidelines listed in the
    code review guide.
  • The PR lists upgrade instructions and is labeled bugfix or
    new feature if appropriate.

Further comments

* \f$Y_{n,\text{inhomogeneous}}\f$ is the contribution of the past
* values from the implicit derivative history, and \f$S(\cdot)\f$ is
* the implicit portion of the right-hand-side (generally source
* terms for PDEs). We call \f$w_n\f$ the \emph{implicit weight}.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doxygen doesn't like \emph. Need to replace it with something else. (Not sure how I messed that locally).

Copy link
Member

@nilsdeppe nilsdeppe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, a couple documentation questions. At group meeting you said you were writing a tutorial so if you think the dox suggestions should go in that instead, just let me know :)

namespace TimeSteppers {
/*!
* \ingroup TimeSteppersGroup
* Intermediate base class implementing a generic IMEX Runge-Kutta
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[optional] One of the best discussions (not to say I find it crystal clear) of IM(EX) RK methods I came across is this one from NASA: https://ntrs.nasa.gov/api/citations/20160005923/downloads/20160005923.pdf Might be worth linking/referencing if you think it could be useful to people? Numerical Recipes doesn't really discuss this in a lot of detail so having something else for folks to learn about it with could be good. Maybe also reference the second Hairer+ book?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the NASA reference here, since it explains the notation well. I'll include Hairer in the tutorial, since that has a bit of discussion of properties of implicit methods and Hairer covers that in depth.

struct ImplicitButcherTableau {
/*!
* The coefficient matrix of the substeps. We can only reasonably
* support EDIRK methods, so the tableau must be lower-triangular
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about ESDIRK and QESDIRK? I don't know the detailed differences, so I would find it helpful to list those explicitly as either being okay or not. I think this rules out collocation-type methods, at least as the most obvious ones to me. Is that right? Might also be worth stating explicitly

Copy link
Member

@nilsdeppe nilsdeppe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! That clarifies things for me, thank you! Please go ahead and squash :)

@nilsdeppe nilsdeppe merged commit 5bbcb19 into sxs-collaboration:develop Nov 30, 2023
21 of 22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants