DataConductor

Auto-generated documentation for DataConductor.

Classes

Conductor
Copper_thickness
Silver_thickness

Conductor

Module: DataConductor

Description: Level 1: Class for conductor parameters

Fields

Field	Type	Default
`version`	`Optional[str]`	`null`
`case`	`Optional[str]`	`null`
`state`	`Optional[str]`	`null`
`cable`	`Rutherford` \| `Mono` \| `Ribbon` \| `TSTC`	`{...}` (1 fields)
`strand`	`Round` \| `Rectangular` \| `CC` \| `Homogenized`	`{...}` (1 fields)
`Jc_fit`	`ConstantJc` \| `Bottura` \| `CUDI1` \| `CUDI3` \| `Summers` \| `Bordini` \| `Nb3Sn_HFM` \| `BSCCO_2212_LBNL` \| `Ic_A_NbTi` \| `ProDefined` \| `Succi_fixed` \| `Fujikura`	`{...}` (1 fields)

Nested Models

BSCCO_2212_LBNL

Description: Level 3: Class for cable Bi-2212 fit developed in LBNL

Field	Type	Default	Description
`type`	`str`	Required
`f_scaling_Jc_BSCCO2212`	`Optional[float]`	`null`

Bordini

Description: Level 3: Class for cable Bordini's Nb3Sn fit

Field	Type	Default
`type`	`str`	Required
`Tc0_Bordini`	`Optional[float]`	`null`
`Bc20_Bordini`	`Optional[float]`	`null`
`C0_Bordini`	`Optional[float]`	`null`
`alpha_Bordini`	`Optional[float]`	`null`

Bottura

Description: Level 3: Class for setting Bottura fit

Field	Type	Default
`type`	`str`	Required
`Tc0_Bottura`	`Optional[float]`	`null`
`Bc20_Bottura`	`Optional[float]`	`null`
`Jc_ref_Bottura`	`Optional[float]`	`null`
`C0_Bottura`	`Optional[float]`	`null`
`alpha_Bottura`	`Optional[float]`	`null`
`beta_Bottura`	`Optional[float]`	`null`
`gamma_Bottura`	`Optional[float]`	`null`

CC

Description: Level 2: Class for coated conductor parameters

Field	Type	Default	Description
`type`	`str`	Required
`HTS_thickness`	`Optional[float]`	`null`	HTS thickness in meters.
`HTS_width`	`Optional[float]`	`null`	HTS width in meters.
`number_of_filaments`	`Optional[int]`	`1`	Number of HTS filaments. If 1, no striation case
`gap_between_filaments`	`Optional[float]`	`null`	Gap between HTS filaments in meters. Only applies when number_of_filaments > 1.
`substrate_thickness`	`Optional[float]`	`null`	Substrate layer thickness in meters.
`copper_thickness`	`Copper_thickness`	`Copper_thickness()`	Copper thickness in meters
`silver_thickness`	`Silver_thickness`	`Silver_thickness()`	Silver thickness in meters
`material_superconductor`	`Optional[str]`	`null`	Material of the superconductor. E.g. NbTi, Nb3Sn, etc.
`n_value_superconductor`	`Optional[float]`	`null`	n value of the superconductor (for power law fit).
`ec_superconductor`	`Optional[float]`	`null`	Critical electric field of the superconductor.
`minimum_jc_fraction`	`Optional[float]`	`null`	Fraction of Jc(minimum_jc_field, T) to use as minimum Jc for the power law fit to avoid division by zero when Jc(B_local, T) decreases to zero.Typical value would be 0.001 (so the Jc_minimum is 0.1% of Jc(minimum_jc_field, T))This fraction is only allowed to be greater than 0.0 and less than or equal to 1.0
`minimum_jc_field`	`Optional[float]`	`null`	Magnetic flux density in tesla used for calculation of Jc(minimum_jc_field, T).This gets multiplied by minimum_jc_fraction and used as minimum Jc for the power law
`k_material_superconductor`	`Optional[str` \| `float]`	`null`	Thermal conductivity of the superconductor.
`Cv_material_superconductor`	`Optional[str` \| `float]`	`null`	Material function for specific heat of the superconductor.
`k_material_stabilizer`	`Optional[str` \| `float]`	`null`	Thermal conductivity of the stabilizer, typically copper.
`Cv_material_stabilizer`	`Optional[str` \| `float]`	`null`	Material function for specific heat of the stabilizer, typically copper.
`rho_material_stabilizer`	`Optional[str` \| `float]`	`null`	Material function for resistivity of the stabilizer. Constant resistivity can be given as float.
`RRR`	`Optional[float` \| `list]`	`null`	Residual resistivity ratio of the stabilizer. If a list of RRR is provided it needs to match in length the number of matrix regions in the geometry (typically 3)
`T_ref_RRR_high`	`Optional[float]`	`null`	Upper reference temperature for RRR measurements.
`T_ref_RRR_low`	`Optional[float]`	`null`	Lower reference temperature for RRR measurements.
`k_material_silver`	`Optional[str` \| `float]`	`null`	Thermal conductivity of the silver
`Cv_material_silver`	`Optional[str` \| `float]`	`null`	Material function for specific heat of the silver
`rho_material_silver`	`Optional[str` \| `float]`	`null`	Material function for resistivity of the silver. Constant resistivity can be given as float.
`RRR_silver`	`Optional[float` \| `list]`	`null`	Residual resistivity ratio of the silver. If a list of RRR is provided it needs to match in length the number of matrix regions in the geometry (typically 3)
`T_ref_RRR_high_silver`	`Optional[float]`	`null`	Upper reference temperature for RRR measurements for silver.
`T_ref_RRR_low_silver`	`Optional[float]`	`null`	Lower reference temperature for RRR measurements for silver.
`rho_material_substrate`	`Optional[str` \| `float]`	`null`	Material function for resistivity of the substrate. Constant resistivity can be given as float.
`k_material_substrate`	`Optional[str` \| `float]`	`null`	Thermal conductivity of the substrate.
`Cv_material_substrate`	`Optional[str` \| `float]`	`null`	Material function for specific heat of the substrate.

