Skip to content

Conversation

@chris-ashe
Copy link
Collaborator

@chris-ashe chris-ashe commented Dec 8, 2025

This pull request introduces a new "Detailed Plasma Physics" module, adds supporting constants and data structures, and integrates new profile plotting capabilities for advanced plasma diagnostics. The changes enhance the documentation, codebase, and output visualizations, providing more granular insight into plasma behavior and key physical parameters.

Plasma Physics Module & Documentation

  • Added the DetailedPhysics class and its documentation (detailed_physics.md), including methods for calculating Debye length, relativistic particle speed, Coulomb logarithm, classical distance of closest approach, DeBroglie wavelength, plasma frequency, and Larmor frequency. [1] [2] [3]

Data Structures & Constants

  • Introduced new plasma profile variables (Debye length, electron velocity, Coulomb logarithm, plasma and Larmor frequency profiles) in physics_variables.py, with initialization and global registration. [1] [2] [3]
  • Added PLANCK_CONSTANT and updated SPEED_LIGHT to float in constants.py for more accurate physical calculations.

Output & Visualization Enhancements

  • Implemented new plotting functions for Debye length, electron velocity, plasma frequency, Larmor frequency, and Coulomb logarithm profiles in plot_proc.py, integrating them into the main plotting workflow and output PDF.

Integration & Workflow

  • Integrated the new detailed physics calculations and output into the main output pipeline (output.py), ensuring these diagnostics are run and exported at the end of each simulation.

Documentation Navigation

  • Linked the new "Detailed Plasma Physics" documentation page in the navigation sidebar for easier access.## Description

🎨 Output

A new plot_proc page for the electron values of the new functions have been added

image

Checklist

I confirm that I have completed the following checks:

  • My changes follow the PROCESS style guide
  • I have justified any large differences in the regression tests caused by this pull request in the comments.
  • I have added new tests where appropriate for the changes I have made.
  • If I have had to change any existing unit or integration tests, I have justified this change in the pull request comments.
  • If I have made documentation changes, I have checked they render correctly.
  • I have added documentation for my change, if appropriate.

@chris-ashe chris-ashe self-assigned this Dec 8, 2025
@chris-ashe chris-ashe requested a review from jonmaddock December 8, 2025 14:27
@chris-ashe chris-ashe added Physics Relating to the physics models Output Files Issues related to the output data files labels Dec 8, 2025
@codecov-commenter
Copy link

codecov-commenter commented Dec 8, 2025

Codecov Report

❌ Patch coverage is 24.26036% with 128 lines in your changes missing coverage. Please review.
✅ Project coverage is 42.82%. Comparing base (1448faf) to head (b09637c).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
process/io/plot_proc.py 6.25% 90 Missing ⚠️
process/physics.py 27.08% 35 Missing ⚠️
process/output.py 0.00% 2 Missing ⚠️
process/main.py 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4004      +/-   ##
==========================================
- Coverage   45.98%   42.82%   -3.17%     
==========================================
  Files         123      123              
  Lines       29001    31450    +2449     
==========================================
+ Hits        13337    13467     +130     
- Misses      15664    17983    +2319     

☔ 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.

@chris-ashe chris-ashe force-pushed the add_general_plasma_functions_1 branch from 3c22809 to c3ccd3b Compare December 8, 2025 14:49
@chris-ashe chris-ashe marked this pull request as ready for review December 8, 2025 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Output Files Issues related to the output data files Physics Relating to the physics models

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants