fiqus 2025.12.0__py3-none-any.whl → 2026.1.1__py3-none-any.whl

fiqus/data/DataModelCommon.py

@@ -175,7 +175,7 @@ class QuenchHeater(BaseModel):
     h: List[float] = Field(
         default=[],
         description="Thickness list of quench heater trance stainless steel part [m]")
-    h_ins: Union[List[float], List[List[float]]] = Field(
+    s_ins: Union[List[float], List[List[float]]] = Field(
         default=[],
         description="Thickness list of quench heater insulation between the stainless steel part and conductor insulation [m]"
                     "This could be a list of list to specify multiple material thicknesses")
@@ -183,11 +183,11 @@ class QuenchHeater(BaseModel):
         default=[],
         description="Material names list of quench heater insulation between the stainless steel part and conductor insulation [-]"
                     "This could be a list of list to specify multiple material names")
-    h_ground_ins: Union[List[float], List[List[float]]] = Field(
+    s_ins_He: Union[List[float], List[List[float]]] = Field(
         default=[],
         description="Material names list of quench heater insulation between the stainless steel part and helium bath [-]"
                     "This could be a list of list to specify multiple material thicknesses")
-    type_ground_ins: Union[List[str], List[List[str]]] = Field(
+    type_ins_He: Union[List[str], List[List[str]]] = Field(
         default=[],
         description="Material names list of quench heater insulation between the stainless steel part and helium bath [-]"
                     "This could be a list of list to specify multiple material names")
@@ -203,10 +203,10 @@ class QuenchHeater(BaseModel):
     f_cover: List[float] = Field(
         default=[],
         description="List of fraction of stainless steel cover. This is l_stainless_steel/(l_stainless_steel+l_copper). Marked as obsolete, but still specified in some models [-].")
-    ids: List[int] = Field(
+    iQH_toHalfTurn_From: List[int] = Field(
         default=[],
         description="List of heater numbers (1 based) equal to the length of turns that are covered by (i.e. thermally connected to) quench heaters.")
-    turns: List[int] = Field(
+    iQH_toHalfTurn_To: List[int] = Field(
         default=[],
         description="List of turn numbers (1 based) that are covered by (i.e. thermally connected to) quench heaters.")
     turns_sides: List[str] = Field(
@@ -346,19 +346,26 @@ class SourceSine(BaseModel):
     """
     Level 3: Class for Sine source parameters for E-CLIQ
     """
-    frequency: Optional[float] = Field(default=None, description="Frequency of the sine source (Hz).")
-    current_amplitude: Optional[float] = Field(default=None, description="Amplitude of the sine current (A).")
-    number_of_periods: Optional[float] = Field(default=None, description="Amplitude of the sine current (A).")
+    frequency: Optional[float] = Field(default=None, description="Frequency of the sine source [Hz].")
+    current_amplitude: Optional[float] = Field(default=None, description="Amplitude of the sine current (A/turn).")
+    number_of_periods: Optional[float] = Field(default=None, description="Number of periods of ECLIQ power supply [-].")
+    number_of_turns: Optional[int] = Field(default=None, description="Number of turns that conform ECLIQ [-].")
 
 class SourcePiecewise(BaseModel):
     """
     Level 3 Class for piecewise (linear) source parameters for E-CLIQ
     """
-    csv_file: Optional[str] = Field(default=None, description="File name for the from_file source type defining the time evolution of current. Multipliers are used for each of them. The file should contain two columns: 'time' (s) and 'current' (A), with these headers. If this field is set, times and currents are ignored.")
-    times: Optional[List[float]] = Field(default=None, description="Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.")
-    currents: Optional[List[float]] = Field(default=None, description="E-CLIQ coil currents relative to current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.")
-    time_multiplier: Optional[float] = Field(default=None, description="Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.")
-    current_multiplier: Optional[float] = Field(default=None, description="Multiplier for the E-CLIQ coil currents in currents. Also used for the values in the source_csv_file.")
+    csv_file: Optional[str] = Field(default=None,
+                                    description="File name for the from_file source type defining the time evolution of current. Multipliers are used for each of them. The file should contain two columns: 'time' (s) and 'current' (A), with these headers. If this field is set, times and currents are ignored.")
+    times: Optional[List[float]] = Field(default=None,
+                                         description="Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.")
+    currents: Optional[List[float]] = Field(default=None,
+                                            description="E-CLIQ coil currents relative to current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.")
+    time_multiplier: Optional[float] = Field(default=None,
+                                             description="Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.")
+    current_multiplier: Optional[float] = Field(default=None,
+                                                description="Multiplier for the E-CLIQ coil currents in currents. Also used for the values in the source_csv_file.")
+
 
 class E_CLIQ_Class(BaseModel):
     """
@@ -401,8 +408,16 @@ class E_CLIQ_Class(BaseModel):
         default = [],
         description = 'length of the ecliq coils along the magnet length (m).')
     L_ecliq_offset: Optional[List[float]] = Field(
-        default = [],
-        description = 'Offset of the quench heater strip from the referrence point located  at the middle of the magnet length. Positive values move the quench heater towards higher z values (move quench heater strip towards the front ofthe magnet).')
+        default=[],
+        description='Offset of the quench heater strip from the referrence point located  at the middle of the magnet length. Positive values move the quench heater towards higher z values (move quench heater strip towards the front ofthe magnet).')
+    iECLIQ_toHalfTurn_From: Optional[List[int]] = Field(
+        default=[],
+        description='List of coils to which the ECLIQ units are connected from, to which half turns they are in direct contact with.'
+    )
+    iECLIQ_toHalfTurn_To: Optional[List[int]] = Field(
+        default=[],
+        description='List of half turns to whom the ECLIQ Units are in direct contact with.'
+    )
 
 class QuenchDetection(BaseModel):
     """

fiqus/data/DataMultipole.py

@@ -17,7 +17,6 @@ class Region(BaseModel):
     lines: Dict[str, int] = {}
     areas: Dict[str, Area] = {}
 
-
 # class CableInsulated(BaseModel):
 #     type: #Literal['Insulated']
 #     insulated: Region = Region()
@@ -76,11 +75,16 @@ class MidLayer(BaseModel):
     point_angles: Dict[str, float] = {}
     mid_layers: Region = Region()
 
-
-class Iron(BaseModel):
+class BaseIron(BaseModel):
     quadrants: Dict[int, Region] = {}
+
+class Iron(BaseIron):
     max_radius: float = 0.0
 
+class Collar(BaseIron):
+    inner_boundary_tags: Dict[int, List[int]] = {} # separated per quadrant
+    cooling_tags: List[int] = [] # all tags
+    outer_boundary_tags: Dict[int, List[int]] = {} # separated per quadrant
 
 class LayerOrder(BaseModel):
     layers: Dict[int, List[AnticlockwiseOrder]] = {}
@@ -102,7 +106,8 @@ class InsulationThickness(BaseModel):
     mid_pole: Dict[str, float] = {}
     mid_layer: Dict[str, float] = {}
     mid_winding: Dict[str, float] = {}
-
+    collar:  Dict[str, float] = {}
+    poles: Dict[str, float] = {}
 
 class ThinShell(BaseModel):
     mid_layers_ht_to_ht: Dict[str, MidLayer] = {}
@@ -114,6 +119,8 @@ class ThinShell(BaseModel):
     mid_turn_blocks: Dict[str, Region] = {}
     mid_wedge_turn: Dict[str, Region] = {}
     mid_layers_aux: Dict[str, Region] = {}
+    collar_layers: Dict[str, Region] = {}
+    pole_layers: Dict[str, Region] = {}
     ins_thickness: InsulationThickness = InsulationThickness()
 
 
@@ -147,13 +154,15 @@ class Insulation(BaseModel):
 
 class Geometry(BaseModel):
     coil: Coil = Coil()
-    iron: Iron = Iron()
     wedges: Wedge = Wedge()
     air: Region = Region()
     air_inf: Region = Region()
     symmetric_boundaries: Region = Region()
     thin_shells: ThinShell = ThinShell()
     insulation: Insulation = Insulation()
+    iron_yoke: Iron = Iron()
+    collar: Collar = Collar()
+    poles: BaseIron = BaseIron()
 
 
 # Domain classes #
@@ -176,6 +185,7 @@ class PoweredGroup(BaseModel):
     mid_winding_lines: Dict[str, int] = {}
     mid_turn_lines: Dict[str, int] = {}
     aux_lines: Dict[str, int] = {}
+    single_node: Optional[int] = None
 
 
 class WedgeGroup(BaseModel):
@@ -202,13 +212,20 @@ class PhysicalGroup(BaseModel):
     blocks: Dict[int, PoweredBlock] = {}
     wedges: Dict[int, WedgeGroup] = {}
     insulations: GroupType = GroupType()
-    iron: GroupType = GroupType()
+    iron_yoke: GroupType = GroupType()
+    collar: GroupType = GroupType()
+    poles: GroupType = GroupType()
+    ref_mesh: GroupType = GroupType()  # used for the reference mesh
+
+    # more PG can be added here
     air_inf: Optional[int] = None
     air_inf_bnd: Optional[int] = None
     air: Optional[int] = None
     symmetric_boundaries: SymmetryGroup = SymmetryGroup()
     half_turns_points: Optional[int] = None
-
+    inner_col: Optional[int] = None
+    outer_col: Optional[int] = None
+    collar_cooling: Optional[int] = None
 
 class SymmetryBoundaries(BaseModel):
     x: List[int] = []
@@ -216,16 +233,18 @@ class SymmetryBoundaries(BaseModel):
 
 
 class GroupEntities(BaseModel):
-    iron: Dict[str, List[int]] = {}
     air: List[int] = []
+    iron_yoke: Dict[str, List[int]] = {}
+    collar: Dict[str, List[int]] = {} # first str determines the material
+    ref_mesh: Dict[str, List[int]] = {} # used for the reference mesh
+    poles: Dict[str, List[int]] = {}
+    # more entities can be added here
     symmetric_boundaries: SymmetryBoundaries = SymmetryBoundaries()
 
-
 class Domain(BaseModel):
     groups_entities: GroupEntities = GroupEntities()
     physical_groups: PhysicalGroup = PhysicalGroup()
 
-
 class MultipoleData(BaseModel):
     geometries: Geometry = Geometry()
     domains: Domain = Domain()
@@ -248,4 +267,8 @@ class MultipoleRegionCoordinate(BaseModel):
     isothermal_nodes: IsothermalNodes = IsothermalNodes()
     neighbouring_nodes: NeighbourNode = NeighbourNode()
 
+    # this class stores the same information as the crns file
+    # but at the mesh level (see https://gitlab.cern.ch/steam/steam-fiqus-dev/-/issues/95)
+    coordinates_per_half_turn: Dict[str, List[List[float]]] = {}
+
 

fiqus/data/DataWindingsCCT.py

@@ -1,37 +1,37 @@
-from pydantic import BaseModel
-from typing import List, Optional
-
-
-class Terminal(BaseModel):
-    vol_st: Optional[List[int]] = None  # volume number for terminal in for straightening
-    surf_st: Optional[List[int]] = None  # surface number for terminal in for straightening
-    vol_et: Optional[List[int]] = None  # volume number for terminal in for extending
-    surf_et: Optional[List[int]] = None  # surface number for terminal in for extending
-    lc_st: Optional[List[List[List[int]]]] = None  # line connections for straightening terminals
-    lc_et: Optional[List[List[List[int]]]] = None  # line connections for extending terminals
-    z_air: Optional[float] = None
-    z_add: Optional[float] = None
-    ndpterms: Optional[List[int]] = None  # number of divisions per terminal
-
-
-class Winding(BaseModel):
-    names: Optional[List[str]] = None  # name to use in gmsh and getdp
-    t_in: Terminal = Terminal()     # Terminal in
-    t_out: Terminal = Terminal()    # Terminal in
-
-
-class WindingsInformation(BaseModel):
-    magnet_name: Optional[str] = None
-    windings_avg_length: Optional[float] = None
-    windings: Winding = Winding()
-    w_names: Optional[List[str]] = None
-    f_names: Optional[List[str]] = None
-    formers: Optional[List[str]] = None
-    air: Optional[str] = None
-
-
-class SpliterBrep(BaseModel):  # Brep file model splitter data
-    magnet_name: Optional[str] = None
-    file_name: Optional[str] = None           # full file name for the brep file
-    vol_firsts: Optional[List[int]] = None    # list of first volumes for the partitioned model
-    vol_lasts: Optional[List[int]] = None      # list of last volumes for the partitioned model
+from pydantic import BaseModel
+from typing import List, Optional
+
+
+class Terminal(BaseModel):
+    vol_st: Optional[List[int]] = None  # volume number for terminal in for straightening
+    surf_st: Optional[List[int]] = None  # surface number for terminal in for straightening
+    vol_et: Optional[List[int]] = None  # volume number for terminal in for extending
+    surf_et: Optional[List[int]] = None  # surface number for terminal in for extending
+    lc_st: Optional[List[List[List[int]]]] = None  # line connections for straightening terminals
+    lc_et: Optional[List[List[List[int]]]] = None  # line connections for extending terminals
+    z_air: Optional[float] = None
+    z_add: Optional[float] = None
+    ndpterms: Optional[List[int]] = None  # number of divisions per terminal
+
+
+class Winding(BaseModel):
+    names: Optional[List[str]] = None  # name to use in gmsh and getdp
+    t_in: Terminal = Terminal()     # Terminal in
+    t_out: Terminal = Terminal()    # Terminal in
+
+
+class WindingsInformation(BaseModel):
+    magnet_name: Optional[str] = None
+    windings_avg_length: Optional[float] = None
+    windings: Winding = Winding()
+    w_names: Optional[List[str]] = None
+    f_names: Optional[List[str]] = None
+    formers: Optional[List[str]] = None
+    air: Optional[str] = None
+
+
+class SpliterBrep(BaseModel):  # Brep file model splitter data
+    magnet_name: Optional[str] = None
+    file_name: Optional[str] = None           # full file name for the brep file
+    vol_firsts: Optional[List[int]] = None    # list of first volumes for the partitioned model
+    vol_lasts: Optional[List[int]] = None      # list of last volumes for the partitioned model

fiqus/data/RegionsModelFiQuS.py

@@ -166,7 +166,7 @@ class ThinShell(BaseModel):
     bdry_curves: Dict[Literal["collar", "poles", "outer_collar"], List[int]] = {} # save the boundary curves of a specific region, used in TSA
 
     # insulation types, only mid layers
-    insulation_types: InsulationType = InsulationType() # todo: merge all types into one @emma, consider dict ?
+    insulation_types: InsulationType = InsulationType()
     quench_heaters: InsulationType = InsulationType()
     collar: InsulationType = InsulationType()
     poles: InsulationType = InsulationType()