⚡ Add TF quench graph by chris-ashe · Pull Request #4261 · ukaea/PROCESS

chris-ashe · 2026-05-19T13:26:50Z

This pull request introduces a new quench time evolution plot to the summary plotting functionality and makes several improvements and cleanups to the quench modeling code. The most important changes include adding the plot_quench_time_evolution function to the summary plots, updating figure indexing to accommodate the new plot, and improving the clarity and consistency of docstrings and variable names in the quench model. Minor formatting and reference style updates are also included.

Summary plotting enhancements:

Added the plot_quench_time_evolution plot to the summary, including passing all necessary parameters from main_plot and updating the number of figures/pages to accommodate the new plot. (process/core/io/plot/summary.py)
Updated all subsequent figure indices in main_plot and plot_summary to ensure plots are assigned to the correct pages after the new plot insertion. (process/core/io/plot/summary.py)

Quench model improvements:

Added matplotlib.pyplot import in quench.py to support the new plotting functionality. (process/models/tfcoil/quench.py)
Improved clarity and consistency of docstrings and parameter names throughout the quench modeling code, including using more descriptive parameter names (e.g., temp_quench_max instead of t_max) and updating reference formatting for better readability. (process/models/tfcoil/quench.py)
Minor formatting and unit consistency improvements in comments and docstrings (e.g., using kg/m³). (process/models/tfcoil/quench.py)

These changes enhance the summary plotting capabilities and improve code quality and maintainability in the quench modeling module.

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.

…au_discharge visualization

… summary.py and quench.py

…or copper and helium fractions

…or clarity

Copilot

Pull request overview

This PR adds a TF coil quench time-evolution plot to the summary plotting workflow and updates quench-related naming/docstrings for clarity.

Changes:

Adds plot_quench_time_evolution for current-density and hotspot-temperature evolution.
Inserts the new quench plot into the summary pages and shifts later figure indices.
Cleans up quench model docstrings, references, and variable names.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File	Description
`process/models/tfcoil/quench.py`	Adds the quench time-evolution plotting function and updates quench calculation naming/docs.
`process/core/io/plot/summary.py`	Imports and calls the new quench plot, adjusts page count and subsequent figure indices, and tweaks TF coil summary text formatting.

Comments suppressed due to low confidence (1)

process/models/tfcoil/quench.py:591

np.interp silently clamps values above the precomputed integral range to temp_quench_max, so if j_operating exceeds the protection limit the operating hotspot curve will flatten at the maximum allowed temperature instead of showing that the limit is exceeded. Use an explicit out-of-range handling strategy, such as extending the temperature grid or plotting/annotating values beyond the limit as invalid/exceeded.

    hotspot_temp_real = np.interp(miit_real, scaled_integral, temp_array)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+            f_he=m_file.get("f_a_tf_turn_cable_space_cooling", scan=scan),
+            t_he_peak=m_file.get("tftmp", scan=scan),
+            temp_quench_max=m_file.get("temp_tf_conductor_quench_max", scan=scan),
+            cu_rrr=100.0,


+            cu_rrr=100.0,
+            t_quench_detection=m_file.get("t_tf_quench_detection", scan=scan),
+            fluence=m_file.get("nflutfmax", scan=scan),
+            j_operating=m_file.get("j_tf_wp", scan=scan),


        plot_resistive_tf_info(ax19, m_file, scan, figs[24])
    plot_tf_coil_structure(
-        figs[26].add_subplot(111, aspect="equal"), m_file, scan, colour_scheme
+        figs[27].add_subplot(111, aspect="equal"), m_file, scan, colour_scheme


+    # Numerically integrate J² dt over time to get MIIT at each time step
+    dt = times[1] - times[0]
+    miit_required = np.cumsum(j_profile_required**2) * dt
+    miit_required_1e23 = np.cumsum(j_profile_required_1e23**2) * dt
+    miit_real = np.cumsum(j_profile_real**2) * dt
+


+    if figure is not None:
+        figure.tight_layout()
+    else:
+        plt.tight_layout()


codecov-commenter · 2026-05-19T13:44:27Z

Codecov Report

❌ Patch coverage is 8.82353% with 93 lines in your changes missing coverage. Please review.
✅ Project coverage is 50.10%. Comparing base (226576d) to head (a1c2d70).

Files with missing lines	Patch %	Lines
process/models/tfcoil/quench.py	8.98%	81 Missing ⚠️
process/core/io/plot/summary.py	7.69%	12 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4261      +/-   ##
==========================================
- Coverage   50.23%   50.10%   -0.14%     
==========================================
  Files         151      151              
  Lines       29365    29450      +85     
==========================================
+ Hits        14752    14755       +3     
- Misses      14613    14695      +82

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

…r typing and enhance label formatting for temperature display

… and neutron fluence in superconducting TF coil model

…t labels

CoronelBuendia

Couple of mods and comments while I have a think about how you're doing the temperature evolution plot here. I don't have all that much time at the moment to look at this properly, sorry!

CoronelBuendia · 2026-05-20T12:30:47Z

+
+    # Adiabatic hotspot temperature: integrate heat balance over time
+    # T(t) is found by inverting: integral_{T0}^{T(t)} [sum(rho*cp)] / rho_cu dT = integral_0^t J^2 dt
+    # We accumulate the "MIIT" (integral J^2 dt) and map it to temperature via the precomputed integral.


What is MIIT? Could you define it somewhere in words? I guess it is an acronym?

CoronelBuendia · 2026-05-20T12:41:28Z

+    j_profile_required = np.where(
+        times < t_quench_detection,
+        j_max,
+        j_max * np.exp(-(times - t_quench_detection) / tau_discharge),
+    )
+
+    j_profile_required_1e23 = np.where(
+        times < t_quench_detection,
+        j_max_1e23,
+        j_max_1e23 * np.exp(-(times - t_quench_detection) / tau_discharge),
+    )
+
+    j_profile_real = np.where(
+        times < t_quench_detection,
+        j_operating,
+        j_operating * np.exp(-(times - t_quench_detection) / tau_discharge),
+    )


Suggested change

j_profile_required = np.where(

times < t_quench_detection,

j_max,

j_max * np.exp(-(times - t_quench_detection) / tau_discharge),

)

j_profile_required_1e23 = np.where(

times < t_quench_detection,

j_max_1e23,

j_max_1e23 * np.exp(-(times - t_quench_detection) / tau_discharge),

)

j_profile_real = np.where(

times < t_quench_detection,

j_operating,

j_operating * np.exp(-(times - t_quench_detection) / tau_discharge),

)

decay = np.exp(-(times - t_quench_detection) / tau_discharge)

j_profile_required, j_profile_required_1e23, j_profile_real = [

np.where(times < t_quench_detection, j0, j0 * decay)

for j0 in (j_max, j_max_1e23, j_operating)

]

CoronelBuendia · 2026-05-20T12:44:01Z

+    j_max = calculate_quench_protection_current_density(
+        tau_discharge,
+        b_peak,
+        f_cu,
+        f_he,
+        t_he_peak,
+        temp_quench_max,
+        cu_rrr,
+        t_quench_detection,
+        fluence,
+    )
+
+    fluence_1e23 = 1e23
+    j_max_1e23 = calculate_quench_protection_current_density(
+        tau_discharge,
+        b_peak,
+        f_cu,
+        f_he,
+        t_he_peak,
+        temp_quench_max,
+        cu_rrr,
+        t_quench_detection,
+        fluence_1e23,
+    )


Suggested change

j_max = calculate_quench_protection_current_density(

tau_discharge,

b_peak,

f_cu,

f_he,

t_he_peak,

temp_quench_max,

cu_rrr,

t_quench_detection,

fluence,

)

fluence_1e23 = 1e23

j_max_1e23 = calculate_quench_protection_current_density(

tau_discharge,

b_peak,

f_cu,

f_he,

t_he_peak,

temp_quench_max,

cu_rrr,

t_quench_detection,

fluence_1e23,

)

j_max, j_max_1e23 = [

calculate_quench_protection_current_density(

tau_discharge,

b_peak,

f_cu,

f_he,

t_he_peak,

temp_quench_max,

cu_rrr,

t_quench_detection,

fl,

)

for fl in (fluence, 1e23)

]

CoronelBuendia · 2026-05-20T15:24:00Z

+                    + f_cu_cable * _copper_specific_heat_capacity(ti) * COPPER_DENSITY
+                    + f_sc_cable * _nb3sn_specific_heat_capacity(ti) * NB3SN_DENSITY
+                ) / nu_cu
+                val += dti * integrand


I can see this would be a pain, but it is a potential source of future technical debt we're taking on here in not re-using the same function that is actually used in the module. Would require re-factoring what is already in quench.py, but nothing too difficult, I'd imagine.

This could also help clear up why the temperature evolution is not meeting the hotspot criterion when the current density constraint is hit.

CoronelBuendia · 2026-05-21T12:14:14Z

+    miit_real = np.cumsum(j_profile_real**2) * dt
+
+    # Map MIIT -> temperature via inverse interpolation of cum_integral * f_cu_cable
+    scaled_integral = f_cu_cable * cum_integral


So crude thoughts. The equation is of the form:

$$ \int A(t) dt = \int B(T) dT $$

We resolve the LHS analytically, and the RHS numerically.

You essentially want $dT/dt|_{t_n} = A(t_n)/B(T_n)$ which is an ODE, and I'm not sure this is what happening here.

chris-ashe added 5 commits May 19, 2026 11:40

Initial commit

ff3bbb7

Add vertical and horizontal lines to plot_quench_time_evolution for t…

4da3f9e

…au_discharge visualization

Refactor quench calculation parameters for clarity and consistency in…

5f73931

… summary.py and quench.py

Update quench time evolution calculations to use dynamic parameters f…

23fd44a

…or copper and helium fractions

Enhance quench time evolution plots with detailed titles and labels f…

90c7613

…or clarity

chris-ashe added TF Coil Toroidal field coil Superconductors Plotting labels May 19, 2026

Refine labels in plot_quench_time_evolution for clarity and consistency

50503de

chris-ashe requested a review from CoronelBuendia May 19, 2026 13:36

chris-ashe marked this pull request as ready for review May 19, 2026 13:36

chris-ashe requested a review from a team as a code owner May 19, 2026 13:36

Copilot AI review requested due to automatic review settings May 19, 2026 13:36

Copilot started reviewing on behalf of chris-ashe May 19, 2026 13:37 View session

Copilot AI reviewed May 19, 2026

View reviewed changes

chris-ashe added 4 commits May 19, 2026 14:51

Refactor plot_quench_time_evolution function to improve axes paramete…

a1c2d70

…r typing and enhance label formatting for temperature display

Update quench parameters to use dynamic values for copper resistivity…

d2e396b

… and neutron fluence in superconducting TF coil model

Update TF Quench Hotspot J limit description for clarity in constrain…

0602c8a

…t labels

Update label for TF Quench Hotspot J limit for clarity

d4f47d6

CoronelBuendia requested changes May 20, 2026

View reviewed changes

CoronelBuendia reviewed May 21, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

⚡ Add TF quench graph#4261

⚡ Add TF quench graph#4261
chris-ashe wants to merge 10 commits into
mainfrom
add_tf_quench_graph

chris-ashe commented May 19, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

codecov-commenter commented May 19, 2026 •

edited

Loading

Uh oh!

CoronelBuendia left a comment

Uh oh!

CoronelBuendia May 20, 2026

Uh oh!

CoronelBuendia May 20, 2026

Uh oh!

CoronelBuendia May 20, 2026

Uh oh!

CoronelBuendia May 20, 2026

Uh oh!

CoronelBuendia May 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

chris-ashe commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

codecov-commenter commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

CoronelBuendia left a comment

Choose a reason for hiding this comment

Uh oh!

CoronelBuendia May 20, 2026

Choose a reason for hiding this comment

Uh oh!

CoronelBuendia May 20, 2026

Choose a reason for hiding this comment

Uh oh!

CoronelBuendia May 20, 2026

Choose a reason for hiding this comment

Uh oh!

CoronelBuendia May 20, 2026

Choose a reason for hiding this comment

Uh oh!

CoronelBuendia May 21, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chris-ashe commented May 19, 2026 •

edited

Loading

codecov-commenter commented May 19, 2026 •

edited

Loading