DataModelCommon
Auto-generated documentation for DataModelCommon.
Classes
CLIQ_ClassCircuit_ClassESC_ClassE_CLIQ_ClassEnergyExtractionFQPCs_ClassPowerSupplyClassQuenchDetectionQuenchHeaterQuenchProtectionSourcePiecewiseSourceSine
CLIQ_Class
Module: DataModelCommon
Description: Level 2: Class for the CLIQ parameters
Fields
| Field | Type | Default | Description |
|---|---|---|---|
t_trigger |
Optional[float] |
99999.0 |
Trigger time of CLIQ unit [s]. |
current_direction |
list |
[] |
Polarity of current in groups specified as a list with length equal to the number of groups [-]. |
sym_factor |
Optional[float] |
null |
Obsolete. |
N_units |
Optional[int] |
null |
Obsolete. |
U0 |
Optional[float] |
0 |
Initial charging voltage of CLIQ unit [V]. |
C |
Optional[float] |
0 |
Capacitance of CLIQ unit [F]. |
R |
Optional[float] |
0 |
Resistance of CLIQ unit [Ohm]. |
L |
Optional[float] |
0 |
Inductance of CLIQ unit [H]. |
I0 |
Optional[float] |
null |
Obsolete. |
Circuit_Class
Module: DataModelCommon
Description: Level 1: Class for the circuit parameters
Fields
| Field | Type | Default | Description |
|---|---|---|---|
field_circuit |
Optional[bool] |
False |
Allows to use Field-Circuit Coupling equations in the model. |
R_circuit |
Optional[float] |
null |
|
L_circuit |
Optional[float] |
null |
|
R_parallel |
Optional[float] |
null |
ESC_Class
Module: DataModelCommon
Description: Level 2: Class for the ESC parameters
Fields
| Field | Type | Default | Description |
|---|---|---|---|
t_trigger |
list |
[] |
Trigger time of ESC units [s] given as a list with length corresponding to the number of ESC units. |
U0 |
list |
[] |
Initial charging voltage of ESC units [V] given as a list with length corresponding to the number of ESC units.The unit is grounded in the middle, so the voltage to ground is half of this value |
C |
list |
[] |
Capacitance of ESC units [F] given as a list with length corresponding to the number of ESC units.The unit is grounded in the middle, with two capacitors in series with value of 2C |
L |
list |
[] |
Parasitic inductance of ESC units [H] given as a list with length corresponding to the number of ESC units.The unit is grounded in the middle, with two capacitors in series with value of 2C |
R_unit |
list |
[] |
Internal resistance of ESC units [Ohm] given as a list with length corresponding to the number of ESC units. |
R_leads |
list |
[] |
Resistance of leads from ESC coil to ESC diode connections [Ohm] given as a list with length corresponding to the number of ESC units. |
Ud_Diode |
list |
[] |
Forward diodes voltage across ESC coils [V] given as a list with length corresponding to the number of ESC units. |
L_Diode |
list |
[] |
Inductance in series with diodes across ESC coils [V] given as a list with length corresponding to the number of ESC units. |
E_CLIQ_Class
Module: DataModelCommon
Description: Level 2: Class for the E-CLIQ parameters for protection
Fields
| Field | Type | Default | Description |
|---|---|---|---|
t_trigger |
Optional[list] |
[] |
Trigger time of E-CLIQ current sources [s] given as a list with length corresponding to the number of E-CLIQ units. |
R_leads |
Optional[list] |
null |
List of E-CLIQ unit lead resistances [Ohm]. List length corresponding to the number of E-CLIQ units. |
L_leads |
Optional[list] |
null |
List of E-CLIQ unit lead inductances [H]. List length corresponding to the number of E-CLIQ units. |
source_type |
Literal |
null |
Time evolution of applied current. Supported options are: sine, piecewise. Available inputs: "sine", "piecewise", None |
sine |
SourceSine |
SourceSine() |
Definition of sine current source parameters. |
piecewise |
SourcePiecewise |
SourcePiecewise() |
Definition of piecewise current source parameters. |
quench_propagation |
Optional[Literal[str]] |
"full" |
Enables to have a variable length for the ecliq implementation, different from the full magnet length. It only affects the Thermal Behaviour of the model. Available inputs: "2Dx1D", "full" |
quench_prop_model |
Optional[Literal[str]] |
"Ts" |
Selects the model used for the material properties of the quench propagation. "Wilson" uses a scaled cv with a function of T_bath and Ts and Ts uses the cv at Ts. Available inputs: "Wilson", "Ts" |
NZPV_multiplier |
Optional[float] |
1.0 |
Factor that multiplies the Normal Zone Propagation Velocity |
N_units |
Optional[list] |
[] |
Number of E-CLIQ units along the magnet length per ecliq coil. It must be an odd number for symmetry reasons. |
h_ecliq |
Optional[list] |
[] |
Spacing between the ecliq coils along the magnet length (m). |
l_ecliq |
Optional[list] |
[] |
length of the ecliq coils along the magnet length (m). |
L_ecliq_offset |
Optional[list] |
[] |
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] |
[] |
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] |
[] |
List of half turns to whom the ECLIQ Units are in direct contact with. |
Nested Models
SourcePiecewise
Description: Level 3 Class for piecewise (linear) source parameters for E-CLIQ
| Field | Type | Default | Description |
|---|---|---|---|
csv_file |
Optional[str] |
null |
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] |
null |
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] |
null |
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] |
null |
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] |
null |
Multiplier for the E-CLIQ coil currents in currents. Also used for the values in the source_csv_file. |
SourceSine
Description: Level 3: Class for Sine source parameters for E-CLIQ
| Field | Type | Default | Description |
|---|---|---|---|
frequency |
Optional[float] |
null |
Frequency of the sine source [Hz]. |
current_amplitude |
Optional[float] |
null |
Amplitude of the sine current (A/turn). |
number_of_periods |
Optional[float] |
null |
Number of periods of ECLIQ power supply [-]. |
number_of_turns |
Optional[int] |
null |
Number of turns that conform ECLIQ [-]. |
EnergyExtraction
Module: DataModelCommon
Description: Level 2: Class for the energy extraction parameters
Fields
| Field | Type | Default | Description |
|---|---|---|---|
t_trigger |
Optional[float] |
99999.0 |
Trigger time on the positive lead [s]. tEE (LEDET), tSwitchDelay (ProteCCT) |
R_EE |
Optional[float] |
0 |
Energy extraction resistance on the positive lead [Ohm]. R_EE_triggered (ProteCCT) |
power_R_EE |
Optional[float] |
0.0 |
Varistor power component, R(I) = R_EE*abs(I)^power_R_EE on the positive lead [-]. RDumpPower (ProteCCT) |
L |
Optional[float] |
0 |
Inductance in series with resistor on the positive lead [H]. |
C |
Optional[float] |
0 |
Snubber capacitance in parallel to the EE switch on the positive lead [F]. |
L_c |
Optional[float] |
0 |
Inductance in the snubber capacitance branch in parallel to the EE switch on the positive lead [H]. |
R_c |
Optional[float] |
0 |
Resistance in the snubber capacitance branch in parallel to the EE switch on the positive lead [Ohm]. |
Ud_snubber |
Optional[float] |
0 |
Forward voltage of diode in the snubber capacitance branch in parallel to the EE switch on the positive lead [V]. |
L_s |
Optional[float] |
0 |
Inductance in the EE switch branch on the positive lead [H]. |
R_s |
Optional[float] |
0 |
Resistance in the EE switch branch on the positive lead [Ohm]. |
Ud_switch |
Optional[float] |
0 |
Forward voltage of diode in the EE switch branch on the positive lead [V]. |
t_trigger_n |
Optional[float] |
99999.0 |
Trigger time on the negative lead [s]. tEE (LEDET), tSwitchDelay (ProteCCT) |
R_EE_n |
Optional[float] |
0 |
Energy extraction resistance on the negative lead [Ohm]. R_EE_triggered (ProteCCT) |
power_R_EE_n |
Optional[float] |
0.0 |
Varistor power component, R(I) = R_EE*abs(I)^power_R_EE on the negative lead [-]. RDumpPower (ProteCCT) |
L_n |
Optional[float] |
0 |
Inductance in series with resistor on the negative lead [H]. |
C_n |
Optional[float] |
0 |
Snubber capacitance in parallel to the EE switch on the negative lead [F]. |
L_c_n |
Optional[float] |
0 |
Inductance in the snubber capacitance branch in parallel to the EE switch on the negative lead [H]. |
R_c_n |
Optional[float] |
0 |
Resistance in the snubber capacitance branch in parallel to the EE switch on the negative lead [Ohm]. |
Ud_snubber_n |
Optional[float] |
0 |
Forward voltage of diode in the snubber capacitance branch in parallel to the EE switch on the negative lead [V]. |
L_s_n |
Optional[float] |
0 |
Inductance in the EE switch branch on the negative lead [H]. |
R_s_n |
Optional[float] |
0 |
Resistance in the EE switch branch on the negative lead [Ohm]. |
Ud_switch_n |
Optional[float] |
0 |
Forward voltage of diode in the EE switch branch on the negative lead [V]. |
FQPCs_Class
Module: DataModelCommon
Description: Level 2: Class for the FQPLs parameters for protection
Fields
| Field | Type | Default | Description |
|---|---|---|---|
enabled |
Optional[list] |
null |
List of booleans specifying which FQPC is enabled. |
names |
Optional[list] |
null |
List of names to use in gmsh and getdp. Any unique ASCII strings would work |
fndpls |
Optional[list] |
null |
List of FQPC number of divisions per length at geometry level [-] |
fwws |
Optional[list] |
null |
List of FQPC wire widths (assuming rectangular). For theta = 0 this is x dimension. Works at geometry level [-] |
fwhs |
Optional[list] |
null |
List of FQPC wire heights (assuming rectangular). For theta = 0 this is y dimension. Works at geometry level [-] |
r_ins |
Optional[list] |
null |
List of FQPC inner diameter of (e.g. for CCT magnet). For theta = 0 this is x dimension. Works at geometry level [-] |
r_bs |
Optional[list] |
null |
List of FQPC radiuses for bending the fqpl by 180 degrees at the end of the magnet to go backward. Works at geometry level [-] |
n_sbs |
Optional[list] |
null |
List of FQPC number of 'bending segments' for the 180 degrees turn. Works at geometry level [-] |
thetas |
Optional[list] |
null |
List of FQPC rotation in deg from x+ axis towards y+ axis about z axis. Works at geometry level [-] |
z_starts |
Optional[list] |
null |
List of z coordinates for the air boundary to start at. These are string with either: z_min or z_max key from the Air region. Works at geometry level [-] |
z_ends |
Optional[list] |
null |
List of z coordinates for the air boundary to end at. These are string with either: z_min or z_max key from the Air region. Works at geometry level [-] |
currents |
Optional[list] |
null |
List of FQPC currents for a magnetostatic solution. Works at solve level [-] |
sigmas |
Optional[list] |
null |
List of FQPC electrical conductivity for a magnetostatic solution. Works at solve level [-] |
mu_rs |
Optional[list] |
null |
List of FQPC magnetic permeability for a magnetostatic solution. Works at solve level [-] |
th_conns_def |
Optional[list] |
null |
List of lists specifying thermal connections for LEDET to connect the FQPCs to the other turns of the magnet |
PowerSupplyClass
Module: DataModelCommon
Description: Level 1: Class for the power supply (aka power converter)
Fields
| Field | Type | Default | Description |
|---|---|---|---|
I_initial |
Optional[float] |
null |
Initial current in the magnet. Propagated differently in various tools and obsolete # I00 (LEDET), I_0 (SIGMA), I0 (BBQ) |
t_off |
Optional[float] |
null |
Time of switching off the switch next to current controlled source. t_PC (LEDET) |
t_control_LUT |
list |
[] |
List of time values [s] for linear piece wise time function of current controlled source. t_PC_LUT (LEDET) |
I_control_LUT |
list |
[] |
List of current values [A] for linear piece wise time function of current controlled source. I_PC_LUT (LEDET) |
R_crowbar |
Optional[float] |
0 |
Crowbar resistance in forward direction [Ohm]. Rcrow (SIGMA), RCrowbar (ProteCCT) |
L_crowbar |
Optional[float] |
0 |
Crowbar inductance in forward direction [H]. |
Ud_crowbar |
Optional[float] |
0 |
Crowbar diode voltage in forward direction [V]. |
R_c_r |
Optional[float] |
0 |
Crowbar resistance in reverse direction [Ohm]. |
L_c_r |
Optional[float] |
0 |
Crowbar inductance in reverse direction [H]. |
Ud_c_r |
Optional[float] |
0 |
Crowbar diode voltage in reverse direction [V]. |
R_1 |
Optional[float] |
0 |
Resistance R1 [Ohm]. |
L_1 |
Optional[float] |
0 |
Inductance L1 [H]. |
R_2 |
Optional[float] |
0 |
Resistance R2 [Ohm]. |
L_2 |
Optional[float] |
0 |
Inductance L2 [H]. |
C |
Optional[float] |
0 |
Capacitance C [F]. |
R_3 |
Optional[float] |
0 |
Resistance R3 [Ohm]. |
L_3 |
Optional[float] |
0 |
Inductance L3 [H]. |
QuenchDetection
Module: DataModelCommon
Description: Level 2: Class for FiQuS
Fields
| Field | Type | Default | Description |
|---|---|---|---|
voltage_thresholds |
Optional[list] |
null |
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] |
null |
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. |
voltage_tap_pairs |
Optional[list] |
null |
Voltage tap pairs for quench detection. The voltage difference between these pairs will be used for quench detection. |
QuenchHeater
Module: DataModelCommon
Description: Level 2: Class for the quench heater parameters
Fields
| Field | Type | Default | Description |
|---|---|---|---|
N_strips |
Optional[int] |
null |
Number of quench heater traces (typically 2 traces make one pad) |
t_trigger |
list |
[] |
Trigger times list of of quench heaters [s] |
U0 |
list |
[] |
Initial charging voltages list of capacitor for the trance (not full pad!) [V] |
C |
list |
[] |
Capacitances list of quench heater power supply for the trance (not full pad!) [H] |
R_warm |
list |
[] |
Internal resistances list of quench heater power supply and/or additional resistance added to limit the heater current for the trance (not full pad!) [Ohm] |
w |
list |
[] |
Widths list of quench heater trance stainless steel part [m] |
h |
list |
[] |
Thickness list of quench heater trance stainless steel part [m] |
s_ins |
list | list |
[] |
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 |
type_ins |
list | list |
[] |
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 |
s_ins_He |
list | list |
[] |
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_ins_He |
list | list |
[] |
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 |
l |
list |
[] |
Lengths list of quench heaters [m]. Typically equal to magnet length. |
l_copper |
list |
[] |
Lengths list of copper laminations of quench heaters [m]. |
l_stainless_steel |
list |
[] |
Lengths list of stainless steel only sections of quench heaters [m]. |
f_cover |
list |
[] |
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 [-]. |
iQH_toHalfTurn_From |
list |
[] |
List of heater numbers (1 based) equal to the length of turns that are covered by (i.e. thermally connected to) quench heaters. |
iQH_toHalfTurn_To |
list |
[] |
List of turn numbers (1 based) that are covered by (i.e. thermally connected to) quench heaters. |
turns_sides |
list |
[] |
List of letters specifying side of turn where quench heater is placed. Only used in FiQuS Multipole module.Possible sides are: 'o' - outer, 'i' - inner, 'l' - lower angle, 'h' - higher angle. |
quench_propagation |
Optional[Literal[str]] |
"full" |
Enables to have a variable length for the quench heater, different from the full magnet length. Available inputs: "2Dx1D", "full" |
quench_prop_model |
Optional[Literal[str]] |
"Ts" |
Selects the model used for the material properties of the quench propagation. "Wilson" uses a scaled cv and Ts uses the cv at Ts. Available inputs: "Wilson", "Ts" |
NZPV_multiplier |
Optional[float] |
1.0 |
Factor that multiplies the Normal Zone Propagation Velocity |
L_QH_offset |
Optional[list] |
[] |
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). |
QuenchProtection
Module: DataModelCommon
Description: Level 1: Class for quench protection
Fields
| Field | Type | Default | Description |
|---|---|---|---|
Energy_Extraction |
EnergyExtraction |
EnergyExtraction() |
|
Quench_Heaters |
QuenchHeater |
QuenchHeater() |
|
CLIQ |
CLIQ_Class |
CLIQ_Class() |
|
ESC |
ESC_Class |
ESC_Class() |
|
FQPCs |
FQPCs_Class |
FQPCs_Class() |
|
E_CLIQ |
E_CLIQ_Class |
E_CLIQ_Class() |
Nested Models
CLIQ_Class
Description: Level 2: Class for the CLIQ parameters
| Field | Type | Default | Description |
|---|---|---|---|
t_trigger |
Optional[float] |
99999.0 |
Trigger time of CLIQ unit [s]. |
current_direction |
list |
[] |
Polarity of current in groups specified as a list with length equal to the number of groups [-]. |
sym_factor |
Optional[float] |
null |
Obsolete. |
N_units |
Optional[int] |
null |
Obsolete. |
U0 |
Optional[float] |
0 |
Initial charging voltage of CLIQ unit [V]. |
C |
Optional[float] |
0 |
Capacitance of CLIQ unit [F]. |
R |
Optional[float] |
0 |
Resistance of CLIQ unit [Ohm]. |
L |
Optional[float] |
0 |
Inductance of CLIQ unit [H]. |
I0 |
Optional[float] |
null |
Obsolete. |
ESC_Class
Description: Level 2: Class for the ESC parameters
| Field | Type | Default | Description |
|---|---|---|---|
t_trigger |
list |
[] |
Trigger time of ESC units [s] given as a list with length corresponding to the number of ESC units. |
U0 |
list |
[] |
Initial charging voltage of ESC units [V] given as a list with length corresponding to the number of ESC units.The unit is grounded in the middle, so the voltage to ground is half of this value |
C |
list |
[] |
Capacitance of ESC units [F] given as a list with length corresponding to the number of ESC units.The unit is grounded in the middle, with two capacitors in series with value of 2C |
L |
list |
[] |
Parasitic inductance of ESC units [H] given as a list with length corresponding to the number of ESC units.The unit is grounded in the middle, with two capacitors in series with value of 2C |
R_unit |
list |
[] |
Internal resistance of ESC units [Ohm] given as a list with length corresponding to the number of ESC units. |
R_leads |
list |
[] |
Resistance of leads from ESC coil to ESC diode connections [Ohm] given as a list with length corresponding to the number of ESC units. |
Ud_Diode |
list |
[] |
Forward diodes voltage across ESC coils [V] given as a list with length corresponding to the number of ESC units. |
L_Diode |
list |
[] |
Inductance in series with diodes across ESC coils [V] given as a list with length corresponding to the number of ESC units. |
E_CLIQ_Class
Description: Level 2: Class for the E-CLIQ parameters for protection
| Field | Type | Default | Description |
|---|---|---|---|
t_trigger |
Optional[list] |
[] |
Trigger time of E-CLIQ current sources [s] given as a list with length corresponding to the number of E-CLIQ units. |
R_leads |
Optional[list] |
null |
List of E-CLIQ unit lead resistances [Ohm]. List length corresponding to the number of E-CLIQ units. |
L_leads |
Optional[list] |
null |
List of E-CLIQ unit lead inductances [H]. List length corresponding to the number of E-CLIQ units. |
source_type |
Literal |
null |
Time evolution of applied current. Supported options are: sine, piecewise. Available inputs: "sine", "piecewise", None |
sine |
SourceSine |
SourceSine() |
Definition of sine current source parameters. |
piecewise |
SourcePiecewise |
SourcePiecewise() |
Definition of piecewise current source parameters. |
quench_propagation |
Optional[Literal[str]] |
"full" |
Enables to have a variable length for the ecliq implementation, different from the full magnet length. It only affects the Thermal Behaviour of the model. Available inputs: "2Dx1D", "full" |
quench_prop_model |
Optional[Literal[str]] |
"Ts" |
Selects the model used for the material properties of the quench propagation. "Wilson" uses a scaled cv with a function of T_bath and Ts and Ts uses the cv at Ts. Available inputs: "Wilson", "Ts" |
NZPV_multiplier |
Optional[float] |
1.0 |
Factor that multiplies the Normal Zone Propagation Velocity |
N_units |
Optional[list] |
[] |
Number of E-CLIQ units along the magnet length per ecliq coil. It must be an odd number for symmetry reasons. |
h_ecliq |
Optional[list] |
[] |
Spacing between the ecliq coils along the magnet length (m). |
l_ecliq |
Optional[list] |
[] |
length of the ecliq coils along the magnet length (m). |
L_ecliq_offset |
Optional[list] |
[] |
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] |
[] |
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] |
[] |
List of half turns to whom the ECLIQ Units are in direct contact with. |
EnergyExtraction
Description: Level 2: Class for the energy extraction parameters
| Field | Type | Default | Description |
|---|---|---|---|
t_trigger |
Optional[float] |
99999.0 |
Trigger time on the positive lead [s]. tEE (LEDET), tSwitchDelay (ProteCCT) |
R_EE |
Optional[float] |
0 |
Energy extraction resistance on the positive lead [Ohm]. R_EE_triggered (ProteCCT) |
power_R_EE |
Optional[float] |
0.0 |
Varistor power component, R(I) = R_EE*abs(I)^power_R_EE on the positive lead [-]. RDumpPower (ProteCCT) |
L |
Optional[float] |
0 |
Inductance in series with resistor on the positive lead [H]. |
C |
Optional[float] |
0 |
Snubber capacitance in parallel to the EE switch on the positive lead [F]. |
L_c |
Optional[float] |
0 |
Inductance in the snubber capacitance branch in parallel to the EE switch on the positive lead [H]. |
R_c |
Optional[float] |
0 |
Resistance in the snubber capacitance branch in parallel to the EE switch on the positive lead [Ohm]. |
Ud_snubber |
Optional[float] |
0 |
Forward voltage of diode in the snubber capacitance branch in parallel to the EE switch on the positive lead [V]. |
L_s |
Optional[float] |
0 |
Inductance in the EE switch branch on the positive lead [H]. |
R_s |
Optional[float] |
0 |
Resistance in the EE switch branch on the positive lead [Ohm]. |
Ud_switch |
Optional[float] |
0 |
Forward voltage of diode in the EE switch branch on the positive lead [V]. |
t_trigger_n |
Optional[float] |
99999.0 |
Trigger time on the negative lead [s]. tEE (LEDET), tSwitchDelay (ProteCCT) |
R_EE_n |
Optional[float] |
0 |
Energy extraction resistance on the negative lead [Ohm]. R_EE_triggered (ProteCCT) |
power_R_EE_n |
Optional[float] |
0.0 |
Varistor power component, R(I) = R_EE*abs(I)^power_R_EE on the negative lead [-]. RDumpPower (ProteCCT) |
L_n |
Optional[float] |
0 |
Inductance in series with resistor on the negative lead [H]. |
C_n |
Optional[float] |
0 |
Snubber capacitance in parallel to the EE switch on the negative lead [F]. |
L_c_n |
Optional[float] |
0 |
Inductance in the snubber capacitance branch in parallel to the EE switch on the negative lead [H]. |
R_c_n |
Optional[float] |
0 |
Resistance in the snubber capacitance branch in parallel to the EE switch on the negative lead [Ohm]. |
Ud_snubber_n |
Optional[float] |
0 |
Forward voltage of diode in the snubber capacitance branch in parallel to the EE switch on the negative lead [V]. |
L_s_n |
Optional[float] |
0 |
Inductance in the EE switch branch on the negative lead [H]. |
R_s_n |
Optional[float] |
0 |
Resistance in the EE switch branch on the negative lead [Ohm]. |
Ud_switch_n |
Optional[float] |
0 |
Forward voltage of diode in the EE switch branch on the negative lead [V]. |
FQPCs_Class
Description: Level 2: Class for the FQPLs parameters for protection
| Field | Type | Default | Description |
|---|---|---|---|
enabled |
Optional[list] |
null |
List of booleans specifying which FQPC is enabled. |
names |
Optional[list] |
null |
List of names to use in gmsh and getdp. Any unique ASCII strings would work |
fndpls |
Optional[list] |
null |
List of FQPC number of divisions per length at geometry level [-] |
fwws |
Optional[list] |
null |
List of FQPC wire widths (assuming rectangular). For theta = 0 this is x dimension. Works at geometry level [-] |
fwhs |
Optional[list] |
null |
List of FQPC wire heights (assuming rectangular). For theta = 0 this is y dimension. Works at geometry level [-] |
r_ins |
Optional[list] |
null |
List of FQPC inner diameter of (e.g. for CCT magnet). For theta = 0 this is x dimension. Works at geometry level [-] |
r_bs |
Optional[list] |
null |
List of FQPC radiuses for bending the fqpl by 180 degrees at the end of the magnet to go backward. Works at geometry level [-] |
n_sbs |
Optional[list] |
null |
List of FQPC number of 'bending segments' for the 180 degrees turn. Works at geometry level [-] |
thetas |
Optional[list] |
null |
List of FQPC rotation in deg from x+ axis towards y+ axis about z axis. Works at geometry level [-] |
z_starts |
Optional[list] |
null |
List of z coordinates for the air boundary to start at. These are string with either: z_min or z_max key from the Air region. Works at geometry level [-] |
z_ends |
Optional[list] |
null |
List of z coordinates for the air boundary to end at. These are string with either: z_min or z_max key from the Air region. Works at geometry level [-] |
currents |
Optional[list] |
null |
List of FQPC currents for a magnetostatic solution. Works at solve level [-] |
sigmas |
Optional[list] |
null |
List of FQPC electrical conductivity for a magnetostatic solution. Works at solve level [-] |
mu_rs |
Optional[list] |
null |
List of FQPC magnetic permeability for a magnetostatic solution. Works at solve level [-] |
th_conns_def |
Optional[list] |
null |
List of lists specifying thermal connections for LEDET to connect the FQPCs to the other turns of the magnet |
QuenchHeater
Description: Level 2: Class for the quench heater parameters
| Field | Type | Default | Description |
|---|---|---|---|
N_strips |
Optional[int] |
null |
Number of quench heater traces (typically 2 traces make one pad) |
t_trigger |
list |
[] |
Trigger times list of of quench heaters [s] |
U0 |
list |
[] |
Initial charging voltages list of capacitor for the trance (not full pad!) [V] |
C |
list |
[] |
Capacitances list of quench heater power supply for the trance (not full pad!) [H] |
R_warm |
list |
[] |
Internal resistances list of quench heater power supply and/or additional resistance added to limit the heater current for the trance (not full pad!) [Ohm] |
w |
list |
[] |
Widths list of quench heater trance stainless steel part [m] |
h |
list |
[] |
Thickness list of quench heater trance stainless steel part [m] |
s_ins |
list | list |
[] |
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 |
type_ins |
list | list |
[] |
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 |
s_ins_He |
list | list |
[] |
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_ins_He |
list | list |
[] |
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 |
l |
list |
[] |
Lengths list of quench heaters [m]. Typically equal to magnet length. |
l_copper |
list |
[] |
Lengths list of copper laminations of quench heaters [m]. |
l_stainless_steel |
list |
[] |
Lengths list of stainless steel only sections of quench heaters [m]. |
f_cover |
list |
[] |
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 [-]. |
iQH_toHalfTurn_From |
list |
[] |
List of heater numbers (1 based) equal to the length of turns that are covered by (i.e. thermally connected to) quench heaters. |
iQH_toHalfTurn_To |
list |
[] |
List of turn numbers (1 based) that are covered by (i.e. thermally connected to) quench heaters. |
turns_sides |
list |
[] |
List of letters specifying side of turn where quench heater is placed. Only used in FiQuS Multipole module.Possible sides are: 'o' - outer, 'i' - inner, 'l' - lower angle, 'h' - higher angle. |
quench_propagation |
Optional[Literal[str]] |
"full" |
Enables to have a variable length for the quench heater, different from the full magnet length. Available inputs: "2Dx1D", "full" |
quench_prop_model |
Optional[Literal[str]] |
"Ts" |
Selects the model used for the material properties of the quench propagation. "Wilson" uses a scaled cv and Ts uses the cv at Ts. Available inputs: "Wilson", "Ts" |
NZPV_multiplier |
Optional[float] |
1.0 |
Factor that multiplies the Normal Zone Propagation Velocity |
L_QH_offset |
Optional[list] |
[] |
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). |
SourcePiecewise
Description: Level 3 Class for piecewise (linear) source parameters for E-CLIQ
| Field | Type | Default | Description |
|---|---|---|---|
csv_file |
Optional[str] |
null |
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] |
null |
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] |
null |
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] |
null |
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] |
null |
Multiplier for the E-CLIQ coil currents in currents. Also used for the values in the source_csv_file. |
SourceSine
Description: Level 3: Class for Sine source parameters for E-CLIQ
| Field | Type | Default | Description |
|---|---|---|---|
frequency |
Optional[float] |
null |
Frequency of the sine source [Hz]. |
current_amplitude |
Optional[float] |
null |
Amplitude of the sine current (A/turn). |
number_of_periods |
Optional[float] |
null |
Number of periods of ECLIQ power supply [-]. |
number_of_turns |
Optional[int] |
null |
Number of turns that conform ECLIQ [-]. |
SourcePiecewise
Module: DataModelCommon
Description: Level 3 Class for piecewise (linear) source parameters for E-CLIQ
Fields
| Field | Type | Default | Description |
|---|---|---|---|
csv_file |
Optional[str] |
null |
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] |
null |
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] |
null |
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] |
null |
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] |
null |
Multiplier for the E-CLIQ coil currents in currents. Also used for the values in the source_csv_file. |
SourceSine
Module: DataModelCommon
Description: Level 3: Class for Sine source parameters for E-CLIQ
Fields
| Field | Type | Default | Description |
|---|---|---|---|
frequency |
Optional[float] |
null |
Frequency of the sine source [Hz]. |
current_amplitude |
Optional[float] |
null |
Amplitude of the sine current (A/turn). |
number_of_periods |
Optional[float] |
null |
Number of periods of ECLIQ power supply [-]. |
number_of_turns |
Optional[int] |
null |
Number of turns that conform ECLIQ [-]. |