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

[WIP] Three equations model for sloshing simulations #2055

Draft
wants to merge 108 commits into
base: main
Choose a base branch
from

Conversation

jmark
Copy link
Contributor

@jmark jmark commented Aug 30, 2024

This is a draft PR for the three equations model suitable, e.g., for tank sloshing simulations. As of now, this PR is primarily a backup and not ready for review. Nevertheless, interested readers are welcome to check it out and give feedback.

Johannes Markert and others added 30 commits April 8, 2024 13:04
…mework/Trixi.jl into feature-t8code-curved-geometry
it refers to level of refinement in lat lon direction, not number of
tree as in the p4est version
…mework/Trixi.jl into feature-t8code-curved-geometry
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.

@jmark jmark marked this pull request as draft August 30, 2024 16:15
@jmark jmark changed the title [Draft] Three equations model for sloshing simulations [WIP] Three equations model for sloshing simulations Aug 30, 2024
@jmark jmark removed the discussion label Sep 3, 2024
@DanielDoehring
Copy link
Contributor

@DanielDoehring DanielDoehring added the enhancement New feature or request label Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants