Add coolant type `enum` by chris-ashe · Pull Request #4297 · ukaea/PROCESS

chris-ashe · 2026-06-05T14:57:43Z

This pull request standardizes the representation of coolant types throughout the codebase by introducing a new CoolantType enum. Previously, coolant types were handled as strings (e.g., "helium" or "water"); now they are represented as integers (1 for helium, 2 for water) with associated names. This change improves type safety, reduces ambiguity, and simplifies comparisons and logic related to coolant types. The update touches core data structures, input handling, engineering models, and plotting/output routines.

Key changes include:

1. Introduction and Adoption of CoolantType Enum

Added a new CoolantType enum in process/models/engineering/pumping.py to represent coolant types as integer values with full names, replacing string-based representations.
Updated all relevant imports and usages across the codebase to use CoolantType instead of raw strings or integers.

2. Data Structure and Input Handling Updates

Changed the type of i_fw_coolant_type in FWBSData and input variable definitions from str to int, with updated choices and documentation.

3. Model and Logic Refactoring

Refactored logic in blanket and first wall models to use CoolantType for all coolant type checks and assignments, improving clarity and reducing errors.
Updated function signatures and documentation to reflect the change from string to integer coolant type parameters.

4. Consistent Use in Property and Calculation Calls

Modified all calls to FluidProperties.of and other relevant functions to use CoolantType(...).full_name or .name as appropriate, ensuring correct mapping to fluid property libraries.

5. Output and Plotting Improvements

Updated output and plotting routines to display coolant type using the enum's name, enhancing readability and consistency in generated reports and plots.

These changes collectively make the coolant type handling more robust, maintainable, and less error-prone.## Description

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.

codecov-commenter · 2026-06-05T15:04:25Z

Codecov Report

❌ Patch coverage is 80.76923% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 48.79%. Comparing base (d86c108) to head (7c36065).
⚠️ Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
process/models/blankets/blanket_library.py	40.00%	3 Missing ⚠️
process/models/blankets/hcpb.py	66.66%	1 Missing ⚠️
process/models/stellarator/stellarator.py	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4297      +/-   ##
==========================================
+ Coverage   48.69%   48.79%   +0.09%     
==========================================
  Files         151      151              
  Lines       29290    29340      +50     
==========================================
+ Hits        14263    14316      +53     
+ Misses      15027    15024       -3

☔ View full report in Codecov by Harness.
📢 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.

Copilot

Pull request overview

This PR introduces a CoolantType enum and migrates first-wall / blanket coolant selection logic away from string literals toward a consistent numeric/enum representation across models, inputs, plots, and tests.

Changes:

Added CoolantType (IntEnum) and updated model logic to compare coolant types via enum values.
Changed i_fw_coolant_type from a string input/data value to an integer (1/2) and updated selected regression inputs accordingly.
Updated unit tests to use CoolantType.HELIUM / CoolantType.WATER instead of raw literals.

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
`process/models/engineering/pumping.py`	Adds `CoolantType` enum used throughout coolant selection and pumping calculations.
`process/data_structure/fwbs_variables.py`	Changes `i_fw_coolant_type` storage from `str` to `int` (1/2).
`process/core/input.py`	Updates input parsing for `i_fw_coolant_type` to accept integers (1/2).
`process/models/fw.py`	Converts FW CoolProp calls to use `CoolantType(...)` for fluid selection.
`process/models/blankets/blanket_library.py`	Migrates FW/blanket coolant selection and pumping power calls toward enum/int usage.
`process/models/blankets/hcpb.py`	Uses `CoolantType` for blanket coolant type assignment and comparisons.
`process/models/stellarator/stellarator.py`	Replaces numeric coolant comparisons with `CoolantType` checks.
`process/core/io/plot/summary.py`	Updates FW plot annotation to display coolant type via `CoolantType(...)`.
`tests/unit/models/test_fw.py`	Updates FW unit tests to use `CoolantType` constants.
`tests/unit/models/test_costs_1990.py`	Updates costs unit tests to use `CoolantType` constants.
`tests/unit/models/blankets/test_ccfe_hcpb.py`	Updates blanket tests to use `CoolantType` constants.
`tests/unit/models/blankets/test_blanket_library.py`	Updates blanket library tests to use `CoolantType` constants (incl. pumping-power test data).
`tests/regression/input_files/st_regression.IN.DAT`	Updates FW coolant input value from `helium` to `1`.
`tests/regression/input_files/spherical_tokamak_eval.IN.DAT`	Updates FW coolant input value from `helium` to `1`.

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

            # FW/BB
            fw_bb_fluid_properties = FluidProperties.of(
-                self.data.fwbs.i_fw_coolant_type,
+                CoolantType(self.data.fwbs.i_fw_coolant_type).name,


            ) * 0.5
            fw_fluid_properties = FluidProperties.of(
-                self.data.fwbs.i_fw_coolant_type,
+                CoolantType(self.data.fwbs.i_fw_coolant_type).name,


                dpres_coolant=deltap_blkt,
                mflow_coolant_total=self.data.blanket.mflow_blkt_coolant_total,
                primary_coolant_switch=(
-                    "Helium" if self.data.fwbs.i_blkt_coolant_type == 1 else "Water"
+                    "Helium"
+                    if self.data.fwbs.i_blkt_coolant_type == CoolantType.HELIUM
+                    else "Water"
                ),


        # Adiabatic index for helium or water
-        gamma = (5 / 3) if self.data.fwbs.i_blkt_coolant_type == 1 else (4 / 3)
+        gamma = (
+            (5 / 3)
+            if self.data.fwbs.i_blkt_coolant_type == CoolantType.HELIUM
+            else (4 / 3)
+        )


    ),
    "quench_model": InputVariable("tfcoil", str, choices=["exponential", "linear"]),
-    "i_fw_coolant_type": InputVariable("fwbs", str, choices=["helium", "water"]),
+    "i_fw_coolant_type": InputVariable("fwbs", int, choices=[1, 2]),


        # Calculate inlet coolant fluid properties (fixed pressure)
        inlet_coolant_properties = FluidProperties.of(
-            self.data.fwbs.i_fw_coolant_type,
+            CoolantType(self.data.fwbs.i_fw_coolant_type).name,


        # Calculate outlet coolant fluid properties (fixed pressure)
        outlet_coolant_properties = FluidProperties.of(
-            self.data.fwbs.i_fw_coolant_type,
+            CoolantType(self.data.fwbs.i_fw_coolant_type).name,


…ated variables

…ata for first wall coolant type

…y retrieval

…s in BlanketLibrary

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

clmould

A few small changes, but all good otherwise

clmould · 2026-06-08T14:02:07Z

+            (5 / 3)
+            if self.data.fwbs.i_blkt_coolant_type == CoolantType.HELIUM
+            else (4 / 3)
+        )


Copilot has a comment here, I'm not sure if it needs doing so just mentioning it to you here

We can always add the adiabatic index as an attribute to the enum if we want

I think that using gamma = ( (5 / 3) if primary_coolant_switch == CoolantType.HELIUM else (4 / 3) )
should work as the primary_coolant_switch is either i_blkt_coolant_type or i_fw_coolant_type anyway, so this should ensure the right one is used?

Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>

clmould · 2026-06-08T15:08:32Z

+            (5 / 3)
+            if self.data.fwbs.i_blkt_coolant_type == CoolantType.HELIUM
+            else (4 / 3)
+        )


I think that using gamma = ( (5 / 3) if primary_coolant_switch == CoolantType.HELIUM else (4 / 3) )
should work as the primary_coolant_switch is either i_blkt_coolant_type or i_fw_coolant_type anyway, so this should ensure the right one is used?

clmould · 2026-06-08T15:13:55Z


    textstr_fw = "\n".join((
-        rf"Coolant type: {i_fw_coolant_type}",
+        rf"Coolant type: {CoolantType(i_fw_coolant_type).full_name}",


Suggested change

rf"Coolant type: {CoolantType(i_fw_coolant_type).full_name}",

rf"Coolant type: {i_fw_coolant_type}",

This should work now, as i_fw_coolant_type is read in from the mfile, so is now already read in as 'Helium' , didn't realise this when i made my suggestions earlier!

Copilot AI review requested due to automatic review settings June 5, 2026 14:57

chris-ashe requested a review from a team as a code owner June 5, 2026 14:57

chris-ashe added the Refactor label Jun 5, 2026

Copilot started reviewing on behalf of chris-ashe June 5, 2026 14:57 View session

chris-ashe marked this pull request as draft June 5, 2026 14:57

Copilot AI reviewed Jun 5, 2026

View reviewed changes

chris-ashe marked this pull request as ready for review June 5, 2026 15:21

chris-ashe force-pushed the add_coolant_type_enum branch from 5b53e62 to f7e07cb Compare June 5, 2026 15:22

chris-ashe requested a review from clmould June 5, 2026 15:42

clmould self-assigned this Jun 5, 2026

chris-ashe force-pushed the add_coolant_type_enum branch from 39fd250 to b5f65bf Compare June 8, 2026 09:17

chris-ashe and others added 7 commits June 8, 2026 11:01

Add CoolantType enum and refactor coolant type usage across models

d6ea92a

Refactor coolant type handling to use CoolantType enum and update rel…

85a9201

…ated variables

Refactor coolant type checks to use enum comparison and update test d…

7c3273b

…ata for first wall coolant type

Update CoolantType enum to use full_name and refactor coolant propert…

e4b020c

…y retrieval

Refactor coolant type handling to use full_name for coolant propertie…

d52134e

…s in BlanketLibrary

Potential fix for pull request finding

9db5315

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Potential fix for pull request finding

ac24383

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

chris-ashe force-pushed the add_coolant_type_enum branch from b5f65bf to ac24383 Compare June 8, 2026 10:02

clmould requested changes Jun 8, 2026

View reviewed changes

chris-ashe and others added 6 commits June 8, 2026 15:05

Update process/models/blankets/blanket_library.py

23d5cb8

Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>

Update process/models/blankets/blanket_library.py

7b3f531

Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>

Update process/models/blankets/blanket_library.py

9bf77c8

Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>

Update process/models/fw.py

47551b4

Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>

Update integration test files

394b573

Update process/models/blankets/blanket_library.py

7c36065

Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>

clmould requested changes Jun 8, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add coolant type `enum`#4297

Add coolant type `enum`#4297
chris-ashe wants to merge 13 commits into
mainfrom
add_coolant_type_enum

chris-ashe commented Jun 5, 2026 •

edited

Loading

Uh oh!

codecov-commenter commented Jun 5, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

clmould left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

clmould Jun 8, 2026

Uh oh!

chris-ashe Jun 8, 2026

Uh oh!

clmould Jun 8, 2026

Uh oh!

clmould Jun 8, 2026

Uh oh!

clmould Jun 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	rf"Coolant type: {CoolantType(i_fw_coolant_type).full_name}",
	rf"Coolant type: {i_fw_coolant_type}",

Conversation

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

Uh oh!

Checklist

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

clmould left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

clmould Jun 8, 2026

Choose a reason for hiding this comment

Uh oh!

chris-ashe Jun 8, 2026

Choose a reason for hiding this comment

Uh oh!

clmould Jun 8, 2026

Choose a reason for hiding this comment

Uh oh!

clmould Jun 8, 2026

Choose a reason for hiding this comment

Uh oh!

clmould Jun 8, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chris-ashe commented Jun 5, 2026 •

edited

Loading

codecov-commenter commented Jun 5, 2026 •

edited

Loading