fiqus 2025.2.0__py3-none-any.whl → 2025.11.0__py3-none-any.whl

fiqus/data/DataFiQuS.py

@@ -1,20 +1,14 @@
 from pydantic import BaseModel, Field
-from typing import Dict, List, Union, Literal, Optional
-from fiqus.data.DataRoxieParser import RoxieData
-from fiqus.data.DataFiQuSCCT import CCTDM
+from typing import Dict, List, Union, Literal, Optional, Any
+
+from fiqus.data.DataModelCommon import EnergyExtraction, CLIQ_Class, ESC_Class, E_CLIQ_Class, QuenchDetection, Circuit_Class, PowerSupplyClass, QuenchHeater
+from fiqus.data.DataConductor import Conductor
+from fiqus.data.DataFiQuSCCT import CCT
 from fiqus.data.DataFiQuSMultipole import Multipole
 from fiqus.data.DataFiQuSPancake3D import Pancake3D
-from fiqus.data.DataConductor import Conductor
 from fiqus.data.DataFiQuSConductorAC_Strand import CACStrand
 
 
-class FiQuSGeometry(BaseModel):
-    """
-    Class for Roxie data
-    """
-
-    Roxie_Data: RoxieData = RoxieData()
-
 
 class RunFiQuS(BaseModel):
     """
@@ -35,6 +29,8 @@ class RunFiQuS(BaseModel):
         "post_process",
         "plot_python",
         "batch_post_process_python",
+        "only_create_pro_file_from_mesh",
+        "postprocess_veusz"
     ] = Field(
         default="start_from_yaml",
         title="Run Type of FiQuS",
@@ -95,88 +91,30 @@ class GeneralFiQuS(BaseModel):
     magnet_name: Optional[str] = None
 
 
-class EnergyExtraction(BaseModel):
-    """
-    Level 3: Class for FiQuS
-    """
+# class QuenchHeaters(BaseModel):
+#     """
+#     Level 3: Class for FiQuS
+#     """
 
-    t_trigger: Optional[float] = None
-    R_EE: Optional[float] = None
-    power_R_EE: Optional[float] = None
-    L: Optional[float] = None
-    C: Optional[float] = None
+#     N_strips: Optional[int] = None  # set to 0 to avoid building quench heater thin shells
+#     t_trigger: Optional[List[float]] = None
+#     U0: Optional[List[float]] = None
+#     C: Optional[List[float]] = None
+#     R_warm: Optional[List[float]] = None
+#     w: Optional[List[float]] = None
+#     h: Optional[List[float]] = None
+#     h_ins: List[List[float]] = []
+#     type_ins: List[List[str]] = []
+#     h_ground_ins: List[List[float]] = []
+#     type_ground_ins: List[List[str]] = []
+#     l: Optional[List[float]] = None
+#     l_copper: Optional[List[float]] = None
+#     l_stainless_steel: Optional[List[float]] = None
+#     ids: Optional[List[int]] = None
+#     turns: Optional[List[int]] = None
+#     turns_sides: Optional[List[str]] = None
 
 
-class QuenchHeaters(BaseModel):
-    """
-    Level 3: Class for FiQuS
-    """
-
-    N_strips: Optional[int] = None  # set to 0 to avoid building quench heater thin shells
-    t_trigger: Optional[List[float]] = None
-    U0: Optional[List[float]] = None
-    C: Optional[List[float]] = None
-    R_warm: Optional[List[float]] = None
-    w: Optional[List[float]] = None
-    h: Optional[List[float]] = None
-    h_ins: List[List[float]] = []
-    type_ins: List[List[str]] = []
-    h_ground_ins: List[List[float]] = []
-    type_ground_ins: List[List[str]] = []
-    l: Optional[List[float]] = None
-    l_copper: Optional[List[float]] = None
-    l_stainless_steel: Optional[List[float]] = None
-    ids: Optional[List[int]] = None
-    turns: Optional[List[int]] = None
-    turns_sides: Optional[List[str]] = None
-
-
-class Cliq(BaseModel):
-    """
-    Level 3: Class for FiQuS
-    """
-
-    t_trigger: Optional[float] = None
-    current_direction: Optional[List[int]] = None
-    sym_factor: Optional[int] = None
-    N_units: Optional[int] = None
-    U0: Optional[float] = None
-    C: Optional[float] = None
-    R: Optional[float] = None
-    L: Optional[float] = None
-    I0: Optional[float] = None
-
-
-class Circuit(BaseModel):
-    """
-    Level 2: Class for FiQuS
-    """
-
-    R_circuit: Optional[float] = None
-    L_circuit: Optional[float] = None
-    R_parallel: Optional[float] = None
-
-
-class PowerSupply(BaseModel):
-    """
-    Level 2: Class for FiQuS
-    """
-
-    I_initial: Optional[float] = None
-    t_off: Optional[float] = None
-    t_control_LUT: Optional[List[float]] = Field(
-        default=None,
-        title="Time Values for Current Source",
-        description="This list of time values will be matched with the current values in I_control_LUT, and then these (t, I) points will be connected with straight lines.",
-    )
-    I_control_LUT: Optional[List[float]] = Field(
-        default=None,
-        title="Current Values for Current Source",
-        description="This list of current values will be matched with the time values in t_control_LUT, and then these (t, I) points will be connected with straight lines.",
-    )
-    R_crowbar: Optional[float] = None
-    Ud_crowbar: Optional[float] = None
-
 
 class QuenchProtection(BaseModel):
     """
@@ -184,31 +122,20 @@ class QuenchProtection(BaseModel):
     """
 
     energy_extraction: EnergyExtraction = EnergyExtraction()
