Skip to content

Add ITER normalised Inductance l_i(3)#3974

Merged
timothy-nunn merged 5 commits intomainfrom
add_iter_normalised_inductances
Nov 6, 2025
Merged

Add ITER normalised Inductance l_i(3)#3974
timothy-nunn merged 5 commits intomainfrom
add_iter_normalised_inductances

Conversation

@chris-ashe
Copy link
Copy Markdown
Collaborator

@chris-ashe chris-ashe commented Nov 6, 2025

This pull request adds support for the ITER Version 3 $l_i(3)$ definition of plasma normalised internal inductance throughout the codebase and documentation. It introduces a new calculation method, exposes the result as a new variable, updates plotting and output routines, and provides documentation and testing for this new feature.

ITER li(3) inductance support:

  • Added the calculate_normalised_internal_inductance_iter_3 static method to the Physics class, implementing the ITER Version 3 definition for normalised internal inductance.
  • Integrated the new calculation into the main physics workflow, storing the result in the new variable ind_plasma_internal_norm_iter_3.
  • Declared, initialized, and documented the new variable ind_plasma_internal_norm_iter_3 in physics_variables.py, and included it in the initialization routine.

Output and visualization:

  • Updated the plasma information plotting function to display the new ITER li(3) value alongside existing inductance values.
  • Modified the output routine to write the ITER li(3) value to output files.

Documentation and testing:

  • Added a section to the documentation describing the ITER li(3) definition, its formula, and relevant references.
  • Added a unit test to verify the correctness of the new calculation method.
  • Promoted the Menard inductance relation heading for clarity in the documentation.

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 changed the title Add ITER normalised Inductance $l_i(3)$ Add ITER normalised Inductance $l_i(3)$ Nov 6, 2025
@chris-ashe chris-ashe changed the title Add ITER normalised Inductance $l_i(3)$ Add ITER normalised Inductance $g$ Nov 6, 2025
@chris-ashe chris-ashe changed the title Add ITER normalised Inductance $g$ Add ITER normalised Inductance $g$ Nov 6, 2025
@chris-ashe chris-ashe changed the title Add ITER normalised Inductance $g$ Add ITER normalised Inductance $$g$$ Nov 6, 2025
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Nov 6, 2025

Codecov Report

❌ Patch coverage is 75.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 43.17%. Comparing base (8dd9e07) to head (f2a3024).
⚠️ Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
process/physics.py 60.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3974      +/-   ##
==========================================
- Coverage   46.05%   43.17%   -2.89%     
==========================================
  Files         123      123              
  Lines       28738    31217    +2479     
==========================================
+ Hits        13235    13477     +242     
- Misses      15503    17740    +2237     

☔ 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 self-assigned this Nov 6, 2025
@chris-ashe chris-ashe added the Physics Relating to the physics models label Nov 6, 2025
@chris-ashe chris-ashe requested a review from j-a-foster November 6, 2025 13:48
@chris-ashe chris-ashe changed the title Add ITER normalised Inductance $$g$$ Add ITER normalised Inductance l_i(3) Nov 6, 2025
Copy link
Copy Markdown
Collaborator

@j-a-foster j-a-foster left a comment

Choose a reason for hiding this comment

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

Happy with changes.

@timothy-nunn timothy-nunn merged commit b0a0128 into main Nov 6, 2025
14 of 18 checks passed
@timothy-nunn timothy-nunn deleted the add_iter_normalised_inductances branch November 6, 2025 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

New Variables Physics Relating to the physics models

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants