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
Move Minmod implementation into a .tpp file #1429
Conversation
e95eaae
to
dcdbbc8
Compare
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.
I just have one topic for design discussion, but over all I'm happy with this.
@@ -6,6 +6,7 @@ set(LIBRARY Burgers) | |||
set(LIBRARY_SOURCES | |||
Equations.cpp | |||
Fluxes.cpp | |||
Minmod.cpp |
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.
Do you think we should generalize this to LimiterInstantiations.cpp
and instantiate all limiters there?
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.
As I see it: the advantages to grouping the instantiations into a single file are (a) having fewer files and (b) making it easier to see what limiters are available for each system; the downside is having to re-instantiate all limiters when one limiter changes. Are there other considerations that I am missing?
At the moment I do not have a strong opinion on the matter, so I am happy to make the change if you prefer it. Just let me know what you think 🙂
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.
Those are the only two things I can think of. Given that the number of limiters we will have will be < 10 (or at least given the current literature it seems unlikely to exceed 10) I think having separate files so that the compilation can be parallelized better is a good thing :)
Proposed changes
Types of changes:
Component:
Code review checklist
clang-tidy
andIWYU
.For instructions on how to perform the CI checks locally refer to the Dev
guide on the Travis CI.
make doc
to generate the documentation locally intoBUILD_DIR/docs/html
.Then open
index.html
.code review guide.