-    quench_heaters: QuenchHeaters = QuenchHeaters()
-    cliq: Cliq = Cliq()
-
-class QuenchDetection(BaseModel):
-    """
-    Level 2: Class for FiQuS
-    """
+    quench_heaters: QuenchHeater = QuenchHeater()
+    cliq: CLIQ_Class = CLIQ_Class()
+    esc: ESC_Class = ESC_Class()
+    e_cliq: E_CLIQ_Class = E_CLIQ_Class()
 
-    voltage_thresholds: Optional[List[float]] = Field(
-        default=None,
-        title="List of quench detection voltage thresholds",
-        description="Voltage thresholds for quench detection. The quench detection will be triggered when the voltage exceeds these thresholds continuously for a time larger than the discrimination time.",
-    )
 
-    discrimination_times: Optional[List[float]] = Field(
-        default=None,
-        title="List of quench detection discrimination times",
-        description="Discrimination times for quench detection. The quench detection will be triggered when the voltage exceeds the thresholds continuously for a time larger than these discrimination times.",
-    )
+class SolveDumpDataModel(BaseModel):
+    solve: Any      # this is populated with magnet.solve section in MainFiQuS when dumping the yaml file for reference. The is no information on type in the solve section, so going for "Any" here
+    circuit: Circuit_Class = Circuit_Class()
+    power_supply: PowerSupplyClass = PowerSupplyClass()
+    quench_protection: QuenchProtection = QuenchProtection()
+    quench_detection: QuenchDetection = QuenchDetection()
+    conductors: Dict[Optional[str], Conductor] = {}
 
