🔄 - rename tcoolin to temp_cp_coolant_inlet for consistency across files

chris-ashe · chris-ashe · commit 62a70a9e44ff · 2025-12-17T15:17:22.000Z
diff --git a/examples/data/large_tokamak_1_MFILE.DAT b/examples/data/large_tokamak_1_MFILE.DAT
@@ -7531,7 +7531,7 @@ Resistive_losses_in_current_leads_(MW)___________________________________ (qcl/1
 45%_allowance_for_heat_loads_in_transfer_lines,_storage_tanks_etc_(MW)___ (qmisc/1.0d6)__________________ 2.72832586344118472e-02 OP 
 Sum_=_Total_heat_removal_at_cryogenic_temperatures_(temp_tf_cryo_&_tcoolin)_(MW)_ (helpow_+_helpow_cryal/1.0d6)__ 8.79127222664381619e-02 OP 
 Temperature_of_cryogenic_superconducting_components_(K)__________________ (temp_tf_cryo)_________________ 4.50000000000000000e+00 
-Temperature_of_cryogenic_aluminium_components_(K)________________________ (tcoolin)______________________ 3.13149999999999977e+02 
+Temperature_of_cryogenic_aluminium_components_(K)________________________ (temp_cp_coolant_inlet)______________________ 3.13149999999999977e+02 
 Electric_power_for_cryogenic_plant_(MW)__________________________________ (p_cryo_plant_electric_mw)_____ 4.33777902259955042e+01 OP 
 # Plant Heat Transport Balance #
 Neutronic_nuclear_heat_deposited_in_FW_[MW]______________________________ (p_fw_nuclear_heat_total_mw)___ 1.64705228778508570e+02 
diff --git a/examples/data/large_tokamak_2_MFILE.DAT b/examples/data/large_tokamak_2_MFILE.DAT
@@ -7531,7 +7531,7 @@ Resistive_losses_in_current_leads_(MW)___________________________________ (qcl/1
 45%_allowance_for_heat_loads_in_transfer_lines,_storage_tanks_etc_(MW)___ (qmisc/1.0d6)__________________ 2.80915192906149337e-02 OP 
 Sum_=_Total_heat_removal_at_cryogenic_temperatures_(temp_tf_cryo_&_tcoolin)_(MW)_ (helpow_+_helpow_cryal/1.0d6)__ 9.05171177142036903e-02 OP 
 Temperature_of_cryogenic_superconducting_components_(K)__________________ (temp_tf_cryo)_________________ 4.50000000000000000e+00 
-Temperature_of_cryogenic_aluminium_components_(K)________________________ (tcoolin)______________________ 3.13149999999999977e+02 
+Temperature_of_cryogenic_aluminium_components_(K)________________________ (temp_cp_coolant_inlet)______________________ 3.13149999999999977e+02 
 Electric_power_for_cryogenic_plant_(MW)__________________________________ (p_cryo_plant_electric_mw)_____ 4.46628479114613484e+01 OP 
 # Plant Heat Transport Balance #
 Neutronic_nuclear_heat_deposited_in_FW_[MW]______________________________ (p_fw_nuclear_heat_total_mw)___ 1.69539637888681625e+02 
diff --git a/examples/data/large_tokamak_3_MFILE.DAT b/examples/data/large_tokamak_3_MFILE.DAT
@@ -7531,7 +7531,7 @@ Resistive_losses_in_current_leads_(MW)___________________________________ (qcl/1
 45%_allowance_for_heat_loads_in_transfer_lines,_storage_tanks_etc_(MW)___ (qmisc/1.0d6)__________________ 2.89423603823851655e-02 OP 
 Sum_=_Total_heat_removal_at_cryogenic_temperatures_(temp_tf_cryo_&_tcoolin)_(MW)_ (helpow_+_helpow_cryal/1.0d6)__ 9.32587167876855194e-02 OP 
 Temperature_of_cryogenic_superconducting_components_(K)__________________ (temp_tf_cryo)_________________ 4.50000000000000000e+00 
-Temperature_of_cryogenic_aluminium_components_(K)________________________ (tcoolin)______________________ 3.13149999999999977e+02 
+Temperature_of_cryogenic_aluminium_components_(K)________________________ (temp_cp_coolant_inlet)______________________ 3.13149999999999977e+02 
 Electric_power_for_cryogenic_plant_(MW)__________________________________ (p_cryo_plant_electric_mw)_____ 4.60156044457528566e+01 OP 
 # Plant Heat Transport Balance #
 Neutronic_nuclear_heat_deposited_in_FW_[MW]______________________________ (p_fw_nuclear_heat_total_mw)___ 1.76218051876661121e+02 
diff --git a/examples/data/large_tokamak_4_MFILE.DAT b/examples/data/large_tokamak_4_MFILE.DAT
@@ -7531,7 +7531,7 @@ Resistive_losses_in_current_leads_(MW)___________________________________ (qcl/1
 45%_allowance_for_heat_loads_in_transfer_lines,_storage_tanks_etc_(MW)___ (qmisc/1.0d6)__________________ 2.96747670762382149e-02 OP 
 Sum_=_Total_heat_removal_at_cryogenic_temperatures_(temp_tf_cryo_&_tcoolin)_(MW)_ (helpow_+_helpow_cryal/1.0d6)__ 9.56186939123231522e-02 OP 
 Temperature_of_cryogenic_superconducting_components_(K)__________________ (temp_tf_cryo)_________________ 4.50000000000000000e+00 
-Temperature_of_cryogenic_aluminium_components_(K)________________________ (tcoolin)______________________ 3.13149999999999977e+02 
+Temperature_of_cryogenic_aluminium_components_(K)________________________ (temp_cp_coolant_inlet)______________________ 3.13149999999999977e+02 
 Electric_power_for_cryogenic_plant_(MW)__________________________________ (p_cryo_plant_electric_mw)_____ 4.71800615346873045e+01 OP 
 # Plant Heat Transport Balance #
 Neutronic_nuclear_heat_deposited_in_FW_[MW]______________________________ (p_fw_nuclear_heat_total_mw)___ 1.87203899318251160e+02 
diff --git a/examples/data/large_tokamak_nof_2_MFILE.DAT b/examples/data/large_tokamak_nof_2_MFILE.DAT
@@ -7416,7 +7416,7 @@ Resistive_losses_in_current_leads_(MW)___________________________________ (qcl/1
 45%_allowance_for_heat_loads_in_transfer_lines,_storage_tanks_etc_(MW)___ (qmisc/1.0d6)__________________ 2.76301692454299294e-02 OP 
 Sum_=_Total_heat_removal_at_cryogenic_temperatures_(temp_tf_cryo_&_tcoolin)_(MW)_ (helpow_+_helpow_cryal/1.0d6)__ 8.90305453463853258e-02 OP 
 Temperature_of_cryogenic_superconducting_components_(K)__________________ (temp_tf_cryo)_________________ 4.50000000000000000e+00 
-Temperature_of_cryogenic_aluminium_components_(K)________________________ (tcoolin)______________________ 3.13149999999999977e+02 
+Temperature_of_cryogenic_aluminium_components_(K)________________________ (temp_cp_coolant_inlet)______________________ 3.13149999999999977e+02 
 Electric_power_for_cryogenic_plant_(MW)__________________________________ (p_cryo_plant_electric_mw)_____ 4.39293451525369605e+01 OP 
 # Plant Heat Transport Balance #
 Neutronic_nuclear_heat_deposited_in_FW_[MW]______________________________ (p_fw_nuclear_heat_total_mw)___ 1.74794853452737073e+02 
diff --git a/examples/data/large_tokamak_nof_MFILE.DAT b/examples/data/large_tokamak_nof_MFILE.DAT
@@ -7416,7 +7416,7 @@ Resistive_losses_in_current_leads_(MW)___________________________________ (qcl/1
 45%_allowance_for_heat_loads_in_transfer_lines,_storage_tanks_etc_(MW)___ (qmisc/1.0d6)__________________ 2.69532623647092545e-02 OP 
 Sum_=_Total_heat_removal_at_cryogenic_temperatures_(temp_tf_cryo_&_tcoolin)_(MW)_ (helpow_+_helpow_cryal/1.0d6)__ 8.68494009529520300e-02 OP 
 Temperature_of_cryogenic_superconducting_components_(K)__________________ (temp_tf_cryo)_________________ 4.50000000000000000e+00 
-Temperature_of_cryogenic_aluminium_components_(K)________________________ (tcoolin)______________________ 3.13149999999999977e+02 
+Temperature_of_cryogenic_aluminium_components_(K)________________________ (temp_cp_coolant_inlet)______________________ 3.13149999999999977e+02 
 Electric_power_for_cryogenic_plant_(MW)__________________________________ (p_cryo_plant_electric_mw)_____ 4.28531274958454702e+01 OP 
 # Plant Heat Transport Balance #
 Neutronic_nuclear_heat_deposited_in_FW_[MW]______________________________ (p_fw_nuclear_heat_total_mw)___ 1.67952135824856697e+02 
diff --git a/process/data_structure/heat_transport_variables.py b/process/data_structure/heat_transport_variables.py
@@ -83,7 +83,7 @@
 
 
 helpow_cryal: float = None
-"""Heat removal at cryogenic temperature tcoolin (W)"""
+"""Heat removal at cryogenic temperature temp_cp_coolant_inlet (W)"""
 
 
 p_coolant_pump_elec_total_mw: float = None
diff --git a/process/data_structure/tfcoil_variables.py b/process/data_structure/tfcoil_variables.py
@@ -1017,7 +1017,7 @@
 """average radius of coolant channel (m) (`iteration variable 69`)"""
 
 
-tcoolin: float = None
+temp_cp_coolant_inlet: float = None
 """centrepost coolant inlet temperature (K)"""
 
 
@@ -1287,7 +1287,7 @@ def init_tfcoil_variables():
     global p_tf_leg_resistive
     global temp_cp_max
     global rcool
-    global tcoolin
+    global temp_cp_coolant_inlet
     global dtiocool
     global temp_cp_average
     global tcpav2
@@ -1522,7 +1522,7 @@ def init_tfcoil_variables():
     p_tf_leg_resistive = 0.0
     temp_cp_max = 473.15  # 200 C
     rcool = 0.005
-    tcoolin = 313.15  # 40 C
+    temp_cp_coolant_inlet = 313.15  # 40 C
     dtiocool = 0.0
     temp_cp_average = 373.15  # 100 C
     tcpav2 = 0.0
diff --git a/process/init.py b/process/init.py
@@ -645,10 +645,10 @@ def check_process(inputs):  # noqa: ARG001
         # Water cooled copper magnets initalisation / checks
         if data_structure.tfcoil_variables.i_tf_sup == 0:
             # Check if the initial centrepost coolant loop adapted to the magnet technology
-            # Ice cannot flow so tcoolin > 273.15 K
-            if data_structure.tfcoil_variables.tcoolin < 273.15:
+            # Ice cannot flow so temp_cp_coolant_inlet > 273.15 K
+            if data_structure.tfcoil_variables.temp_cp_coolant_inlet < 273.15:
                 raise ProcessValidationError(
-                    "Coolant temperature (tcoolin) cannot be < 0 C (273.15 K) for water cooled copper magents"
+                    "Coolant temperature (temp_cp_coolant_inlet) cannot be < 0 C (273.15 K) for water cooled copper magents"
                 )
 
             # Temperature of the TF legs cannot be cooled down
@@ -680,9 +680,9 @@ def check_process(inputs):  # noqa: ARG001
         elif data_structure.tfcoil_variables.i_tf_sup == 2:
             # Call a lvl 3 error if the inlet coolant temperature is too large
             # Motivation : ill-defined aluminium resistivity fit for T > 40-50 K
-            if data_structure.tfcoil_variables.tcoolin > 40.0:
+            if data_structure.tfcoil_variables.temp_cp_coolant_inlet > 40.0:
                 raise ProcessValidationError(
-                    "Coolant temperature (tcoolin) should be < 40 K for the cryo-al resistivity to be defined"
+                    "Coolant temperature (temp_cp_coolant_inlet) should be < 40 K for the cryo-al resistivity to be defined"
                 )
 
             # Check if the leg average temperature is low enough for the resisitivity fit
@@ -701,7 +701,7 @@ def check_process(inputs):  # noqa: ARG001
 
             # Otherwise intitialise the average conductor temperature at
             data_structure.tfcoil_variables.temp_cp_average = (
-                data_structure.tfcoil_variables.tcoolin
+                data_structure.tfcoil_variables.temp_cp_coolant_inlet
             )
 
         # Check if the boostrap current selection is addapted to ST
diff --git a/process/input.py b/process/input.py
@@ -1678,7 +1678,7 @@ def __post_init__(self):
         data_structure.constraint_variables, float, range=(0.001, 2.0)
     ),
     "tcomrepl": InputVariable(data_structure.cost_variables, float, range=(0.01, 2.0)),
-    "tcoolin": InputVariable(
+    "temp_cp_coolant_inlet": InputVariable(
         data_structure.tfcoil_variables, float, range=(4.0, 373.15)
     ),
     "tcritsc": InputVariable(
diff --git a/process/io/obsolete_vars.py b/process/io/obsolete_vars.py
@@ -475,6 +475,7 @@
     "tdivrepl": "t_div_replace_yrs",
     "tlife": "life_plant",
     "iavail": "i_plant_availability",
+    "tcoolin": "temp_cp_coolant_inlet",
 }
 
 OBS_VARS_HELP = {
diff --git a/process/power.py b/process/power.py
@@ -780,19 +780,22 @@ def calculate_cryo_loads(self) -> None:
         # Rem : Nuclear heating on the outer legs assumed to be negligible
         # Rem : To be updated with 2 cooling loops for TART designs
         if tfcoil_variables.i_tf_sup == 2:
-            # Heat removal power at cryogenic temperature tfcoil_variables.tcoolin (W)
+            # Heat removal power at cryogenic temperature tfcoil_variables.temp_cp_coolant_inlet (W)
             heat_transport_variables.helpow_cryal = (
                 tfcoil_variables.p_cp_resistive
                 + tfcoil_variables.p_tf_leg_resistive
                 + tfcoil_variables.p_tf_joints_resistive
                 + fwbs_variables.pnuc_cp_tf * 1.0e6
             )
 
-            # Calculate electric power requirement for cryogenic plant at tfcoil_variables.tcoolin (MW)
+            # Calculate electric power requirement for cryogenic plant at tfcoil_variables.temp_cp_coolant_inlet (MW)
             p_tf_cryoal_cryo = (
                 1.0e-6
-                * (constants.TEMP_ROOM - tfcoil_variables.tcoolin)
-                / (tfcoil_variables.eff_tf_cryo * tfcoil_variables.tcoolin)
+                * (constants.TEMP_ROOM - tfcoil_variables.temp_cp_coolant_inlet)
+                / (
+                    tfcoil_variables.eff_tf_cryo
+                    * tfcoil_variables.temp_cp_coolant_inlet
+                )
                 * heat_transport_variables.helpow_cryal
             )
 
@@ -807,7 +810,7 @@ def calculate_cryo_loads(self) -> None:
             * ((293 / tfcoil_variables.temp_tf_cryo) - 1)
             / ((293 / 4.5) - 1)
             + heat_transport_variables.helpow_cryal
-            * ((293 / tfcoil_variables.tcoolin) - 1)
+            * ((293 / tfcoil_variables.temp_cp_coolant_inlet) - 1)
             / ((293 / 4.5) - 1)
         ) / 1.0e3
 
@@ -1576,7 +1579,7 @@ def output_cryogenics(self) -> None:
 
         po.ovarre(
             self.outfile,
-            "Sum = Total heat removal at cryogenic temperatures (temp_tf_cryo & tcoolin) (MW)",
+            "Sum = Total heat removal at cryogenic temperatures (temp_tf_cryo & temp_cp_coolant_inlet) (MW)",
             "(helpow + helpow_cryal/1.0d6)",
             (heat_transport_variables.helpow + heat_transport_variables.helpow_cryal)
             * 1.0e-6,
@@ -1591,8 +1594,8 @@ def output_cryogenics(self) -> None:
         po.ovarre(
             self.outfile,
             "Temperature of cryogenic aluminium components (K)",
-            "(tcoolin)",
-            tfcoil_variables.tcoolin,
+            "(temp_cp_coolant_inlet)",
+            tfcoil_variables.temp_cp_coolant_inlet,
         )
         po.ovarre(
             self.outfile,
diff --git a/process/tf_coil.py b/process/tf_coil.py
@@ -2250,15 +2250,15 @@ def cntrpst(self):
         # --------------
         elif tfcoil_variables.i_tf_sup == 2:
             # Inlet coolant density [kg/m3]
-            coolant_density = self.he_density(tfcoil_variables.tcoolin)
+            coolant_density = self.he_density(tfcoil_variables.temp_cp_coolant_inlet)
 
             # Mass flow rate [kg/s]
             cool_mass_flow = acool * coolant_density * tfcoil_variables.vcool
 
             # Infinitesimal power deposition used in the integral
             dptot = ptot / n_tcool_it
 
-            tcool_calc = copy.copy(tfcoil_variables.tcoolin)  # K
+            tcool_calc = copy.copy(tfcoil_variables.temp_cp_coolant_inlet)  # K
             for _i in range(n_tcool_it):
                 # Thermal capacity Cp
                 coolant_cp = self.he_cp(tcool_calc)
@@ -2273,11 +2273,15 @@ def cntrpst(self):
             vcool_max = cool_mass_flow / (acool * coolant_density)
 
             # Getting the global in-outlet temperature increase
-            tfcoil_variables.dtiocool = tcool_calc - tfcoil_variables.tcoolin
+            tfcoil_variables.dtiocool = (
+                tcool_calc - tfcoil_variables.temp_cp_coolant_inlet
+            )
         # --------------
 
         # Average coolant temperature
-        tcool_av = tfcoil_variables.tcoolin + 0.5e0 * tfcoil_variables.dtiocool
+        tcool_av = (
+            tfcoil_variables.temp_cp_coolant_inlet + 0.5e0 * tfcoil_variables.dtiocool
+        )
         # **********************************************
 
         # Film temperature rise
@@ -2359,17 +2363,24 @@ def cntrpst(self):
 
         # Average conductor temperature
         tfcoil_variables.tcpav2 = (
-            tfcoil_variables.tcoolin
+            tfcoil_variables.temp_cp_coolant_inlet
             + dtcncpav
             + dtfilmav
             + 0.5e0 * tfcoil_variables.dtiocool
         )
 
         # Peak wall temperature
         tfcoil_variables.temp_cp_peak = (
-            tfcoil_variables.tcoolin + tfcoil_variables.dtiocool + dtfilmav + dtconcpmx
+            tfcoil_variables.temp_cp_coolant_inlet
+            + tfcoil_variables.dtiocool
+            + dtfilmav
+            + dtconcpmx
+        )
+        tcoolmx = (
+            tfcoil_variables.temp_cp_coolant_inlet
+            + tfcoil_variables.dtiocool
+            + dtfilmav
         )
-        tcoolmx = tfcoil_variables.tcoolin + tfcoil_variables.dtiocool + dtfilmav
         # -------------------------
 
         # Thermal hydraulics: friction factor from Z. Olujic, Chemical
@@ -2494,8 +2505,8 @@ def cntrpst(self):
             po.ovarre(
                 self.outfile,
                 "Input coolant temperature (K)",
-                "(tfcoil_variables.tcoolin)",
-                tfcoil_variables.tcoolin,
+                "(tfcoil_variables.temp_cp_coolant_inlet)",
+                tfcoil_variables.temp_cp_coolant_inlet,
             )
             po.ovarre(
                 self.outfile,
diff --git a/tests/regression/input_files/st_regression.IN.DAT b/tests/regression/input_files/st_regression.IN.DAT
@@ -1519,7 +1519,7 @@ tftmp = 20.0
 * DESCRIPTION:   Average Radius of Coolant Channel for CP (m) 
 * JUSTIFICATION: Assumed
 
-* tcoolin = 20.0 
+* temp_cp_coolant_inlet = 20.0 
 * DESCRIPTION:   Centrepost Coolant Inlet Temperature (K) 
 * JUSTIFICATION: Choosen to be optimal after a scan ranging from 15 to 30 K (G. Voss and S. Kahn)
 
diff --git a/tests/unit/test_power.py b/tests/unit/test_power.py
@@ -2230,7 +2230,7 @@ class Power2Param(NamedTuple):
 
     temp_tf_cryo: Any = None
 
-    tcoolin: Any = None
+    temp_cp_coolant_inlet: Any = None
 
     eff_tf_cryo: Any = None
 
@@ -2361,7 +2361,7 @@ class Power2Param(NamedTuple):
             i_tf_sup=1,
             tfcmw=0,
             temp_tf_cryo=4.5,
-            tcoolin=313.14999999999998,
+            temp_cp_coolant_inlet=313.14999999999998,
             eff_tf_cryo=0.13,
             p_fw_blkt_coolant_pump_mw=202.02739897087824,
             p_shld_coolant_pump_elec_mw=0.0078214713655548,
@@ -2463,7 +2463,7 @@ class Power2Param(NamedTuple):
             i_tf_sup=1,
             tfcmw=0,
             temp_tf_cryo=4.5,
-            tcoolin=313.14999999999998,
+            temp_cp_coolant_inlet=313.14999999999998,
             eff_tf_cryo=0.13,
             p_fw_blkt_coolant_pump_mw=201.96778859673452,
             p_shld_coolant_pump_elec_mw=0.0080667886808651647,
@@ -2841,7 +2841,9 @@ def test_power2(power2param, monkeypatch, power):
 
     monkeypatch.setattr(tfcoil_variables, "temp_tf_cryo", power2param.temp_tf_cryo)
 
-    monkeypatch.setattr(tfcoil_variables, "tcoolin", power2param.tcoolin)
+    monkeypatch.setattr(
+        tfcoil_variables, "temp_cp_coolant_inlet", power2param.temp_cp_coolant_inlet
+    )
 
     monkeypatch.setattr(tfcoil_variables, "eff_tf_cryo", power2param.eff_tf_cryo)
 
diff --git a/tests/unit/test_tfcoil.py b/tests/unit/test_tfcoil.py
@@ -159,8 +159,8 @@ class CntrpstTestAsset(NamedTuple):
 
     :i_tf_sup: value for tfcoil_variables.i_tf_sup to be mocked with (0=Copper, 2=Cryogenic aluminium)
     :type i_tf_sup: integer
-    :tcoolin: value for tfcoil_variables.tcoolin to be mocked with (centrepost coolant inlet temperature)
-    :type tcoolin: float
+    :temp_cp_coolant_inlet: value for tfcoil_variables.temp_cp_coolant_inlet to be mocked with (centrepost coolant inlet temperature)
+    :type temp_cp_coolant_inlet: float
 
     :expected_dtiocool: expected value of tfcoil_variables.dtiocool after tfcoil.cntrpst routine has run
     :type expected_dtiocool: float
@@ -173,7 +173,7 @@ class CntrpstTestAsset(NamedTuple):
     """
 
     i_tf_sup: int
-    tcoolin: float
+    temp_cp_coolant_inlet: float
     expected_dtiocool: float
     expected_tcpav2: float
     expected_temp_cp_peak: float
@@ -220,7 +220,9 @@ def test_cntrpst(cntrpst_asset, monkeypatch, reinitialise_error_module, tfcoil):
     monkeypatch.setattr(tfcoil_variables, "vol_cond_cp", 2)
     monkeypatch.setattr(tfcoil_variables, "p_cp_resistive", 1)
     monkeypatch.setattr(tfcoil_variables, "i_tf_sup", cntrpst_asset.i_tf_sup)
-    monkeypatch.setattr(tfcoil_variables, "tcoolin", cntrpst_asset.tcoolin)
+    monkeypatch.setattr(
+        tfcoil_variables, "temp_cp_coolant_inlet", cntrpst_asset.temp_cp_coolant_inlet
+    )
     monkeypatch.setattr(fwbs_variables, "pnuc_cp_tf", 1)
     monkeypatch.setattr(build_variables, "z_tf_inside_half", 1)
     monkeypatch.setattr(build_variables, "dr_tf_outboard", 0.5)
