From ba5df3e2cce664c67903b8e783c1f7b61aaf4f8b Mon Sep 17 00:00:00 2001 From: Jack Date: Tue, 25 Aug 2026 11:01:57 +0100 Subject: [PATCH 1/3] Added variable descriptions to dataclass variables --- process/models/tfcoil/superconducting.py | 35 ++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/process/models/tfcoil/superconducting.py b/process/models/tfcoil/superconducting.py index 836d28c674..40ace98b11 100644 --- a/process/models/tfcoil/superconducting.py +++ b/process/models/tfcoil/superconducting.py @@ -2289,15 +2289,26 @@ class TFGeneralTurnGeometry: """General turn geometry info needed for all TF turn types.""" a_tf_turn_cable_space_no_void: float + """Cable space area (per turn) [m2] + Includes the area of voids and central helium channel + """ a_tf_turn_steel: float + """Area of the cable conduit [m2]""" a_tf_turn_insulation: float + """Single turn insulation area [m2]""" n_tf_coil_turns: int + """Number of turns per TF coil""" c_tf_turn: float + """TF coil current per turn (A)""" dx_tf_turn_general: float + """TF coil turn edge length including turn insulation [m]""" dr_tf_turn: float + """Radial width of turn [m]""" dx_tf_turn: float dx_tf_turn_conduit_full_average: float + """Average full width of the conduit surrounding the TF turn cable space [m]""" dx_tf_turn_cable_space_average: float + """Width of cable space inside conduit (m)""" @dataclass(slots=True) @@ -2305,14 +2316,23 @@ class SuperconTFAreasFractions: """Superconducting TF coil winding pack areas and fractions.""" a_tf_wp_coolant_channels: float + """Winding pack He coil area [m2]""" a_tf_wp_conductor: float + """Winding pack conductor area [m2]""" a_tf_wp_extra_void: float + """Winding pack void (He coolant) area [m2]""" a_tf_coil_wp_turn_insulation: float + """Winding pack turn insulation area per coil [m2]""" a_tf_wp_steel: float + """Total area of all winding pack steel [m2]""" a_tf_coil_inboard_steel: float + """Total steel area in inboard TF coil (turn and case) [m²]""" f_a_tf_coil_inboard_steel: float + """Total steel TF fraction""" a_tf_coil_inboard_insulation: float + """Total insulation area in TF coil (turn and WP) [m²]""" f_a_tf_coil_inboard_insulation: float + """Total Insulation fraction""" @dataclass(slots=True) @@ -2320,8 +2340,11 @@ class CICCAveragedTurnGeometry(TFGeneralTurnGeometry): """Averaged turn geometry for a CICC conductor with LTS cables.""" radius_tf_turn_cable_space_corners: float + """Radius of turn cable space rounded corners [m]""" a_tf_turn_cable_space_effective: float + """True area of turn cable space usable by conductor [m²]""" f_a_tf_turn_cable_space_cooling: float + """Total cooling area fraction inside cable space""" @dataclass(slots=True) @@ -2329,12 +2352,19 @@ class CICCIntegerTurnGeometry(TFGeneralTurnGeometry): """Integer turn geometry for a CICC conductor with LTS cables.""" radius_tf_turn_cable_space_corners: float + """Radius of turn cable space rounded corners [m]""" dr_tf_turn_conduit_full: float + """Radial thickness of the full conduit around the cable space [m]""" dx_tf_turn_conduit_full_toroidal: float + """Toroidal thickness of the full conduit around the cable space [m]""" dr_tf_turn_cable_space: float + """Cable area radial and toroidal dimension (integer turn only) [m]""" dx_tf_turn_cable_space: float + """Cable area radial and toroidal dimension (integer turn only) [m]""" a_tf_turn_cable_space_effective: float + """True cable area of WP turn. This includes the removal of the cooling pipe [m²]""" f_a_tf_turn_cable_space_cooling: float + """Fraction of usable turn cable space area used for cooling""" class CICCSuperconductingTFCoil(SuperconductingTFCoil): @@ -3777,10 +3807,15 @@ class CroCoCableSpaceGeometry: """Data class for the geometry of the cable space in a CroCo conductor.""" dia_tf_turn_croco_cable: float + """Diameter of the Croco cable in the TF turn [m]""" a_tf_turn_cable_space_no_void: float + """Cable space area (per turn) [m2]""" a_tf_turn_cable_space_effective: float + """True cable area of WP turn. This includes the removal of the cooling pipe [m²]""" a_tf_turn_steel: float + """Area of the cable conduit [m²]""" f_a_tf_turn_cable_space_cooling: float + """Fraction of usable turn cable space area used for cooling""" class CROCOSuperconductingTFCoil(SuperconductingTFCoil): From c4956bf5537647bbe88a55ce36a8e5751e7a676c Mon Sep 17 00:00:00 2001 From: Jack Date: Tue, 8 Sep 2026 10:36:08 +0100 Subject: [PATCH 2/3] Corrected some docstrings --- process/models/tfcoil/superconducting.py | 50 +++++++++++++----------- 1 file changed, 27 insertions(+), 23 deletions(-) diff --git a/process/models/tfcoil/superconducting.py b/process/models/tfcoil/superconducting.py index 40ace98b11..dc84a6e7eb 100644 --- a/process/models/tfcoil/superconducting.py +++ b/process/models/tfcoil/superconducting.py @@ -2290,25 +2290,26 @@ class TFGeneralTurnGeometry: a_tf_turn_cable_space_no_void: float """Cable space area (per turn) [m2] - Includes the area of voids and central helium channel + Includes the area that would be taken up by voids and central cooling channel """ a_tf_turn_steel: float - """Area of the cable conduit [m2]""" + """Area of the steel cable conduit around the cable space [m²]""" a_tf_turn_insulation: float - """Single turn insulation area [m2]""" + """Single turn insulation area [m²]""" n_tf_coil_turns: int """Number of turns per TF coil""" c_tf_turn: float - """TF coil current per turn (A)""" + """TF coil current per turn [A]""" dx_tf_turn_general: float """TF coil turn edge length including turn insulation [m]""" dr_tf_turn: float """Radial width of turn [m]""" dx_tf_turn: float + """Turn radial and toroidal dimension (integer turn only) [m]""" dx_tf_turn_conduit_full_average: float """Average full width of the conduit surrounding the TF turn cable space [m]""" dx_tf_turn_cable_space_average: float - """Width of cable space inside conduit (m)""" + """Cable area averaged dimension (square shape) [m]""" @dataclass(slots=True) @@ -2316,23 +2317,23 @@ class SuperconTFAreasFractions: """Superconducting TF coil winding pack areas and fractions.""" a_tf_wp_coolant_channels: float - """Winding pack He coil area [m2]""" + """Total area of coolant channels in winding pack [m²]""" a_tf_wp_conductor: float - """Winding pack conductor area [m2]""" + """Winding pack conductor area [m²]""" a_tf_wp_extra_void: float - """Winding pack void (He coolant) area [m2]""" + """Winding pack void space in conductor region for coolant [m²]""" a_tf_coil_wp_turn_insulation: float - """Winding pack turn insulation area per coil [m2]""" + """Winding pack turn insulation area per coil [m²]""" a_tf_wp_steel: float - """Total area of all winding pack steel [m2]""" + """Total area of all winding pack steel [m²]""" a_tf_coil_inboard_steel: float """Total steel area in inboard TF coil (turn and case) [m²]""" f_a_tf_coil_inboard_steel: float - """Total steel TF fraction""" + """Fraction of total inboard TF coil area that is steel""" a_tf_coil_inboard_insulation: float - """Total insulation area in TF coil (turn and WP) [m²]""" + """Inboard coil insulation cross-section per coil [m²]""" f_a_tf_coil_inboard_insulation: float - """Total Insulation fraction""" + """Fraction of total inboard TF coil area that is insulation""" @dataclass(slots=True) @@ -2340,11 +2341,12 @@ class CICCAveragedTurnGeometry(TFGeneralTurnGeometry): """Averaged turn geometry for a CICC conductor with LTS cables.""" radius_tf_turn_cable_space_corners: float - """Radius of turn cable space rounded corners [m]""" + """Radius of the corners of the cable space in the TF turn [m]""" a_tf_turn_cable_space_effective: float - """True area of turn cable space usable by conductor [m²]""" + """True area taken up by conductor in the cable space [m²]""" f_a_tf_turn_cable_space_cooling: float - """Total cooling area fraction inside cable space""" + """Fraction of turn cable space area that is for cooling + (cooling channel and void space)""" @dataclass(slots=True) @@ -2362,9 +2364,10 @@ class CICCIntegerTurnGeometry(TFGeneralTurnGeometry): dx_tf_turn_cable_space: float """Cable area radial and toroidal dimension (integer turn only) [m]""" a_tf_turn_cable_space_effective: float - """True cable area of WP turn. This includes the removal of the cooling pipe [m²]""" + """True area taken up by conductor in the cable space [m²]""" f_a_tf_turn_cable_space_cooling: float - """Fraction of usable turn cable space area used for cooling""" + """Fraction of turn cable space area that is for cooling + (cooling channel and void space)""" class CICCSuperconductingTFCoil(SuperconductingTFCoil): @@ -3807,15 +3810,16 @@ class CroCoCableSpaceGeometry: """Data class for the geometry of the cable space in a CroCo conductor.""" dia_tf_turn_croco_cable: float - """Diameter of the Croco cable in the TF turn [m]""" + """Diameter of the CroCo cable in the TF turn [m]""" a_tf_turn_cable_space_no_void: float - """Cable space area (per turn) [m2]""" + """Cable space area (per turn) [m²]""" a_tf_turn_cable_space_effective: float - """True cable area of WP turn. This includes the removal of the cooling pipe [m²]""" + """True area taken up by conductor in the cable space [m²]""" a_tf_turn_steel: float - """Area of the cable conduit [m²]""" + """Area of the steel conduit around the cable space [m²]""" f_a_tf_turn_cable_space_cooling: float - """Fraction of usable turn cable space area used for cooling""" + """Fraction of turn cable space area that is for cooling + (cooling channel and void space)""" class CROCOSuperconductingTFCoil(SuperconductingTFCoil): From 772fc5e45a3764d96256ab0a24a9e0756a09e0fa Mon Sep 17 00:00:00 2001 From: Jack Date: Fri, 11 Sep 2026 08:37:47 +0100 Subject: [PATCH 3/3] Minor docstring fixes --- process/models/tfcoil/superconducting.py | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/process/models/tfcoil/superconducting.py b/process/models/tfcoil/superconducting.py index dc84a6e7eb..88643c0fc8 100644 --- a/process/models/tfcoil/superconducting.py +++ b/process/models/tfcoil/superconducting.py @@ -2289,8 +2289,8 @@ class TFGeneralTurnGeometry: """General turn geometry info needed for all TF turn types.""" a_tf_turn_cable_space_no_void: float - """Cable space area (per turn) [m2] - Includes the area that would be taken up by voids and central cooling channel + """Cable space area (per turn), includes the area that would be taken up + by voids and central cooling channel [m²] """ a_tf_turn_steel: float """Area of the steel cable conduit around the cable space [m²]""" @@ -2346,7 +2346,8 @@ class CICCAveragedTurnGeometry(TFGeneralTurnGeometry): """True area taken up by conductor in the cable space [m²]""" f_a_tf_turn_cable_space_cooling: float """Fraction of turn cable space area that is for cooling - (cooling channel and void space)""" + (cooling channel and void space) + """ @dataclass(slots=True) @@ -2367,7 +2368,8 @@ class CICCIntegerTurnGeometry(TFGeneralTurnGeometry): """True area taken up by conductor in the cable space [m²]""" f_a_tf_turn_cable_space_cooling: float """Fraction of turn cable space area that is for cooling - (cooling channel and void space)""" + (cooling channel and void space) + """ class CICCSuperconductingTFCoil(SuperconductingTFCoil): @@ -3812,14 +3814,15 @@ class CroCoCableSpaceGeometry: dia_tf_turn_croco_cable: float """Diameter of the CroCo cable in the TF turn [m]""" a_tf_turn_cable_space_no_void: float - """Cable space area (per turn) [m²]""" + """Cable space area (per turn) [m²]""" a_tf_turn_cable_space_effective: float """True area taken up by conductor in the cable space [m²]""" a_tf_turn_steel: float """Area of the steel conduit around the cable space [m²]""" f_a_tf_turn_cable_space_cooling: float """Fraction of turn cable space area that is for cooling - (cooling channel and void space)""" + (cooling channel and void space) + """ class CROCOSuperconductingTFCoil(SuperconductingTFCoil):