Skip to content

Use variable name have_nonconservative_terms everywhere #2400

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

benegee
Copy link
Contributor

@benegee benegee commented May 14, 2025

resolves #2386

Copy link
Contributor

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md with its PR number.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

@JoshuaLampert JoshuaLampert added the consistency Make Michael happy label May 14, 2025
Copy link

codecov bot commented May 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.95%. Comparing base (4238b89) to head (d03730d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2400   +/-   ##
=======================================
  Coverage   96.95%   96.95%           
=======================================
  Files         504      504           
  Lines       41721    41721           
=======================================
  Hits        40448    40448           
  Misses       1273     1273           
Flag Coverage Δ
unittests 96.95% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@benegee benegee marked this pull request as ready for review May 15, 2025 06:50
@DanielDoehring DanielDoehring added the refactoring Refactoring code without functional changes label May 15, 2025
DanielDoehring
DanielDoehring previously approved these changes May 16, 2025
@DanielDoehring DanielDoehring enabled auto-merge (squash) May 16, 2025 21:04
@@ -26,12 +26,12 @@ isdir(outdir) && rm(outdir, recursive = true)
GC.@preserve u_ode du_ode begin
u = Trixi.wrap_array(u_ode, semi)
du = Trixi.wrap_array(du_ode, semi)
nonconservative_terms = Trixi.have_nonconservative_terms(semi.equations)
have_nonconservative_terms = Trixi.have_nonconservative_terms(semi.equations)
Copy link
Member

Choose a reason for hiding this comment

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

This is the reason why we chose another name: you cannot assign the result of have_nonconservative_terms(equations) (as we write it in the main src of Trixi.jl) to a variable with the same name as the function. Why do you want to change this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for pointing this out!
There was no specific reason, just search and replace.
I wonder why it worked though.
Anyways, I can just revert this change and similar ones.

Copy link
Member

@ranocha ranocha May 19, 2025

Choose a reason for hiding this comment

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

It works here since Trixi.have_nonconservative_terms(semi.equations) is specified by module name explicitly. In contrast, have_nonconservative_terms = have_nonconservative_terms(semi.equations) like we would write it in src does not work.
We should keep the variable names consistent throughout our code base. I wouldn't change it here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Alright!
Thanks for explaining!

@DanielDoehring DanielDoehring disabled auto-merge May 17, 2025 05:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
consistency Make Michael happy refactoring Refactoring code without functional changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consistency: parameters should match function name have_auxiliary_node_vars
4 participants