fiqus 2024.5.2__py3-none-any.whl → 2024.7.0__py3-none-any.whl

fiqus/MainFiQuS.py

@@ -2,6 +2,11 @@ import os
 import getpass
 import time
 import argparse
+import pathlib
+import sys
+
+FiQuS_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+sys.path.insert(0, FiQuS_path)
 
 from fiqus.utils.Utils import initialize_logger
 from fiqus.utils.Utils import FilesAndFolders as Util
@@ -10,6 +15,7 @@ from fiqus.data import DataFiQuS as dF
 from fiqus.mains.MainMultipole import MainMultipole
 from fiqus.mains.MainCCT import MainCCT
 from fiqus.mains.MainPancake3D import MainPancake3D
+from fiqus.mains.MainConductorAC_Strand import MainConductorAC_Strand
 
 
 class MainFiQuS:
@@ -68,6 +74,8 @@ class MainFiQuS:
 
         elif self.fdm.magnet.type == "Pancake3D":
             self.main_magnet = MainPancake3D(fdm=self.fdm, verbose=verbose)
+        elif self.fdm.magnet.type == "CACStrand":
+            self.main_magnet = MainConductorAC_Strand(fdm=self.fdm, inputs_folder_path=pathlib.Path(input_file_path).parent, outputs_folder_path=model_folder, verbose=verbose)
         else:
             raise ValueError(
                 f"FiQuS does not support magnet type: {self.fdm.magnet.type}!"
@@ -251,7 +259,7 @@ class MainFiQuS:
             self.main_magnet.generate_geometry()
             self.main_magnet.pre_process()
             self.main_magnet.load_geometry()
-            for key, value in self.main_magnet.mesh().items():
+            for key, value in self.main_magnet.mesh(gui=self.main_magnet.fdm.run.launch_gui).items():
                 self.summary[key] = value
         elif (
             self.fdm.run.type == "mesh_and_solve_with_post_process_python"
@@ -310,6 +318,8 @@ class MainFiQuS:
                 self.summary[key] = value
         elif self.fdm.run.type == "plot_python":
             self.main_magnet.plot_python()
+        elif self.fdm.run.type == "batch_post_process_python":
+            self.main_magnet.batch_post_process_python()
         os.chdir(self.start_folder)
 
 
@@ -320,18 +330,18 @@ if __name__ == "__main__":
         epilog="steam-team@cern.ch",
     )
     parser.add_argument(
-        "--in",
         dest="full_path_input",
         type=str,
         help="Full path to FiQuS input yaml file",
     )
     parser.add_argument(
-        "--out", dest="output_path", type=str, help="Full path to FiQuS output folder"
+        "--output", '-o', dest="output_path", type=str, help="Full path to FiQuS output folder"
     )
     parser.add_argument(
-        "--getdp", dest="GetDP_path", type=str, help="Full path to GetDP executable"
+        "--getdp", '-g', dest="GetDP_path", type=str, help="Full path to GetDP executable"
     )
-    args = parser.parse_args()
+    args, unknown = parser.parse_known_args()
+    # args = parser.parse_args()
     # print(args.full_path_input)
     # print(args.output_path)
     # print(args.GetDP_path)

fiqus/data/DataConductor.py

@@ -0,0 +1,301 @@
+from pydantic import BaseModel, Field
+from typing import Union, Literal, Optional
+
+# ------------------- Jc fits ---------------------------#
+class ConstantJc(BaseModel):
+    """
+    Level 3: Class for setting constant Jc
+    """
+
+    type: Literal["Constant Jc"]
+    Jc_constant: Optional[float] = None  # [A/m^2]
+
+
+class Ic_A_NbTi(BaseModel):
+    """
+    Level 3: Class for setting IcNbTi fit
+    """
+
+    type: Literal["Ic_A_NbTi"]
+    Jc_5T_4_2K: Optional[float] = None  # [A/m^2]
+
+
+class Bottura(BaseModel):
+    """
+    Level 3: Class for setting Bottura fit
+    """
+
+    type: Literal["Bottura"]
+    Tc0_Bottura: Optional[float] = None  # [K]
+    Bc20_Bottura: Optional[float] = None  # [T]
+    Jc_ref_Bottura: Optional[float] = None  # [A/m^2]
+    C0_Bottura: Optional[float] = None  # [-]
+    alpha_Bottura: Optional[float] = None  # [-]
+    beta_Bottura: Optional[float] = None  # [-]
+    gamma_Bottura: Optional[float] = None  # [-]
+
+
+class CUDI1(BaseModel):
+    """
+    Level 3: Class for Nb-Ti fit based on "Fit 1" in CUDI manual
+    """
+
+    type: Literal["CUDI1"]
+    Tc0_CUDI1: Optional[float] = None  # [K]
+    Bc20_CUDI1: Optional[float] = None  # [T]
+    C1_CUDI1: Optional[float] = None  # [A]
+    C2_CUDI1: Optional[float] = None  # [A/T]
+
+
+class CUDI3(BaseModel):
+    """
+    Level 3: Class for Nb-Ti fit based on "Fit 3" in CUDI manual
+    """
+
+    type: Literal["CUDI3"]
+    Tc0_CUDI3: Optional[float] = None  # [K]
+    Bc20_CUDI3: Optional[float] = None  # [T]
+    c1_CUDI3: Optional[float] = None  # [-]
+    c2_CUDI3: Optional[float] = None  # [-]
+    c3_CUDI3: Optional[float] = None  # [-]
+    c4_CUDI3: Optional[float] = None  # [-]
+    c5_CUDI3: Optional[float] = None  # [-]
+    c6_CUDI3: Optional[float] = None  # [-]
+
+
+class Summers(BaseModel):
+    """
+    Level 3: Class for cable Summer's Nb3Sn fit
+    """
+
+    type: Literal["Summers"]
+    Tc0_Summers: Optional[float] = None  # [K]
+    Bc20_Summers: Optional[float] = None  # [T]
+    Jc0_Summers: Optional[float] = None  # [A*T^0.5/m^2]
+
+
+class Bordini(BaseModel):
+    """
+    Level 3: Class for cable Bordini's Nb3Sn fit
+    """
+
+    type: Literal["Bordini"]
+    Tc0_Bordini: Optional[float] = None  # [K]
+    Bc20_Bordini: Optional[float] = None  # [T]
+    C0_Bordini: Optional[float] = None  # [A*T/m^2]
+    alpha_Bordini: Optional[float] = None  # [-]
+
+
+class BSCCO_2212_LBNL(BaseModel):
+    """
+    Level 3: Class for cable Bi-2212 fit developed in LBNL
+    """
+
+    # only ad-hoc fit [T. Shen, D. Davis, E. Ravaioli with LBNL, Berkeley, CA]
+    type: Literal["BSCCO_2212_LBNL"]
+    f_scaling_Jc_BSCCO2212: Optional[float] = None  # [-] used for the ad-hoc fit
+
+
+# ------------------- Cable types ---------------------------#
+class Mono(BaseModel):
+    """
+    Mono cable type: This is basically type of cable consisting of one strand - not really a cable
+    """
+
+    type: Literal["Mono"]
+    bare_cable_width: Optional[float] = None
+    bare_cable_height_low: Optional[float] = None
+    bare_cable_height_high: Optional[float] = None
+    bare_cable_height_mean: Optional[float] = None
+    th_insulation_along_width: Optional[float] = None
+    th_insulation_along_height: Optional[float] = None
+    # Fractions given with respect to the insulated conductor
+    f_superconductor: Optional[float] = None
+    f_stabilizer: Optional[float] = None  # (related to CuFraction in ProteCCT)
+    f_insulation: Optional[float] = None
+    f_inner_voids: Optional[float] = None
+    f_outer_voids: Optional[float] = None
+    # Available materials depend on the component and on the selected program
+    material_insulation: Optional[str] = None
+    material_inner_voids: Optional[str] = None
+    material_outer_voids: Optional[str] = None
+
+
+class Rutherford(BaseModel):
+    """
+    Rutherford cable type: for example LHC MB magnet cable
+    """
+
+    type: Literal["Rutherford"]
+    n_strands: Optional[int] = None
+    n_strand_layers: Optional[int] = None
+    n_strands_per_layers: Optional[int] = None
+    bare_cable_width: Optional[float] = None
+    bare_cable_height_low: Optional[float] = None
+    bare_cable_height_high: Optional[float] = None
+    bare_cable_height_mean: Optional[float] = None
+    th_insulation_along_width: Optional[float] = None
+    th_insulation_along_height: Optional[float] = None
+    width_core: Optional[float] = None
+    height_core: Optional[float] = None
+    strand_twist_pitch: Optional[float] = None
+    strand_twist_pitch_angle: Optional[float] = None
+    Rc: Optional[float] = None
+    Ra: Optional[float] = None
+    # Fractions given with respect to the insulated conductor
+    f_superconductor: Optional[float] = None
+    f_stabilizer: Optional[float] = None  # (related to CuFraction in ProteCCT)
+    f_insulation: Optional[float] = None
+    f_inner_voids: Optional[float] = None
+    f_outer_voids: Optional[float] = None
+    f_core: Optional[float] = None
+    # Available materials depend on the component and on the selected program
+    material_insulation: Optional[str] = None
+    material_inner_voids: Optional[str] = None
+    material_outer_voids: Optional[str] = None
+    material_core: Optional[str] = None
+
+
+class Ribbon(BaseModel):
+    """
+    Mono cable type: This is basically type of cable consisting of one strand - not really a cable
+    """
+
+    type: Literal["Ribbon"]
+    n_strands: Optional[int] = (
+        None  # This defines the number of "strands" in the ribbon cable, which are physically glued but electrically in series
+    )
+    bare_cable_width: Optional[float] = None
+    bare_cable_height_low: Optional[float] = None
+    bare_cable_height_high: Optional[float] = None
+    bare_cable_height_mean: Optional[float] = None
+    th_insulation_along_width: Optional[float] = (
+        None  # This defines the thickness of the insulation around each strand (DIFFERENT FROM ROXIE CADATA FILE)
+    )
+    th_insulation_along_height: Optional[float] = (
+        None  # This defines the thickness of the insulation around each strand (DIFFERENT FROM ROXIE CADATA FILE)
+    )
+    # Fractions given with respect to the insulated conductor
+    f_superconductor: Optional[float] = None
+    f_stabilizer: Optional[float] = None  # (related to CuFraction in ProteCCT)
+    f_insulation: Optional[float] = None
+    f_inner_voids: Optional[float] = None
+    f_outer_voids: Optional[float] = None
+    f_core: Optional[float] = None
+    # Available materials depend on the component and on the selected program
+    material_insulation: Optional[str] = None
+    material_inner_voids: Optional[str] = None
+    material_outer_voids: Optional[str] = None
+    material_core: Optional[str] = None
+
+
+# ------------------- Conductors ---------------------------#
+
+# class MaterialSuperconductor(BaseModel):
+#     """
+#     Level 3: Class for strand superconductor material parameters
+#     """
+#     material: Optional[str] = Field(default=None, description="Material of the superconductor. E.g. NbTi, Nb3Sn, etc.")
+#     n_value: Optional[float] = Field(default=None, description="n value of the superconductor (for power law fit).")
+#     ec: Optional[float] = Field(default=None, description="Critical electric field of the superconductor.")
+#     Cv_material: Optional[Union[str, float]] = Field(default=None, description="Material function for specific heat of the superconductor.")
+
+# class MaterialStabilizer(BaseModel):
+#     """
+#     Level 3: Class for strand stabilizer material parameters
+#     """
+
+#     rho_material: Optional[Union[str, float]] = Field(default=None, description="Material function for resistivity of the stabilizer. Constant resistivity can be given as float.")
+#     RRR: Optional[float] = Field(default=None, description="Residual resistivity ratio of the stabilizer.")
+#     T_ref_RRR_high: Optional[float] = Field(default=None, description="Upper reference temperature for RRR measurements.")
+#     T_ref_RRR_low: Optional[float] = Field(default=None, description="Lower reference temperature for RRR measurements.")
+#     k_material: Optional[Union[str, float]] = Field(default=None, description="Thermal conductivity of the stabilizer.")
+#     Cv_material: Optional[Union[str, float]] = Field(default=None, description="Material function for specific heat of the stabilizer.")
+
+
+class Round(BaseModel):
+    """
+    Level 2: Class for strand parameters
+    """
+
+    type: Literal["Round"]
+    fil_twist_pitch: Optional[float] = None # Strand twist pitch
+    diameter: Optional[float] = None  # ds_inGroup (LEDET), DConductor (BBQ), DStrand (ProteCCT)
+    diameter_core:  Optional[float] = None  # dcore_inGroup (LEDET)
+    diameter_filamentary: Optional[float] = None  # dfilamentary_inGroup (LEDET)
+    filament_diameter: Optional[float] = None  # df_inGroup (LEDET)
+    number_of_filaments: Optional[int] = None  # nf_inGroup (LEDET)
+    f_Rho_effective: Optional[float] = None
+    Cu_noCu_in_strand: Optional[float] = None
+
+    # -- Superconductor parameters -- #
+    material_superconductor: Optional[str] = Field(default=None, description="Material of the superconductor. E.g. Nb-Ti, Nb3Sn, etc.")
+    n_value_superconductor: Optional[float] = Field(default=None, description="n value of the superconductor (for power law fit).")
+    ec_superconductor: Optional[float] = Field(default=None, description="Critical electric field of the superconductor.")
+    k_material_superconductor: Optional[Union[str, float]] = Field(default=None, description="Thermal conductivity of the superconductor.")
+    Cv_material_superconductor: Optional[Union[str, float]] = Field(default=None, description="Material function for specific heat of the superconductor.")
+    # -- Stabilizer parameters -- #
+    material_stabilizer: Optional[str] = Field(default=None, description="Material of the stabilizer.")
+    rho_material_stabilizer: Optional[Union[str, float]] = Field(default=None, description="Material function for resistivity of the stabilizer. Constant resistivity can be given as float.")
+    RRR: Optional[float] = Field(default=None, description="Residual resistivity ratio of the stabilizer.")
+    T_ref_RRR_high: Optional[float] = Field(default=None, description="Upper reference temperature for RRR measurements.")
+    T_ref_RRR_low: Optional[float] = Field(default=None, description="Lower reference temperature for RRR measurements.")
+    k_material_stabilizer: Optional[Union[str, float]] = Field(default=None, description="Thermal conductivity of the stabilizer.")
+    Cv_material_stabilizer: Optional[Union[str, float]] = Field(default=None, description="Material function for specific heat of the stabilizer.")
+
+    # superconductor: MaterialSuperconductor = MaterialSuperconductor()
+    # stabilizer: MaterialStabilizer = MaterialStabilizer()
+
+
+class Rectangular(BaseModel):
+    """
+    Level 2: Class for strand parameters
+    """
+
+    type: Literal["Rectangular"]
+    bare_width: Optional[float] = None
+    bare_height: Optional[float] = None
+    Cu_noCu_in_strand: Optional[float] = None
+    filament_diameter: Optional[float] = None  # df_inGroup (LEDET)
+    f_Rho_effective: Optional[float] = None
+    fil_twist_pitch: Optional[float] = None
+    bare_corner_radius: Optional[float] = None
+
+    # -- Superconductor parameters -- #
+    material_superconductor: Optional[str] = Field(default=None, description="Material of the superconductor. E.g. NbTi, Nb3Sn, etc.")
+    n_value_superconductor: Optional[float] = Field(default=None, description="n value of the superconductor (for power law fit).")
+    ec_superconductor: Optional[float] = Field(default=None, description="Critical electric field of the superconductor.")
+    k_material_superconductor: Optional[Union[str, float]] = Field(default=None, description="Thermal conductivity of the superconductor.")
+    Cv_material_superconductor: Optional[Union[str, float]] = Field(default=None, description="Material function for specific heat of the superconductor.")
+    # -- Stabilizer parameters -- #
+    material_stabilizer: Optional[str] = Field(default=None, description="Material of the stabilizer.")
+    rho_material_stabilizer: Optional[Union[str, float]] = Field(default=None, description="Material function for resistivity of the stabilizer. Constant resistivity can be given as float.")
+    RRR: Optional[float] = Field(default=None, description="Residual resistivity ratio of the stabilizer.")
+    T_ref_RRR_high: Optional[float] = Field(default=None, description="Upper reference temperature for RRR measurements.")
+    T_ref_RRR_low: Optional[float] = Field(default=None, description="Lower reference temperature for RRR measurements.")
+    k_material_stabilizer: Optional[Union[str, float]] = Field(default=None, description="Thermal conductivity of the stabilizer.")
+    Cv_material_stabilizer: Optional[Union[str, float]] = Field(default=None, description="Material function for specific heat of the stabilizer.")
+
+    # superconductor: MaterialSuperconductor = MaterialSuperconductor()
+    # stabilizer: MaterialStabilizer = MaterialStabilizer()
+    
+
+
+# ------------------- Conductors ---------------------------#
+
+
+class Conductor(BaseModel):
+    """
+    Level 1: Class for conductor parameters
+    """
+
+    version: Optional[str] = None
+    case: Optional[str] = None
+    state: Optional[str] = None
+    cable: Union[Rutherford, Mono, Ribbon] = {
+        "type": "Rutherford"
+    }  # TODO: Busbar, Rope, Roebel, CORC, TSTC, CICC
+    strand: Union[Round, Rectangular] = {"type": "Round"}  # TODO: Tape, WIC
+    Jc_fit: Union[ConstantJc, Bottura, CUDI1, CUDI3, Summers, Bordini, BSCCO_2212_LBNL, Ic_A_NbTi] = {
+        "type": "CUDI1"
+    }  # TODO: CUDI other numbers? , Roxie?

fiqus/data/DataFiQuS.py

@@ -1,9 +1,11 @@
 from pydantic import BaseModel, Field
 from typing import (Dict, List, Union, Literal, Optional)
+from fiqus.data.DataConductor import Conductor
 from fiqus.data.DataRoxieParser import RoxieData
 from fiqus.data.DataFiQuSMultipole import MPDM
 from fiqus.data.DataFiQuSCCT import CCTDM
 from fiqus.data.DataFiQuSPancake3D import Pancake3D
+from fiqus.data.DataFiQuSConductorAC_Strand import CACStrand
 
 
 class MonoFiQuS(BaseModel):
@@ -75,7 +77,7 @@ class RunFiQuS(BaseModel):
     """
         Class for FiQuS run
     """
-    type: Literal["start_from_yaml", "mesh_only", "geometry_only", "geometry_and_mesh", "pre_process_only", "mesh_and_solve_with_post_process_python", "solve_with_post_process_python", "solve_only", "post_process_getdp_only", "post_process_python_only", "post_process"] = Field(default="start_from_yaml", title="Run Type of FiQuS", description="FiQuS allows you to run the model in different ways. The run type can be specified here. For example, you can just create the geometry and mesh or just solve the model with previous mesh, etc.")
+    type: Literal["start_from_yaml", "mesh_only", "geometry_only", "geometry_and_mesh", "pre_process_only", "mesh_and_solve_with_post_process_python", "solve_with_post_process_python", "solve_only", "post_process_getdp_only", "post_process_python_only", "post_process", "batch_post_process_python"] = Field(default="start_from_yaml", title="Run Type of FiQuS", description="FiQuS allows you to run the model in different ways. The run type can be specified here. For example, you can just create the geometry and mesh or just solve the model with previous mesh, etc.")
     geometry: Optional[Union[str, int]] = Field(default=None, title="Geometry Folder Key", description="This key will be appended to the geometry folder.")
     mesh: Optional[Union[str, int]] = Field(default=None, title="Mesh Folder Key", description="This key will be appended to the mesh folder.")
     solution: Optional[Union[str, int]] = Field(default=None, title="Solution Folder Key", description="This key will be appended to the solution folder.")
@@ -176,5 +178,6 @@ class FDM(BaseModel):
     """
     general: GeneralFiQuS = GeneralFiQuS()
     run: RunFiQuS = RunFiQuS()
-    magnet: Union[MPDM, CCTDM, Pancake3D] = Field(default=MPDM(), discriminator='type')
+    magnet: Union[MPDM, CCTDM, Pancake3D, CACStrand] = Field(default=MPDM(), discriminator='type')
     power_supply: PowerSupply = PowerSupply()
+    conductors: Dict[Optional[str], Conductor] = {}

fiqus/data/DataFiQuSConductor.py

@@ -0,0 +1,84 @@
+from pydantic import BaseModel, Field, ConfigDict
+from typing import Dict, List, Optional
+
+
+class Area(BaseModel):
+    Material: Optional[str] = Field(
+        None, description="Material of the area", examples=["Cu", "NbTi", "Nb3Sn"]
+    )
+    Boundary: List[int] = (
+        []
+    )  # List of curves that define the closed boundary of the area
+    InnerBoundaries: List[List[int]] = (
+        []
+    )  # List of lists of curves that define the closed boundaries of the holes in the area
+    BoundaryThickness: Optional[Optional[float]] = None  # Thickness of the boundary
+    BoundaryMaterial: Optional[str] = Field(
+        None,
+        description="Material of the boundary",
+        examples=["steel", "Cu", "direct", "etc."],
+    )
+    Layer: Optional[int] = Field(
+        None,
+        description="Filaments in the strand-model must be assigned to a layer. A layer is a collection of all filaments with the same radius from the center.",
+    )
+    LayerIndex: Optional[int] = Field(
+        None, description="Index of the filament in the layer."
+    )
+
+# ========== GEOMETRY YAML CLASSES ========== #
+class Material(BaseModel):
+    Type: Optional[str] = Field(
+        None, description="Type of material", examples=["NbTi", "Nb3Sn", "Cu"]
+    )
+    RRR: Optional[float] = Field(None, description="Residual resistivity ratio")
+    T_ref_RRR_high: Optional[float] = Field(
+        None, description="High reference temperature for RRR"
+    )
+    T_ref_RRR_low: Optional[float] = Field(
+        None, description="Low reference temperature for RRR"
+    )
+    model_config = ConfigDict(frozen=True)
+
+
+class Point(BaseModel):
+    Coordinates: List[float] = []
+
+
+class Curve(BaseModel):
+    Type: str
+    Points: List[int] = []
+
+    Contact: Optional[str] = Field(
+        None,
+        description="If the curve is a contact layer between two surfaces this represents the contact type of strands",
+        examples=["crossing", "parallel"],
+    )
+    Thickness: Optional[float] = Field(
+        None, description="Thickness of the contact layer"
+    )
+    Material: Optional[str] = Field(
+        None,
+        description="Material of the contact layer",
+        examples=["steel", "direct", "Cu"],
+    )
+
+
+
+
+class GeometryParameters(BaseModel):
+    Points: Dict[int, Point] = {}
+    Curves: Dict[int, Curve] = {}
+    Areas: Dict[int, Area] = {}
+
+
+class SolutionParameters(BaseModel):
+    Materials: Dict[str, Material] = {}
+    Surfaces_excluded_from_TI: List[int] = []
+
+
+class Conductor(BaseModel):
+    Geometry: GeometryParameters = GeometryParameters()
+    Solution: SolutionParameters = SolutionParameters()
+
+