-    voltage_tap_pairs: Optional[List[List[int]]] = Field(
-        default=None,
-        title="List of quench detection voltage tap pairs",
-        description="Voltage tap pairs for quench detection. The voltage difference between these pairs will be used for quench detection.",
-    )
 
 class FDM(BaseModel):
     """
@@ -217,11 +144,11 @@ class FDM(BaseModel):
 
     general: GeneralFiQuS = GeneralFiQuS()
     run: RunFiQuS = RunFiQuS()
-    magnet: Union[Multipole, CCTDM, Pancake3D, CACStrand] = Field(
+    magnet: Union[Multipole, CCT, Pancake3D, CACStrand] = Field(
         default=Multipole(), discriminator="type"
     )
-    circuit: Circuit = Circuit()
-    power_supply: PowerSupply = PowerSupply()
+    circuit: Circuit_Class = Circuit_Class()
+    power_supply: PowerSupplyClass = PowerSupplyClass()
     quench_protection: QuenchProtection = QuenchProtection()
     quench_detection: QuenchDetection = QuenchDetection()
     conductors: Dict[Optional[str], Conductor] = {}

fiqus/data/DataFiQuSCCT.py

@@ -1,150 +1,150 @@
-from pydantic import BaseModel
-from typing import (List, Literal, Optional)
-
-
-class Winding_gFiQuS(BaseModel):  # Geometry related windings _inputs
-    """
-        Level 2: Class for FiQuS CCT
-    """
-    names: Optional[List[str]] = None  # name to use in gmsh and getdp
-    r_wms: Optional[List[float]] = None  # radius of the middle of the winding
-    n_turnss: Optional[List[float]] = None  # number of turns
-    ndpts: Optional[List[int]] = None  # number of divisions of turn, i.e. number of hexagonal elements for each turn
-    ndpt_ins: Optional[List[int]] = None  # number of divisions of terminals in
-    ndpt_outs: Optional[List[int]] = None  # number of divisions of terminals in
-    lps: Optional[List[float]] = None  # layer pitch
-    alphas: Optional[List[float]] = None  # tilt angle
-    wwws: Optional[List[float]] = None  # winding wire widths (assuming rectangular)
-    wwhs: Optional[List[float]] = None  # winding wire heights (assuming rectangular)
-
-
-class Winding_s(BaseModel):  # Solution time used windings _inputs (materials and BC)
-    """
-        Level 2: Class for FiQuS CCT
-    """
-    currents: Optional[List[float]] = None  # current in the wire
-    sigmas: Optional[List[float]] = None  # electrical conductivity
-    mu_rs: Optional[List[float]] = None  # relative permeability
-
-
-class FQPL_g(BaseModel):  # Geometry related fqpls _inputs
-    """
-        Level 2: Class for FiQuS CCT
-    """
-    names: List[str] = []  # name to use in gmsh and getdp
-    fndpls: Optional[List[int]] = None  # fqpl number of divisions per length
-    fwws: Optional[List[float]] = None  # fqpl wire widths (assuming rectangular) for theta = 0 this is x dimension
-    fwhs: Optional[List[float]] = None  # fqpl wire heights (assuming rectangular) for theta = 0 this is y dimension
-    r_ins: Optional[List[float]] = None  # radiuses for inner diameter for fqpl (radial (or x direction for theta=0) for placing the fqpl
-    r_bs: Optional[List[float]] = None  # radiuses for bending the fqpl by 180 degrees
-    n_sbs: Optional[List[int]] = None  # number of 'bending segmetns' for the 180 degrees turn
-    thetas: Optional[List[float]] = None  # rotation in deg from x+ axis towards y+ axis about z axis.
-    z_starts: Optional[List[str]] = None  # which air boundary to start at. These is string with either: z_min or z_max key from the Air region.
-    z_ends: Optional[List[float]] = None  # z coordinate of loop end
-
-
-class FQPL_s(BaseModel):  # Solution time used fqpls _inputs (materials and BC)
-    """
-        Level 2: Class for FiQuS CCT
-    """
-    currents: List[float] = []  # current in the wire
-    sigmas: List[float] = []  # electrical conductivity
-    mu_rs: List[float] = []  # relative permeability
-
-
-class Former_gFiQuS(BaseModel):  # Geometry related formers _inputs
-    """
-        Level 2: Class for FiQuS CCT
-    """
-    names: Optional[List[str]] = None  # name to use in gmsh and getdp
-    r_ins: Optional[List[float]] = None  # inner radius
-    r_outs: Optional[List[float]] = None  # outer radius
-    z_mins: Optional[List[float]] = None  # extend of former  in negative z direction
-    z_maxs: Optional[List[float]] = None  # extend of former in positive z direction
-
-
-class Former_s(BaseModel):  # Solution time used formers _inputs (materials and BC)
-    """
-        Level 2: Class for FiQuS CCT
-    """
-    sigmas: Optional[List[float]] = None  # electrical conductivity
-    mu_rs: Optional[List[float]] = None  # relative permeability
-
-
-class Air_g(BaseModel):  # Geometry related air_region _inputs
-    """
-        Level 2: Class for FiQuS CCT
-    """
-    name: Optional[str] = None  # name to use in gmsh and getdp
-    sh_type: Optional[str] = None  # cylinder or cuboid are possible
-    ar: Optional[float] = None  # if box type is cuboid a is taken as a dimension, if cylinder then r is taken
-    z_min: Optional[float] = None  # extend of air region in negative z direction
-    z_max: Optional[float] = None  # extend of air region in positive z direction
-
-
-class Air_s(BaseModel):  # Solution time used air _inputs (materials and BC)
-    """
-        Level 2: Class for FiQuS CCT
-    """
-    sigma: Optional[float] = None  # electrical conductivity
-    mu_r: Optional[float] = None  # relative permeability
-
-
-class GeometryCCTFiQuS(BaseModel):
-    """
-        Level 2: Class for FiQuS CCT for FiQuS input
-    """
-    windings: Winding_gFiQuS = Winding_gFiQuS()
-    fqpls: FQPL_g = FQPL_g()
-    formers: Former_gFiQuS = Former_gFiQuS()
-    air: Air_g = Air_g()
-
-
-class MeshCCT(BaseModel):
-    """
-        Level 2: Class for FiQuS CCT
-    """
-    MaxAspectWindings: Optional[float] = None  # used in transfinite mesh_generators settings to define mesh_generators size along two longer lines of hex elements of windings
-    ThresholdSizeMin: Optional[float] = None  # sets field control of Threshold SizeMin
-    ThresholdSizeMax: Optional[float] = None  # sets field control of Threshold SizeMax
-    ThresholdDistMin: Optional[float] = None  # sets field control of Threshold DistMin
-    ThresholdDistMax: Optional[float] = None  # sets field control of Threshold DistMax
-
-
-class SolveCCT(BaseModel):
-    """
-        Level 2: Class for FiQuS CCT
-    """
-    windings: Winding_s = Winding_s()  # windings solution time _inputs
-    fqpls: FQPL_s = FQPL_s()  # fqpls solution time _inputs
-    formers: Former_s = Former_s()  # former solution time _inputs
-    air: Air_s = Air_s()  # air solution time _inputs
-    pro_template: Optional[str] = None  # file name of .pro template file
-    variables: Optional[List[str]] = None  # Name of variable to post-process by GetDP, like B for magnetic flux density
-    volumes: Optional[List[str]] = None  # Name of volume to post-process by GetDP, line Winding_1
-    file_exts: Optional[List[str]] = None  # Name of file extensions to post-process by GetDP, like .pos
-
-
-class PostprocCCTFiQuS(BaseModel):
-    """
-        Class for FiQuS CCT input file
-    """
-    windings_wwns: Optional[List[int]] = None  # wires in width direction numbers
-    windings_whns: Optional[List[int]] = None  # wires in height direction numbers
-    additional_outputs: Optional[List[str]] = None  # Name of software specific input files to prepare, like :LEDET3D
-    winding_order: Optional[List[int]] = None
-    fqpl_export_trim_tol: Optional[List[float]] = None  # this multiplier times winding extend gives 'z' coordinate above(below) which hexes are exported for LEDET, length of this list must match number of fqpls
-    variables: Optional[List[str]] = None  # Name of variable to post-process by python Gmsh API, like B for magnetic flux density
-    volumes: Optional[List[str]] = None  # Name of volume to post-process by python Gmsh API, line Winding_1
-    file_exts: Optional[List[str]] = None  # Name of file extensions o post-process by python Gmsh API, like .pos
-
-
-class CCTDM(BaseModel):
-    """
-        Level 1: Class for FiQuS CCT
-    """
-    type: Literal['CCT_straight'] = "CCT_straight"
-    geometry: GeometryCCTFiQuS = GeometryCCTFiQuS()
-    mesh: MeshCCT = MeshCCT()
-    solve: SolveCCT = SolveCCT()
-    postproc: PostprocCCTFiQuS = PostprocCCTFiQuS()
+from pydantic import BaseModel
+from typing import (List, Literal, Optional)
+
+
+class Winding_gFiQuS(BaseModel):  # Geometry related windings _inputs
+    """
+        Level 2: Class for FiQuS CCT
+    """
+    names: Optional[List[str]] = None  # name to use in gmsh and getdp
+    r_wms: Optional[List[float]] = None  # radius of the middle of the winding
+    n_turnss: Optional[List[float]] = None  # number of turns
+    ndpts: Optional[List[int]] = None  # number of divisions of turn, i.e. number of hexagonal elements for each turn
+    ndpt_ins: Optional[List[int]] = None  # number of divisions of terminals in
+    ndpt_outs: Optional[List[int]] = None  # number of divisions of terminals in
+    lps: Optional[List[float]] = None  # layer pitch
+    alphas: Optional[List[float]] = None  # tilt angle
+    wwws: Optional[List[float]] = None  # winding wire widths (assuming rectangular)
+    wwhs: Optional[List[float]] = None  # winding wire heights (assuming rectangular)
+
+
+class Winding_s(BaseModel):  # Solution time used windings _inputs (materials and BC)
+    """
+        Level 2: Class for FiQuS CCT
+    """
+    currents: Optional[List[float]] = None  # current in the wire
+    sigmas: Optional[List[float]] = None  # electrical conductivity
+    mu_rs: Optional[List[float]] = None  # relative permeability
+
+
+class FQPL_g(BaseModel):  # Geometry related fqpls _inputs
+    """
+        Level 2: Class for FiQuS CCT
+    """
+    names: List[str] = []  # name to use in gmsh and getdp
+    fndpls: Optional[List[int]] = None  # fqpl number of divisions per length
+    fwws: Optional[List[float]] = None  # fqpl wire widths (assuming rectangular) for theta = 0 this is x dimension
+    fwhs: Optional[List[float]] = None  # fqpl wire heights (assuming rectangular) for theta = 0 this is y dimension
+    r_ins: Optional[List[float]] = None  # radiuses for inner diameter for fqpl (radial (or x direction for theta=0) for placing the fqpl
+    r_bs: Optional[List[float]] = None  # radiuses for bending the fqpl by 180 degrees
+    n_sbs: Optional[List[int]] = None  # number of 'bending segmetns' for the 180 degrees turn
+    thetas: Optional[List[float]] = None  # rotation in deg from x+ axis towards y+ axis about z axis.
+    z_starts: Optional[List[str]] = None  # which air boundary to start at. These is string with either: z_min or z_max key from the Air region.
+    z_ends: Optional[List[float]] = None  # z coordinate of loop end
+
+
+class FQPL_s(BaseModel):  # Solution time used fqpls _inputs (materials and BC)
+    """
+        Level 2: Class for FiQuS CCT
+    """
+    currents: List[float] = []  # current in the wire
+    sigmas: List[float] = []  # electrical conductivity
+    mu_rs: List[float] = []  # relative permeability
+
+
+class Former_gFiQuS(BaseModel):  # Geometry related formers _inputs
+    """
+        Level 2: Class for FiQuS CCT
+    """
+    names: Optional[List[str]] = None  # name to use in gmsh and getdp
+    r_ins: Optional[List[float]] = None  # inner radius
+    r_outs: Optional[List[float]] = None  # outer radius
+    z_mins: Optional[List[float]] = None  # extend of former  in negative z direction
+    z_maxs: Optional[List[float]] = None  # extend of former in positive z direction
+
+
+class Former_s(BaseModel):  # Solution time used formers _inputs (materials and BC)
+    """
+        Level 2: Class for FiQuS CCT
+    """
+    sigmas: Optional[List[float]] = None  # electrical conductivity
+    mu_rs: Optional[List[float]] = None  # relative permeability
+
+
+class Air_g(BaseModel):  # Geometry related air_region _inputs
+    """
+        Level 2: Class for FiQuS CCT
+    """
+    name: Optional[str] = None  # name to use in gmsh and getdp
+    sh_type: Optional[str] = None  # cylinder or cuboid are possible
+    ar: Optional[float] = None  # if box type is cuboid a is taken as a dimension, if cylinder then r is taken
+    z_min: Optional[float] = None  # extend of air region in negative z direction
+    z_max: Optional[float] = None  # extend of air region in positive z direction
+
+
+class Air_s(BaseModel):  # Solution time used air _inputs (materials and BC)
+    """
+        Level 2: Class for FiQuS CCT
+    """
+    sigma: Optional[float] = None  # electrical conductivity
+    mu_r: Optional[float] = None  # relative permeability
+
+
+class GeometryCCTFiQuS(BaseModel):
+    """
+        Level 2: Class for FiQuS CCT for FiQuS input
+    """
+    windings: Winding_gFiQuS = Winding_gFiQuS()
+    fqpls: FQPL_g = FQPL_g()
+    formers: Former_gFiQuS = Former_gFiQuS()
+    air: Air_g = Air_g()
+
+
+class MeshCCT(BaseModel):
+    """
+        Level 2: Class for FiQuS CCT
+    """
+    MaxAspectWindings: Optional[float] = None  # used in transfinite mesh_generators settings to define mesh_generators size along two longer lines of hex elements of windings
+    ThresholdSizeMin: Optional[float] = None  # sets field control of Threshold SizeMin
+    ThresholdSizeMax: Optional[float] = None  # sets field control of Threshold SizeMax
+    ThresholdDistMin: Optional[float] = None  # sets field control of Threshold DistMin
+    ThresholdDistMax: Optional[float] = None  # sets field control of Threshold DistMax
+
+
+class SolveCCT(BaseModel):
+    """
+        Level 2: Class for FiQuS CCT
+    """
+    windings: Winding_s = Winding_s()  # windings solution time _inputs
+    fqpls: FQPL_s = FQPL_s()  # fqpls solution time _inputs
+    formers: Former_s = Former_s()  # former solution time _inputs
+    air: Air_s = Air_s()  # air solution time _inputs
+    pro_template: Optional[str] = None  # file name of .pro template file
+    variables: Optional[List[str]] = None  # Name of variable to post-process by GetDP, like B for magnetic flux density
+    volumes: Optional[List[str]] = None  # Name of volume to post-process by GetDP, line Winding_1
+    file_exts: Optional[List[str]] = None  # Name of file extensions to post-process by GetDP, like .pos
+
+
+class PostprocCCTFiQuS(BaseModel):
+    """
+        Class for FiQuS CCT input file
+    """
+    windings_wwns: Optional[List[int]] = None  # wires in width direction numbers
+    windings_whns: Optional[List[int]] = None  # wires in height direction numbers
+    additional_outputs: Optional[List[str]] = None  # Name of software specific input files to prepare, like :LEDET3D
+    winding_order: Optional[List[int]] = None
+    fqpl_export_trim_tol: Optional[List[float]] = None  # this multiplier times winding extend gives 'z' coordinate above(below) which hexes are exported for LEDET, length of this list must match number of fqpls
+    variables: Optional[List[str]] = None  # Name of variable to post-process by python Gmsh API, like B for magnetic flux density
+    volumes: Optional[List[str]] = None  # Name of volume to post-process by python Gmsh API, line Winding_1
+    file_exts: Optional[List[str]] = None  # Name of file extensions o post-process by python Gmsh API, like .pos
+
+
+class CCT(BaseModel):
+    """
+        Level 1: Class for FiQuS CCT
+    """
+    type: Literal['CCT_straight'] = "CCT_straight"
+    geometry: GeometryCCTFiQuS = GeometryCCTFiQuS()
+    mesh: MeshCCT = MeshCCT()
+    solve: SolveCCT = SolveCCT()
+    postproc: PostprocCCTFiQuS = PostprocCCTFiQuS()