CUDI1

Description: Level 3: Class for Nb-Ti fit based on "Fit 1" in CUDI manual

Field	Type	Default
`type`	`str`	Required
`Tc0_CUDI1`	`Optional[float]`	`null`
`Bc20_CUDI1`	`Optional[float]`	`null`
`C1_CUDI1`	`Optional[float]`	`null`
`C2_CUDI1`	`Optional[float]`	`null`

CUDI3

Description: Level 3: Class for Nb-Ti fit based on "Fit 3" in CUDI manual

Field	Type	Default
`type`	`str`	Required
`Tc0_CUDI3`	`Optional[float]`	`null`
`Bc20_CUDI3`	`Optional[float]`	`null`
`c1_CUDI3`	`Optional[float]`	`null`
`c2_CUDI3`	`Optional[float]`	`null`
`c3_CUDI3`	`Optional[float]`	`null`
`c4_CUDI3`	`Optional[float]`	`null`
`c5_CUDI3`	`Optional[float]`	`null`
`c6_CUDI3`	`Optional[float]`	`null`

ConstantJc

Description: Level 3: Class for setting constant Jc

Field	Type	Default	Description
`type`	`str`	Required
`Jc_constant`	`Optional[float]`	`null`

Copper_thickness

Field	Type	Default	Description
`left`	`Optional[float]`	`null`	On the left side.
`right`	`Optional[float]`	`null`	On the right side.
`top`	`Optional[float]`	`null`	On the top side.
`bottom`	`Optional[float]`	`null`	On the bottom side.

Fujikura

Description: Level 3: Class for cable Fujikura's fit

Field	Type	Default	Description
`type`	`str`	Required
`Jc_factor`	`Optional[float]`	`1.0`	This factor multiplies the Jc returned by the function.

Homogenized

Description: Level 2: Class for homogenized strand parameters, to be used in the Rutherford cable model

Field	Type	Default	Description
`type`	`str`	Required
`diameter`	`Optional[float]`	`null`	Undeformed round strand diameter. Used in the geometry step if keep_strand_area==true, the strand is deformed while preserving its surface area. Not used otherwise.

Ic_A_NbTi

Description: Level 3: Class for setting IcNbTi fit

Field	Type	Default	Description
`type`	`str`	Required
`Jc_5T_4_2K`	`Optional[float]`	`null`

Mono

Description: Mono cable type: This is basically type of cable consisting of one strand - not really a cable

Field	Type	Default
`type`	`str`	Required
`bare_cable_width`	`Optional[float]`	`null`
`bare_cable_height_low`	`Optional[float]`	`null`
`bare_cable_height_high`	`Optional[float]`	`null`
`bare_cable_height_mean`	`Optional[float]`	`null`
`th_insulation_along_width`	`Optional[float]`	`null`
`th_insulation_along_height`	`Optional[float]`	`null`
`f_superconductor`	`Optional[float]`	`null`
`f_stabilizer`	`Optional[float]`	`null`
`f_insulation`	`Optional[float]`	`null`
`f_inner_voids`	`Optional[float]`	`null`
`f_outer_voids`	`Optional[float]`	`null`
`material_insulation`	`Optional[str]`	`null`
`material_inner_voids`	`Optional[str]`	`null`
`material_outer_voids`	`Optional[str]`	`null`

Nb3Sn_HFM

Description: Level 3: Class for cable HFM Nb3Sn fit

Field	Type	Default
`type`	`str`	Required
`Tc0_Nb3Sn_HFM`	`Optional[float]`	`null`
`Bc20_Nb3Sn_HFM`	`Optional[float]`	`null`
`C0_Nb3Sn_HFM`	`Optional[float]`	`null`
`alpha_Nb3Sn_HFM`	`Optional[float]`	`null`
`nu_Nb3Sn_HFM`	`Optional[float]`	`null`
`p_Nb3Sn_HFM`	`Optional[float]`	`null`
`q_Nb3Sn_HFM`	`Optional[float]`	`null`

ProDefined

Description: Level 3: Class for cable Bordini's Nb3Sn fit

Field	Type	Default
`type`	`str`	Required
`Tc0`	`Optional[float]`	`null`
`Bc20`	`Optional[float]`	`null`
`C0`	`Optional[float]`	`null`
`alpha`	`Optional[float]`	`null`
`p`	`Optional[float]`	`null`
`q`	`Optional[float]`	`null`
`v`	`Optional[float]`	`null`
`B0`	`Optional[float]`	`null`

Rectangular

Description: Level 2: Class for strand parameters

Field	Type	Default	Description
`type`	`str`	Required
`bare_width`	`Optional[float]`	`null`
`bare_height`	`Optional[float]`	`null`
`Cu_noCu_in_strand`	`Optional[float]`	`null`
`filament_diameter`	`Optional[float]`	`null`
`f_Rho_effective`	`Optional[float]`	`null`
`fil_twist_pitch`	`Optional[float]`	`null`
`bare_corner_radius`	`Optional[float]`	`null`
`material_superconductor`	`Optional[str]`	`null`	Material of the superconductor. E.g. NbTi, Nb3Sn, etc.
`n_value_superconductor`	`Optional[float]`	`null`	n value of the superconductor (for power law fit).
`ec_superconductor`	`Optional[float]`	`null`	Critical electric field of the superconductor.
`minimum_jc_fraction`	`Optional[float]`	`null`	Fraction of Jc(minimum_jc_field, T) to use as minimum Jc for the power law fit to avoid division by zero when Jc(B_local, T) decreases to zero.Typical value would be 0.001 (so the Jc_minimum is 0.1% of Jc(minimum_jc_field, T))This fraction is only allowed to be greater than 0.0 and less than or equal to 1.0
`minimum_jc_field`	`Optional[float]`	`null`	Magnetic flux density in tesla used for calculation of Jc(minimum_jc_field, T).This gets multiplied by minimum_jc_fraction and used as minimum Jc for the power law
`k_material_superconductor`	`Optional[str` \| `float]`	`null`	Thermal conductivity of the superconductor.
`Cv_material_superconductor`	`Optional[str` \| `float]`	`null`	Material function for specific heat of the superconductor.
`k_material_stabilizer`	`Optional[str` \| `float]`	`null`	Thermal conductivity of the stabilizer.
`Cv_material_stabilizer`	`Optional[str` \| `float]`	`null`	Material function for specific heat of the stabilizer.
`rho_material_stabilizer`	`Optional[str` \| `float]`	`null`	Material function for resistivity of the stabilizer. Constant resistivity can be given as float.
`RRR`	`Optional[float` \| `list]`	`null`	Residual resistivity ratio of the stabilizer. If a list of RRR is provided it needs to match in length the number of matrix regions in the geometry (typically 3)
`T_ref_RRR_high`	`Optional[float]`	`null`	Upper reference temperature for RRR measurements.
`T_ref_RRR_low`	`Optional[float]`	`null`	Lower reference temperature for RRR measurements.

Ribbon

Description: Mono cable type: This is basically type of cable consisting of one strand - not really a cable

Field	Type	Default
`type`	`str`	Required
`n_strands`	`Optional[int]`	`null`
`bare_cable_width`	`Optional[float]`	`null`
`bare_cable_height_low`	`Optional[float]`	`null`
`bare_cable_height_high`	`Optional[float]`	`null`
`bare_cable_height_mean`	`Optional[float]`	`null`
`th_insulation_along_width`	`Optional[float]`	`null`
`th_insulation_along_height`	`Optional[float]`	`null`
`f_superconductor`	`Optional[float]`	`null`
`f_stabilizer`	`Optional[float]`	`null`
`f_insulation`	`Optional[float]`	`null`
`f_inner_voids`	`Optional[float]`	`null`
`f_outer_voids`	`Optional[float]`	`null`
`f_core`	`Optional[float]`	`null`
`material_insulation`	`Optional[str]`	`null`
`material_inner_voids`	`Optional[str]`	`null`
`material_outer_voids`	`Optional[str]`	`null`
`material_core`	`Optional[str]`	`null`

Round

Description: Level 2: Class for strand parameters

Field	Type	Default	Description
`type`	`str`	Required
`fil_twist_pitch`	`Optional[float]`	`null`
`diameter`	`Optional[float]`	`null`
`diameter_core`	`Optional[float]`	`null`
`diameter_filamentary`	`Optional[float]`	`null`
`filament_diameter`	`Optional[float]`	`null`
`filament_hole_diameter`	`Optional[float]`	`null`	Specifies round or hexagonal hole diameter inside the filament. If None or 0.0, no hole is created.
`number_of_filaments`	`Optional[int]`	`null`
`f_Rho_effective`	`Optional[float]`	`null`
`Cu_noCu_in_strand`	`Optional[float]`	`null`
`material_superconductor`	`Optional[str]`	`null`	Material of the superconductor. E.g. Nb-Ti, Nb3Sn, etc.
`n_value_superconductor`	`Optional[float]`	`null`	n value of the superconductor (for power law fit).
`ec_superconductor`	`Optional[float]`	`null`	Critical electric field of the superconductor in V/m.
`minimum_jc_fraction`	`Optional[float]`	`null`	Fraction of Jc(minimum_jc_field, T) to use as minimum Jc for the power law fit to avoid division by zero when Jc(B_local, T) decreases to zero.Typical value would be 0.001 (so the Jc_minimum is 0.1% of Jc(minimum_jc_field, T))This fraction is only allowed to be greater than 0.0 and less than or equal to 1.0
`minimum_jc_field`	`Optional[float]`	`null`	Magnetic flux density in tesla used for calculation of Jc(minimum_jc_field, T). This gets multiplied by minimum_jc_fraction and used as minimum Jc for the power law
`k_material_superconductor`	`Optional[str` \| `float]`	`null`	Thermal conductivity of the superconductor.
`Cv_material_superconductor`	`Optional[str` \| `float]`	`null`	Material function for specific heat of the superconductor.
`rho_material_stabilizer`	`Optional[str` \| `float]`	`null`	Material function for resistivity of the stabilizer. Constant resistivity can be given as float.
`rho_material_holes`	`Optional[str` \| `float]`	`null`	Material function for resistivity of the holes in the filaments.Constant resistivity can be given as float, material name as a string or None or 0.0 to use 'air' in the holes.
`RRR`	`Optional[float` \| `list]`	`null`	Residual resistivity ratio of the stabilizer. If a list of RRR is provided it needs to match in length the number of matrix regions in the geometry (typically 3)
`T_ref_RRR_high`	`Optional[float]`	`null`	Upper reference temperature for RRR measurements.
`T_ref_RRR_low`	`Optional[float]`	`null`	Lower reference temperature for RRR measurements.
`k_material_stabilizer`	`Optional[str` \| `float]`	`null`	Thermal conductivity of the stabilizer.
`Cv_material_stabilizer`	`Optional[str` \| `float]`	`null`	Material function for specific heat of the stabilizer.

Rutherford

Description: Rutherford cable type: for example LHC MB magnet cable

Field	Type	Default	Description
`type`	`str`	Required
`n_strands`	`Optional[int]`	`null`
`n_strand_layers`	`Optional[int]`	`null`
`n_strands_per_layers`	`Optional[int]`	`null`
`bare_cable_width`	`Optional[float]`	`null`
`bare_cable_height_low`	`Optional[float]`	`null`
`bare_cable_height_high`	`Optional[float]`	`null`
`bare_cable_height_mean`	`Optional[float]`	`null`
`th_insulation_along_width`	`Optional[float]`	`null`
`th_insulation_along_height`	`Optional[float]`	`null`
`width_core`	`Optional[float]`	`null`
`height_core`	`Optional[float]`	`null`
`strand_twist_pitch`	`Optional[float]`	`null`
`strand_twist_pitch_angle`	`Optional[float]`	`null`
`Rc`	`Optional[float]`	`null`
`Ra`	`Optional[float]`	`null`
`f_superconductor`	`Optional[float]`	`null`
`f_stabilizer`	`Optional[float]`	`null`
`f_insulation`	`Optional[float]`	`null`
`f_inner_voids`	`Optional[float]`	`null`
`f_outer_voids`	`Optional[float]`	`null`
`f_core`	`Optional[float]`	`null`
`material_insulation`	`Optional[str]`	`null`
`material_inner_voids`	`Optional[str]`	`null`
`material_outer_voids`	`Optional[str]`	`null`
`material_core`	`Optional[str]`	`null`
`gamma_c`	`Optional[float]`	`0.0`	parameter for DISCC cable homogenization

Silver_thickness

Field	Type	Default	Description
`top`	`Optional[float]`	`null`	On the top side.
`bottom`	`Optional[float]`	`null`	On the bottom side.

Succi_fixed

Description: Level 3: Class for cable Succi's YBCO fit

Field	Type	Default	Description
`type`	`str`	Required
`Jc_factor`	`Optional[float]`	`1.0`	This factor multiplies the Jc returned by the function.

Summers

Description: Level 3: Class for cable Summer's Nb3Sn fit

Field	Type	Default
`type`	`str`	Required
`Tc0_Summers`	`Optional[float]`	`null`
`Bc20_Summers`	`Optional[float]`	`null`
`Jc0_Summers`	`Optional[float]`	`null`

TSTC

Description: Twisted Stacked-Tape Cable (TSTC) type:

Field	Type	Default	Description
`type`	`str`	Required
`stack_layout`	Optional[`list[Literal[int]]`]	`null`	2D: Tape stack layout ordered TOP->BOTTOM. The numbers represent: 1 = a CC tape, -1 = a flipped CC tape, 0 = a shunt. Available inputs: -1, 0, 1
`nb_tapes`	`Optional[int]`	`null`	3D: Number of tapes in the stack
`tape_width`	`Optional[float]`	`null`	3D and 2D: Width of each tape
`tape_thickness`	`Optional[float]`	`null`	3D and 2D: Thickness of each tape
`twist_pitch`	`Optional[float]`	`null`	3D: Length over which tapes are twisted by full rotation
`pitch_fraction`	`Optional[float]`	`1.0`	3D: Fraction of the twist pitch to be modelled (1.0 = full pitch, 0.5 = half pitch, etc.)
`bare_cable_width`	`Optional[float]`	`null`	Cable width, typically the same as CC width
`bare_cable_height_low`	`Optional[float]`	`null`	Narrow end (if applicable) cable height (thickness), typically the same as (CC thickness + Cu stabilizer thickness) * number of tapes.
`bare_cable_height_high`	`Optional[float]`	`null`	Wide end (if applicable) cable height (thickness), typically the same as (CC thickness + Cu stabilizer thickness) * number of tapes.
`bare_cable_height_mean`	`Optional[float]`	`null`	Average (if applicable) cable height (thickness), typically the same as (CC thickness + Cu stabilizer thickness) * number of tapes.
`th_insulation_along_width`	`Optional[float]`	`null`	Insulation thickness along the width
`th_insulation_along_height`	`Optional[float]`	`null`	Insulation thickness along the height
`f_superconductor`	`Optional[float]`	`null`	Fraction of superconductor related to the total area of the cable (winding cell)
`f_stabilizer`	`Optional[float]`	`null`	Fraction of stabilizer related to the total area of the cable (winding cell)
`f_silver`	`Optional[float]`	`null`	Fraction of silver related to the total area of the cable (winding cell)
`f_substrate`	`Optional[float]`	`null`	Fraction of substrate (including buffer layers and silver overlay) related to the total area of the cable (winding cell)
`f_shunt`	`Optional[float]`	`null`	Fraction of substrate (including buffer layers and silver overlay) related to the total area of the cable (winding cell)
`f_insulation`	`Optional[float]`	`null`	Fraction of cable insulation related to the total area of the cable (winding cell)
`f_inner_voids`	`Optional[float]`	`null`	Fraction of additional material (typically insulation) related to the total area of the cable (winding cell)
`f_outer_voids`	`Optional[float]`	`null`	Fraction of additional material (typically helium impregnating the windings) related to the total area of the cable (winding cell)

Copper_thickness

Module: DataConductor

Fields

Field	Type	Default	Description
`left`	`Optional[float]`	`null`	On the left side.
`right`	`Optional[float]`	`null`	On the right side.
`top`	`Optional[float]`	`null`	On the top side.
`bottom`	`Optional[float]`	`null`	On the bottom side.

Silver_thickness

Module: DataConductor

Fields

Field	Type	Default	Description
`top`	`Optional[float]`	`null`	On the top side.
`bottom`	`Optional[float]`	`null`	On the bottom side.