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

fiqus/data/DataFiQuSPancake3D.py

@@ -28,7 +28,7 @@ logger = logging.getLogger(__name__)
 NormalMaterialName = Literal[
     "Copper", "Hastelloy", "Silver", "Indium", "Stainless Steel"
 ]
-SuperconductingMaterialName = Literal["HTSSuperPower"]
+SuperconductingMaterialName = Literal["HTSSuperPower", "HTSFujikura"]
 # ======================================================================================
 # ======================================================================================
 
@@ -89,6 +89,7 @@ getdpTSATripleFunctions = {
 }
 getdpCriticalCurrentDensityFunctions = {
     "HTSSuperPower": "CFUN_HTS_JcFit_SUPERPOWER_T_B_theta",
+    "HTSFujikura": "CFUN_HTS_JcFit_Fujikura_T_B_theta",
 }
 # ======================================================================================
 # ======================================================================================
@@ -97,7 +98,6 @@ getdpCriticalCurrentDensityFunctions = {
 # Available quantities: ================================================================
 PositionRequiredQuantityName = Literal[
     "magneticField",
-    "axialComponentOfTheMagneticField",
     "magnitudeOfMagneticField",
     "currentDensity",
     "magnitudeOfCurrentDensity",
@@ -110,6 +110,7 @@ PositionRequiredQuantityName = Literal[
     "specificHeatCapacity",
     "jHTSOverjCritical",
     "criticalCurrent",
+    "axialComponentOfTheMagneticField",
     "debug",
 ]
 PositionNotRequiredQuantityName = Literal[
@@ -119,6 +120,7 @@ PositionNotRequiredQuantityName = Literal[
     "timeConstant",
     "totalResistiveHeating",
     "magneticEnergy",
+    "maximumTemperature"
 ]
 # ======================================================================================
 # ======================================================================================
@@ -142,16 +144,17 @@ EMQuantities = [
     "voltageBetweenTerminals",
     "totalResistiveHeating",
     "magneticEnergy",
+    "axialComponentOfTheMagneticField",
 ]
 ThermalQuantities = [
     "temperature",
     "heatFlux",
     "thermalConductivity",
     "specificHeatCapacity",
+    "maximumTemperature",
     "debug",
 ]
 quantityProperNames = {
-    "axialComponentOfTheMagneticField": "Axila Component of the Magnetic Field",
     "magneticField": "Magnetic Field",
     "magneticEnergy": "Magnetic Energy",
     "magnitudeOfMagenticField": "Magnitude of Magnetic Field",
@@ -172,22 +175,23 @@ quantityProperNames = {
     "debug": "Debug",
     "inductance": "Inductance",
     "timeConstant": "Time Constant",
+    "axialComponentOfTheMagneticField": "Axial Component of the Magnetic Field",
+    "maximumTemperature": "Maximum Temperature",
 }
 
 quantityUnits = {
-    "axialComponentOfTheMagneticField": "T",
     "magneticField": "T",
     "magneticEnergy": "J",
     "magnitudeOfMagneticField": "T",
-    "currentDensity": "$A/m^2$",
-    "magnitudeOfCurrentDensity": "$A/m^2$",
+    "currentDensity": "A/m^2",
+    "magnitudeOfCurrentDensity": "A/m^2",
     "resistiveHeating": "W",
     "totalResistiveHeating": "W",
     "temperature": "K",
     "currentThroughCoil": "A",
     "voltageBetweenTerminals": "V",
-    "criticalCurrentDensity": "$A/m^2$",
-    "heatFlux": "$W/m^2$",
+    "criticalCurrentDensity": "A/m^2",
+    "heatFlux": "W/m^2",
     "resistivity": "Ohm*m",
     "thermalConductivity": "W/m*K",
     "specificHeatCapacity": "J/kg*K",
@@ -196,10 +200,11 @@ quantityUnits = {
     "debug": "1",
     "inductance": "H",
     "timeConstant": "s",
+    "axialComponentOfTheMagneticField": "T",
+    "maximumTemperature": "K",
 }
 
 getdpQuantityNames = {
-    "axialComponentOfTheMagneticField": "RESULT_axialComponentOfTheMagneticField",
     "magneticField": "RESULT_magneticField",
     "magneticEnergy": "RESULT_magneticEnergy",
     "magnitudeOfMagneticField": "RESULT_magnitudeOfMagneticField",
@@ -220,10 +225,11 @@ getdpQuantityNames = {
     "debug": "RESULT_debug",
     "inductance": "RESULT_inductance",
     "timeConstant": "RESULT_timeConstant",
+    "axialComponentOfTheMagneticField": "RESULT_axialComponentOfTheMagneticField",
+    "maximumTemperature": "RESULT_maximumTemperature",
 }
 
 getdpPostOperationNames = {
-    "axialComponentOfTheMagneticField": "POSTOP_axialComponentOfTheMagneticField",
     "magneticField": "POSTOP_magneticField",
     "magneticEnergy": "RESULT_magneticEnergy",
     "magnitudeOfMagneticField": "POSTOP_magnitudeOfMagneticField",
@@ -244,6 +250,8 @@ getdpPostOperationNames = {
     "debug": "POSTOP_debug",
     "inductance": "POSTOP_inductance",
     "timeConstant": "POSTOP_timeConstant",
+    "axialComponentOfTheMagneticField": "POSTOP_axialComponentOfTheMagneticField",
+    "maximumTemperature": "POSTOP_maximumTemperature",
 }
 
 # ======================================================================================
@@ -1320,11 +1328,12 @@ class Pancake3DSolveSuperconductingMaterial(Pancake3DSolveMaterialBase):
         alias="N-Value for E-J Power Law",
         description="N-value for E-J power law.",
     )
-    IcAtTinit: PositiveFloat | str | Pancake3DSolveIcVsLength = Field(
-        alias="criticalCurrentAtInitialTemperature",
-        title="Critical Current at Initial Temperature",
+    IcAtTAndBref: PositiveFloat | str | Pancake3DSolveIcVsLength = Field(
+        alias="criticalCurrentAtReferenceTemperatureAndField",
+        title="Critical Current at Reference Temperature and Field",
         description=(
-            "Critical current at initial temperature. The critical current value will"
+            "Critical current at reference temperature and magnetic field."
+            "The critical current value will"
             " change with temperature depending on the superconductor material.\nEither"
             " the same critical current for the whole tape or the critical current with"
             " respect to the tape length can be specified. To specify the same critical"
@@ -1375,14 +1384,40 @@ class Pancake3DSolveSuperconductingMaterial(Pancake3DSolveMaterialBase):
         ),
     )
 
+    IcReferenceTemperature: PositiveFloat = Field(
+        default=77,
+        alias="criticalCurrentReferenceTemperature",
+        title="Critical Current Reference Temperature",
+        description="Critical current reference temperature in Kelvin.",
+    )
+
+    IcReferenceBmagnitude: NonNegativeFloat = Field(
+        default=0.0,
+        alias="criticalCurrentReferenceFieldMagnitude",
+        title="Critical Current Reference Magnetic Field Magnitude",
+        description="Critical current reference magnetic field magnitude in Tesla.",
+    )
+
+    IcReferenceBangle: NonNegativeFloat = Field(
+        default=90.0,
+        alias="criticalCurrentReferenceFieldAngle",
+        title="Critical Current Reference Magnetic Field Angle",
+        description= (
+            "Critical current reference magnetic field angle in degrees."
+            "0 degrees means the magnetic field is normal to the tape's wide surface"
+            "and 90 degrees means the magnetic field is parallel to the tape's wide"
+            "surface."
+        ),
+    )
+
     @computed_field
     @cached_property
     def IcValues(self) -> list[float]:
         """Return the critical current values of the material."""
-        if hasattr(self.IcAtTinit, "criticalCurrentValues"):
-            return self.IcAtTinit.criticalCurrentValues
-        elif isinstance(self.IcAtTinit, str):
-            csv_file_path = pathlib.Path(input_file_path.get()).parent / self.IcAtTinit
+        if hasattr(self.IcAtTAndBref, "criticalCurrentValues"):
+            return self.IcAtTAndBref.criticalCurrentValues
+        elif isinstance(self.IcAtTAndBref, str):
+            csv_file_path = pathlib.Path(input_file_path.get()).parent / self.IcAtTAndBref
             # return the second column:
             IcValues = list(pd.read_csv(csv_file_path, header=None).iloc[:, 1])
             for Ic in IcValues:
@@ -1392,16 +1427,16 @@ class Pancake3DSolveSuperconductingMaterial(Pancake3DSolveMaterialBase):
                     )
             return IcValues
         else:
-            return [self.IcAtTinit]
+            return [self.IcAtTAndBref]
 
     @computed_field
     @cached_property
     def lengthValues(self) -> list[float]:
         """Return the length values of the material."""
-        if hasattr(self.IcAtTinit, "lengthValues"):
-            return self.IcAtTinit.lengthValues
-        elif isinstance(self.IcAtTinit, str):
-            csv_file_path = pathlib.Path(input_file_path.get()).parent / self.IcAtTinit
+        if hasattr(self.IcAtTAndBref, "lengthValues"):
+            return self.IcAtTAndBref.lengthValues
+        elif isinstance(self.IcAtTAndBref, str):
+            csv_file_path = pathlib.Path(input_file_path.get()).parent / self.IcAtTAndBref
             # return the first column:
             lengthValues = list(pd.read_csv(csv_file_path, header=None).iloc[:, 0])
             for length in lengthValues:
@@ -1727,7 +1762,9 @@ class Pancake3DSolvePositionNotRequiredTolerance(Pancake3DSolveToleranceBase):
     # Mandatory:
     quantity: (
         Literal[
-            "solutionVector",
+            "electromagneticSolutionVector",
+            "thermalSolutionVector",
+            "coupledSolutionVector",
         ]
         | PositionNotRequiredQuantityName
     ) = Field(
@@ -1759,10 +1796,11 @@ class Pancake3DSolveSettingsWithTolerances(BaseModel):
         tolerances = [
             tolerance
             for tolerance in self.tolerances
-            if "solutionVector" not in tolerance.quantity
+            if "SolutionVector" not in tolerance.quantity
         ]
         return tolerances
 
+
     @computed_field
     @cached_property
     def systemTolerances(self) -> list[Pancake3DSolveTolerance]:
@@ -1770,7 +1808,7 @@ class Pancake3DSolveSettingsWithTolerances(BaseModel):
         tolerances = [
             tolerance
             for tolerance in self.tolerances
-            if "solutionVector" in tolerance.quantity
+            if "SolutionVector" in tolerance.quantity
         ]
         return tolerances
 
@@ -1993,9 +2031,6 @@ class Pancake3DSolveTimeFixed(Pancake3DSolveTimeBase):
                 )
             ):
                 raise ValueError("Time interval must be a multiple of the time step!")
-            
-
-        return model
 
 
 Pancake3DSolveTime = Annotated[
@@ -2093,7 +2128,7 @@ class Pancake3DSolveLocalDefect(BaseModel):
                 " times!"
             )
         
-        return startTime
+        return start_time
 
     @field_validator("endTurn")
     @classmethod
@@ -2126,7 +2161,7 @@ class Pancake3DSolveLocalDefect(BaseModel):
                     "whickPancakeCoil (pancake coil number) should be given if there"
                     " are more than one pancake coil!"
                 )
-            
+
         return whichPancakeCoil
 
     @computed_field
@@ -2145,9 +2180,6 @@ class Pancake3DSolveLocalDefect(BaseModel):
         """Return the z-coordinate of the bottom of the pancake coil."""
         geometry = geometry_input.get()
 
-        if not self.whichPancakeCoil:
-            self.whichPancakeCoil = 1
-
         zBottom = -(
             geometry["numberOfPancakes"] * geometry["winding"]["height"]
             + (geometry["numberOfPancakes"] - 1)
@@ -2182,7 +2214,7 @@ class Pancake3DSolveLocalDefects(BaseModel):
             else:
                 windingMaterials = []
 
-            superconducting_material_is_used = "HTSSuperPower" in windingMaterials
+            superconducting_material_is_used = "HTSSuperPower" in windingMaterials or "HTSFujikura" in windingMaterials
 
             if not superconducting_material_is_used:
                 raise ValueError(
@@ -2221,7 +2253,7 @@ class Pancake3DSolveQuantityBase(BaseModel):
 class Pancake3DSolveSaveQuantity(Pancake3DSolveQuantityBase):
     # Optionals:
     timesToBeSaved: list[float] = Field(
-        default=[],
+        default=None,
         title="Times to be Saved",
         description=(
             "List of times that wanted to be saved. If not given, all the time steps"
@@ -2247,8 +2279,6 @@ class Pancake3DSolveSaveQuantity(Pancake3DSolveQuantityBase):
                 raise ValueError(
                     "Times to be saved should be between the start and end times!"
                 )
-            
-        return timesToBeSaved
 
 
 # ======================================================================================
@@ -2579,6 +2609,12 @@ class Pancake3DPostprocessMagneticFieldOnPlane(BaseModel):
 
 
 class Pancake3DGeometry(BaseModel):
+    conductorWrite: bool = Field(
+        default=False,
+        title="Flag:to Write the Conductor File",
+        description="To Write the Conductor File"
+    )
+
     # Mandatory:
     N: PositiveInt = Field(
         ge=1,
@@ -2620,6 +2656,7 @@ class Pancake3DGeometry(BaseModel):
     # Optionals:
     dimTol: PositiveFloat = Field(
         default=1e-8,
+        gt=1e-5,
         alias="dimensionTolerance",
         description="dimension tolerance (CAD related, not physical)",
     )
@@ -2934,6 +2971,79 @@ class Pancake3DSolve(BaseModel):
 
         return systemsOfEquationsType
 
+    @model_validator(mode="before")
+    @classmethod
+    def check_nls_system_tolerances(cls, model: "Pancake3DSolve"):
+
+        if not "nonlinearSolver" in model or not "tolerances" in model["nonlinearSolver"]:
+            return model
+
+        all_tolerances = model["nonlinearSolver"]["tolerances"]
+
+        for tolerance in all_tolerances:
+            if tolerance["quantity"] == "electromagneticSolutionVector":
+                if model["type"] == "thermal" or model["type"] == "stronglyCoupled":
+                    raise ValueError(
+                        "Nonlinear iteration:"
+                        "The 'electromagneticSolutionVector' tolerance can be used only"
+                        " in 'electromagnetic' or 'weaklyCoupled' simulations."
+                    )
+
+            if tolerance["quantity"] == "thermalSolutionVector":
+                if model["type"] == "electromagnetic" or model["type"] == "stronglyCoupled":
+                    raise ValueError(
+                        "Nonlinear iteration:"
+                        "The 'thermalSolutionVector' tolerance can be used only"
+                        " in 'thermal' or 'weaklyCoupled' simulations."
+                    )
+
+            if tolerance["quantity"] == "coupledSolutionVector":
+                if model["type"] == "electromagnetic" or model["type"] == "thermal" or model["type"] == "weaklyCoupled":
+                    raise ValueError(
+                        "Nonlinear iteration:"
+                        "The 'coupledSolutionVector' tolerance can be used only"
+                        " in 'stronglyCoupled' simulations."
+                    )
+        return model
+
+    @model_validator(mode="before")
+    @classmethod
+    def check_adaptive_system_tolerances(cls, model: "Pancake3DSolve"):
+
+        if model["time"]["timeSteppingType"] == "fixed":
+            return model
+
+        all_tolerances = model["time"]["adaptiveSteppingSettings"]["tolerances"]
+
+        for tolerance in all_tolerances:
+            if tolerance["quantity"] == "electromagneticSolutionVector":
+                if model["type"] == "thermal" or model["type"] == "stronglyCoupled":
+                    raise ValueError(
+                        "Adaptive time stepping:"
+                        "The 'electromagneticSolutionVector' tolerance can be used only"
+                        " in 'electromagnetic' or 'weaklyCoupled' simulations."
+                    )
+
+            if tolerance["quantity"] == "thermalSolutionVector":
+                if model["type"] == "electromagnetic" or model["type"] == "stronglyCoupled":
+                    raise ValueError(
+                        "Adaptive time stepping:"
+                        "The 'thermalSolutionVector' tolerance can be used only"
+                        " in 'thermal' or 'weaklyCoupled' simulations."
+                    )
+
+            if tolerance["quantity"] == "coupledSolutionVector":
+                if model["type"] == "electromagnetic" or model["type"] == "thermal" or model["type"] == "weaklyCoupled":
+                    raise ValueError(
+                        "Adaptive time stepping:"
+                        "The 'coupledSolutionVector' tolerance can be used only"
+                        " in 'stronglyCoupled' simulations."
+                    )
+        return model
+
+    # TODO: add model_validator to check postprocess quantities are available for this solve type (e.g. thermal quantities cannot be chosen for electromagnetic solve)
+
+    # TODO: add model_validator to check convergence quantities are available for this solve type (e.g. thermal quantities cannot be chosen for electromagnetic solve)
 
 class Pancake3DPostprocess(BaseModel):
     """
@@ -2947,7 +3057,7 @@ class Pancake3DPostprocess(BaseModel):
         description="Values can be plotted with respect to time.",
     )
 
-    magneticFieldOnCutPlane: Optional[Pancake3DPostprocessMagneticFieldOnPlane] = Field(
+    magneticFieldOnCutPlane: Pancake3DPostprocessMagneticFieldOnPlane = Field(
         default=None,
         title="Magnetic Field on a Cut Plane",
         description=(

fiqus/data/RegionsModelFiQuS.py

@@ -183,8 +183,10 @@ class ThinShell(BaseModel):
 
 
 class RegionsModel(BaseModel):
-    powered: Powered = Powered()
-    induced: Induced = Induced()
+    # powered: Powered = Powered()
+    # induced: Induced = Induced()
+    powered: Dict[str, Powered] = {}
+    induced: Dict[str, Induced] = {}
     insulator: Insulator = Insulator()
     iron: Iron = Iron()
     air: Air = Air()

fiqus/geom_generators/GeometryCCT.py

@@ -547,39 +547,41 @@ class Generate_BREPs:
         lrt = 3000000  # line region tag start
         # -------- powered ----------
         # volumes
-        cctrm.powered.vol.names = [name + self.transl_dict['vol'] for name in self.cctdm.geometry.windings.names + self.cctdm.geometry.fqpls.names]
-        cctrm.powered.vol.currents = self.cctdm.solve.windings.currents + self.cctdm.solve.fqpls.currents
-        cctrm.powered.vol.sigmas = self.cctdm.solve.windings.sigmas + self.cctdm.solve.fqpls.sigmas
-        cctrm.powered.vol.mu_rs = self.cctdm.solve.windings.mu_rs + self.cctdm.solve.fqpls.mu_rs
+        cctrm.powered['cct'] = Reg_Mod_FiQ.Powered()
+        cctrm.powered['cct'].vol.names = [name + self.transl_dict['vol'] for name in self.cctdm.geometry.windings.names + self.cctdm.geometry.fqpls.names]
+        cctrm.powered['cct'].vol.currents = self.cctdm.solve.windings.currents + self.cctdm.solve.fqpls.currents
+        cctrm.powered['cct'].vol.sigmas = self.cctdm.solve.windings.sigmas + self.cctdm.solve.fqpls.sigmas
+        cctrm.powered['cct'].vol.mu_rs = self.cctdm.solve.windings.mu_rs + self.cctdm.solve.fqpls.mu_rs
         reg = []
         for _ in self.cctdm.geometry.windings.names + self.cctdm.geometry.fqpls.names:
             reg.append(vrt)
             vrt += 1
-        cctrm.powered.vol.numbers = reg
+        cctrm.powered['cct'].vol.numbers = reg
         # surfaces
-        cctrm.powered.surf_in.names = [name + self.transl_dict['surf_in'] for name in self.cctdm.geometry.windings.names + self.cctdm.geometry.fqpls.names]
-        cctrm.powered.surf_out.names = [name + self.transl_dict['surf_out'] for name in self.cctdm.geometry.windings.names + self.cctdm.geometry.fqpls.names]
+        cctrm.powered['cct'].surf_in.names = [name + self.transl_dict['surf_in'] for name in self.cctdm.geometry.windings.names + self.cctdm.geometry.fqpls.names]
+        cctrm.powered['cct'].surf_out.names = [name + self.transl_dict['surf_out'] for name in self.cctdm.geometry.windings.names + self.cctdm.geometry.fqpls.names]
         reg = []
         for _ in self.cctdm.geometry.windings.names + self.cctdm.geometry.fqpls.names:
             reg.append(srt)
             srt += 1
-        cctrm.powered.surf_in.numbers = reg
+        cctrm.powered['cct'].surf_in.numbers = reg
         reg = []
         for _ in self.cctdm.geometry.windings.names + self.cctdm.geometry.fqpls.names:
             reg.append(srt)
             srt += 1
-        cctrm.powered.surf_out.numbers = reg
+        cctrm.powered['cct'].surf_out.numbers = reg
 
         # -------- induced ----------
         # volumes
-        cctrm.induced.vol.names = [name + self.transl_dict['vol'] for name in self.cctdm.geometry.formers.names]
-        cctrm.induced.vol.sigmas = self.cctdm.solve.formers.sigmas
-        cctrm.induced.vol.mu_rs = self.cctdm.solve.formers.mu_rs
+        cctrm.induced['cct'] = Reg_Mod_FiQ.Induced()
+        cctrm.induced['cct'].vol.names = [name + self.transl_dict['vol'] for name in self.cctdm.geometry.formers.names]
+        cctrm.induced['cct'].vol.sigmas = self.cctdm.solve.formers.sigmas
+        cctrm.induced['cct'].vol.mu_rs = self.cctdm.solve.formers.mu_rs
         reg = []
         for _ in self.cctdm.geometry.formers.names:
             reg.append(vrt)
             vrt += 1
-        cctrm.induced.vol.numbers = reg
+        cctrm.induced['cct'].vol.numbers = reg
 
         # -------- air ----------
         # volumes
@@ -602,19 +604,19 @@ class Generate_BREPs:
 
         # --------- cuts -------
         # these need to be done at the end with the highest surface tags
-        cctrm.powered.cochain.names = [name + self.transl_dict['cochain'] for name in self.cctdm.geometry.windings.names + self.cctdm.geometry.fqpls.names]
+        cctrm.powered['cct'].cochain.names = [name + self.transl_dict['cochain'] for name in self.cctdm.geometry.windings.names + self.cctdm.geometry.fqpls.names]
         reg = []
         for _ in self.cctdm.geometry.windings.names + self.cctdm.geometry.fqpls.names:
             reg.append(lrt)
             lrt += 1
-        cctrm.powered.cochain.numbers = reg
+        cctrm.powered['cct'].cochain.numbers = reg
         # induced cuts
-        cctrm.induced.cochain.names = [name + self.transl_dict['cochain'] for name in self.cctdm.geometry.formers.names]
+        cctrm.induced['cct'].cochain.names = [name + self.transl_dict['cochain'] for name in self.cctdm.geometry.formers.names]
         reg = []
         for _ in self.cctdm.geometry.formers.names:
             reg.append(lrt)
             lrt += 1
-        cctrm.induced.cochain.numbers = reg
+        cctrm.induced['cct'].cochain.numbers = reg
 
         uff.write_data_to_yaml(os.path.join(self.model_folder, f'{self.cctwi.magnet_name}.regions'), cctrm.dict())