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

Implement collision source terms for multi-ion MHD #2213

Merged
merged 31 commits into from
Feb 21, 2025

Conversation

amrueda
Copy link
Contributor

@amrueda amrueda commented Dec 17, 2024

This PR introduces collision source terms for multi-ion MHD, accompanied by detailed documentation and a physically relevant test case based on the following reference:

  • Ghosh, D., Chapman, T. D., Berger, R. L., Dimits, A., & Banks, J. W. (2019). A multispecies, multifluid model for laser–induced counterstreaming plasma simulations. Computers & Fluids, 186, 38-57.

The Figure shows the temperature of two ion species for the second frictional slow-down test described in the reference above, as computed with examples/tree_2d_dgsem/elixir_mhdmultiion_collisions.jl and source_terms = source_terms_collision_ion_ion.
image

@amrueda amrueda marked this pull request as draft December 17, 2024 18:48
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.

Copy link

codecov bot commented Dec 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.91%. Comparing base (0e9eb6a) to head (c8b4bf4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2213      +/-   ##
==========================================
+ Coverage   96.90%   96.91%   +0.01%     
==========================================
  Files         491      492       +1     
  Lines       40093    40201     +108     
==========================================
+ Hits        38852    38960     +108     
  Misses       1241     1241              
Flag Coverage Δ
unittests 96.91% <100.00%> (+0.01%) ⬆️

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.

@amrueda amrueda marked this pull request as ready for review December 19, 2024 17:49
amrueda and others added 2 commits January 6, 2025 07:56
@DanielDoehring DanielDoehring added the enhancement New feature or request label Jan 14, 2025
Co-authored-by: Joshua Lampert <51029046+JoshuaLampert@users.noreply.github.com>
Co-authored-by: Daniel Doehring <daniel.doehring@rwth-aachen.de>
amrueda and others added 3 commits February 20, 2025 14:31
Copy link
Member

@JoshuaLampert JoshuaLampert left a comment

Choose a reason for hiding this comment

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

I didn't check the math, but overall this looks good to me.

Co-authored-by: Joshua Lampert <51029046+JoshuaLampert@users.noreply.github.com>
JoshuaLampert
JoshuaLampert previously approved these changes Feb 20, 2025
@amrueda amrueda enabled auto-merge (squash) February 21, 2025 10:33
@amrueda amrueda requested a review from ranocha February 21, 2025 10:33
@ranocha ranocha disabled auto-merge February 21, 2025 12:41
@ranocha ranocha merged commit f5d7a79 into main Feb 21, 2025
38 of 39 checks passed
@ranocha ranocha deleted the arr/multi_ion_collision_sources branch February 21, 2025 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants