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 "Equations" in name of parabolic equations for consistency #1747

Conversation

DanielDoehring
Copy link
Contributor

@DanielDoehring DanielDoehring commented Nov 21, 2023

While reviewing #1323 I noticed that for the parabolic equations the Equations is missing in the name of the equations:

abstract type AbstractCompressibleNavierStokesDiffusion{NDIMS, NVARS, GradientVariables} <:
AbstractEquationsParabolic{NDIMS, NVARS, GradientVariables} end

vs

abstract type AbstractCompressibleEulerEquations{NDIMS, NVARS} <:
AbstractEquations{NDIMS, NVARS} end

This also holds for the 1D, 2D, 3D implementations:

struct CompressibleNavierStokesDiffusion1D{GradientVariables, RealT <: Real,

vs

struct CompressibleEulerEquations1D{RealT <: Real} <:

@DanielDoehring DanielDoehring changed the title Equations tag for Parabolic Add "Equations" in name of parabolic equations for consistency Nov 21, 2023
@sloede
Copy link
Member

sloede commented Nov 21, 2023

IIRC this was a deliberate decision, since we wanted to make it clear that these are not "proper" equations that can be used as standalone models but that they only provide the diffusion part to an otherwise existing hyperbolic system.

cc @andrewwinters5000 @jlchan

@DanielDoehring
Copy link
Contributor Author

DanielDoehring commented Nov 21, 2023

IIRC this was a deliberate decision, since we wanted to make it clear that these are not "proper" equations that can be used as standalone models but that they only provide the diffusion part to an otherwise existing hyperbolic system.

cc @andrewwinters5000 @jlchan

Ah I see. I was confused by the fact that we have AbstractEquationsParabolic (not AbstractDiffusionParabolic or something similar) but no AbstractLaplaceDiffusionEquation (or something similar).

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.

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.

@DanielDoehring DanielDoehring deleted the EquationsTagforParabolic branch April 7, 2024 12:03
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.

2 participants