FiQuS

FiQuS input file

Type object
File match *_fiqus.json *_fiqus.json5 *_fiqus.yaml *_fiqus.yml *_FiQuS.json *_FiQuS.json5 *_FiQuS.yaml *_FiQuS.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/fiqus/latest.json
Source https://gitlab.cern.ch/steam/fiqus/-/raw/master/docs/schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Class for FiQuS

Properties

general object

Class for FiQuS general

1 nested properties
magnet_name string | null
Default: null
run object

Class for FiQuS run

10 nested properties
type string

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.

Default: "start_from_yaml"
Values: "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" "plot_python" "batch_post_process_python" "only_create_pro_file_from_mesh" "postprocess_veusz"
geometry integer | string | null

This key will be appended to the geometry folder.

Default: null
mesh integer | string | null

This key will be appended to the mesh folder.

Default: null
solution integer | string | null

This key will be appended to the solution folder.

Default: null
launch_gui boolean

If True, the GUI will be launched after the run.

Default: false
overwrite boolean

If True, the existing folders will be overwritten, otherwise new folders will be created. NOTE: This setting has no effect for HTCondor runs.

Default: false
comments string

Comments for the run. These comments will be saved in the run_log.csv file.

Default: ""
verbosity_Gmsh integer

Level of information printed on the terminal and the message console (0: silent except for fatal errors, 1: +errors, 2: +warnings, 3: +direct, 4: +information, 5: +status, 99: +debug)

Default: 5
verbosity_GetDP integer

Level of information printed on the terminal and the message console. Higher number prints more, good options are 5 or 6.

Default: 5
verbosity_FiQuS boolean

Level of information printed on the terminal and the message console by FiQuS. Only True of False for now.

Default: true
magnet Multipole | CCT | Pancake3D | CACStrand | fiqus__data__DataFiQuSHomogenizedConductor__HomogenizedConductor | CACRutherford | CACCC
Default:
{
  "type": "multipole",
  "geometry": {
    "electromagnetics": {
      "areas": [],
      "create": true,
      "symmetry": "none",
      "with_wedges": true
    },
    "geom_file_path": null,
    "plot_preview": false,
    "thermal": {
      "areas": [],
      "correct_block_coil_tsa_checkered_scheme": false,
      "create": true,
      "use_TSA": false,
      "use_TSA_new": false,
      "with_wedges": true
    }
  },
  "mesh": {
    "electromagnetics": {
      "bore_field": {
        "DistMax": null,
        "DistMin": null,
        "SizeMax": null,
        "SizeMin": null,
        "enabled": false
      },
      "collar": {
        "DistMax": null,
        "DistMin": null,
        "Enforce_TSA_mapping": false,
        "SizeMax": null,
        "SizeMin": null,
        "enabled": false
      },
      "conductors": {
        "field": {
          "DistMax": null,
          "DistMin": null,
          "SizeMax": null,
          "SizeMin": null,
          "enabled": false
        },
        "transfinite": {
          "curve_target_size_height": 1.0,
          "curve_target_size_width": 1.0,
          "enabled_for": null
        }
      },
      "create": true,
      "iron_field": {
        "DistMax": null,
        "DistMin": null,
        "SizeMax": null,
        "SizeMin": null,
        "enabled": false
      },
      "poles": {
        "DistMax": null,
        "DistMin": null,
        "SizeMax": null,
        "SizeMin": null,
        "enabled": false
      },
      "wedges": {
        "field": {
          "DistMax": null,
          "DistMin": null,
          "SizeMax": null,
          "SizeMin": null,
          "enabled": false
        },
        "transfinite": {
          "curve_target_size_height": 1.0,
          "curve_target_size_width": 1.0,
          "enabled_for": null
        }
      }
    },
    "thermal": {
      "collar": {
        "DistMax": null,
        "DistMin": null,
        "Enforce_TSA_mapping": false,
        "SizeMax": null,
        "SizeMin": null,
        "enabled": false
      },
      "conductors": {
        "field": {
          "DistMax": null,
          "DistMin": null,
          "SizeMax": null,
          "SizeMin": null,
          "enabled": false
        },
        "transfinite": {
          "curve_target_size_height": 1.0,
          "curve_target_size_width": 1.0,
          "enabled_for": null
        }
      },
      "create": true,
      "insulation": {
        "TSA": {
          "global_size_COL": 0.0001,
          "global_size_QH": 0.0001,
          "minimum_discretizations": 1,
          "minimum_discretizations_COL": 1,
          "minimum_discretizations_QH": 1,
          "scale_factor_azimuthal": -1.0,
          "scale_factor_radial": -1.0
        },
        "global_size": 0.0001
      },
      "iron_field": {
        "DistMax": null,
        "DistMin": null,
        "SizeMax": null,
        "SizeMin": null,
        "enabled": false
      },
      "isothermal_conductors": false,
      "isothermal_wedges": false,
      "poles": {
        "DistMax": null,
        "DistMin": null,
        "SizeMax": null,
        "SizeMin": null,
        "enabled": false
      },
      "reference": {
        "DistMax": null,
        "DistMin": null,
        "SizeMax": null,
        "SizeMin": null,
        "enabled": false
      },
      "wedges": {
        "field": {
          "DistMax": null,
          "DistMin": null,
          "SizeMax": null,
          "SizeMin": null,
          "enabled": false
        },
        "transfinite": {
          "curve_target_size_height": 1.0,
          "curve_target_size_width": 1.0,
          "enabled_for": null
        }
      }
    }
  },
  "solve": {
    "cable_homogenization": {
      "enabled": false,
      "rohf": {
        "enabled": false,
        "gather_cell_systems": false,
        "parameter_csv_file": null
      },
      "rohm": {
        "enabled": false,
        "gather_cell_systems": false,
        "parameter_csv_file": null,
        "tau_scaling": 1.0,
        "weight_scaling": 1.0
      },
      "run_type": {
        "mode": "ramp",
        "ramp_file": null
      }
    },
    "coil_windings": {
      "conductor_to_group": [],
      "electrical_pairs": {
        "group_together": [],
        "overwrite_electrical_order": [],
        "reversed": []
      },
      "group_to_coil_section": [],
      "half_turn_length": [],
      "polarities_in_group": []
    },
    "collar": {
      "RRR": null,
      "T_ref_RRR_high": null,
      "material": null,
      "transient_effects_enabled": false
    },
    "electromagnetics": {
      "non_linear_solver": {
        "abs_tolerance": 0.1,
        "max_iterations": 20,
        "norm_type": "LinfNorm",
        "rel_tolerance": 0.0001,
        "relaxation_factor": 0.7
      },
      "solve_type": null,
      "time_stepping": {
        "T_sim": 1.9,
        "abs_tol_time": 0.0001,
        "breakpoints": [],
        "final_time": 0.0,
        "initial_time": 0.0,
        "initial_time_step": 1e-10,
        "integration_method": "Euler",
        "max_time_step": 10.0,
        "min_time_step": 1e-12,
        "norm_type": "LinfNorm",
        "rel_tol_time": 0.0001
      }
    },
    "iron_yoke": {
      "RRR": null,
      "T_ref_RRR_high": null,
      "material": null,
      "transient_effects_enabled": false
    },
    "noOfMPITasks": false,
    "poles": {
      "RRR": null,
      "T_ref_RRR_high": null,
      "material": null,
      "transient_effects_enabled": false
    },
    "thermal": {
      "He_cooling": {
        "enabled": false,
        "heat_transfer_coefficient": 0.0,
        "sides": "outer"
      },
      "collar_cooling": {
        "enabled": false,
        "heat_transfer_coefficient": "CFUN_hHe_T_THe",
        "move_cooling_holes": null,
        "ref_temperature": 0.0,
        "which": "all"
      },
      "enforce_init_temperature_as_minimum": false,
      "init_temperature": 1.9,
      "insulation_TSA": {
        "between_collar": {
          "material": null
        },
        "block_to_block": {
          "blocks_connection_overwrite": [],
          "material": null,
          "materials_overwrite": [],
          "thicknesses_overwrite": []
        },
        "exterior": {
          "blocks": [],
          "materials_append": [],
          "thicknesses_append": []
        }
      },
      "jc_degradation_to_zero": {
        "t_trigger": [],
        "turns": []
      },
      "non_linear_solver": {
        "abs_tolerance": 0.1,
        "max_iterations": 20,
        "norm_type": "LinfNorm",
        "rel_tolerance": 0.0001,
        "relaxation_factor": 0.7
      },
      "overwrite_boundary_conditions": {
        "cooling": {},
        "heat_flux": {},
        "temperature": {}
      },
      "solve_type": null,
      "time_stepping": {
        "abs_tol_time": 0.0001,
        "breakpoints": [],
        "final_time": 0.0,
        "initial_time": 0.0,
        "initial_time_step": 1e-10,
        "integration_method": "Euler",
        "max_time_step": 10.0,
        "min_time_step": 1e-12,
        "norm_type": "LinfNorm",
        "rel_tol_time": 0.0001,
        "stop_temperature": 300.0
      }
    },
    "time_stepping": {
      "abs_tol_time": [
        0.0001,
        0.0001
      ],
      "breakpoints": [],
      "final_time": 0.0,
      "initial_time": 0.0,
      "initial_time_step": 1e-10,
      "integration_method": "Euler",
      "max_time_step": 10.0,
      "min_time_step": 1e-12,
      "norm_type": [
        "LinfNorm",
        "LinfNorm"
      ],
      "rel_tol_time": [
        0.0001,
        0.0001
      ],
      "seq_NL": true,
      "stop_temperature": 300.0
    },
    "wedges": {
      "RRR": null,
      "T_ref_RRR_high": null,
      "material": null,
      "transient_effects_enabled": false
    }
  },
  "postproc": {
    "circuit_coupling": {
      "assemble_veusz": false,
      "variables_I": [],
      "variables_U": []
    },
    "electromagnetics": {
      "compare_to_ROXIE": null,
      "output_time_steps_pos": true,
      "output_time_steps_txt": true,
      "plot_all": false,
      "save_pos_at_the_end": true,
      "save_txt_at_the_end": false,
      "variables": [],
      "volumes": []
    },
    "thermal": {
      "output_time_steps_pos": true,
      "output_time_steps_txt": true,
      "plot_all": false,
      "save_pos_at_the_end": true,
      "save_txt_at_the_end": false,
      "take_average_conductor_temperature": true,
      "variables": [
        "T"
      ],
      "volumes": [
        "powered"
      ]
    }
  }
}
circuit object

Level 1: Class for the circuit parameters

4 nested properties
field_circuit boolean | null

Allows to use Field-Circuit Coupling equations in the model.

Default: false
R_circuit number | null
Default: null
L_circuit number | null
Default: null
R_parallel number | null
Default: null
power_supply object

Level 1: Class for the power supply (aka power converter)

17 nested properties
I_initial number | null

Initial current in the magnet. Propagated differently in various tools and obsolete # I00 (LEDET), I_0 (SIGMA), I0 (BBQ)

Default: null
t_off number | null

Time of switching off the switch next to current controlled source. t_PC (LEDET)

Default: null
t_control_LUT number[]

List of time values [s] for linear piece wise time function of current controlled source. t_PC_LUT (LEDET)

Default:
[]
I_control_LUT number[]

List of current values [A] for linear piece wise time function of current controlled source. I_PC_LUT (LEDET)

Default:
[]
R_crowbar number | null

Crowbar resistance in forward direction [Ohm]. Rcrow (SIGMA), RCrowbar (ProteCCT)

Default: 0
L_crowbar number | null

Crowbar inductance in forward direction [H].

Default: 0
Ud_crowbar number | null

Crowbar diode voltage in forward direction [V].

Default: 0
R_c_r number | null

Crowbar resistance in reverse direction [Ohm].

Default: 0
L_c_r number | null

Crowbar inductance in reverse direction [H].

Default: 0
Ud_c_r number | null

Crowbar diode voltage in reverse direction [V].

Default: 0
R_1 number | null

Resistance R1 [Ohm].

Default: 0
L_1 number | null

Inductance L1 [H].

Default: 0
R_2 number | null

Resistance R2 [Ohm].

Default: 0
L_2 number | null

Inductance L2 [H].

Default: 0
C number | null

Capacitance C [F].

Default: 0
R_3 number | null

Resistance R3 [Ohm].

Default: 0
L_3 number | null

Inductance L3 [H].

Default: 0
quench_protection object

Level 2: Class for FiQuS

5 nested properties
energy_extraction object

Level 2: Class for the energy extraction parameters

22 nested properties
t_trigger number | null

Trigger time on the positive lead [s]. tEE (LEDET), tSwitchDelay (ProteCCT)

Default: 99999.0
R_EE number | null

Energy extraction resistance on the positive lead [Ohm]. R_EE_triggered (ProteCCT)

Default: 0
power_R_EE number | null

Varistor power component, R(I) = R_EE*abs(I)^power_R_EE on the positive lead [-]. RDumpPower (ProteCCT)

Default: 0.0
L number | null

Inductance in series with resistor on the positive lead [H].

Default: 0
C number | null

Snubber capacitance in parallel to the EE switch on the positive lead [F].

Default: 0
L_c number | null

Inductance in the snubber capacitance branch in parallel to the EE switch on the positive lead [H].

Default: 0
R_c number | null

Resistance in the snubber capacitance branch in parallel to the EE switch on the positive lead [Ohm].

Default: 0
Ud_snubber number | null

Forward voltage of diode in the snubber capacitance branch in parallel to the EE switch on the positive lead [V].

Default: 0
L_s number | null

Inductance in the EE switch branch on the positive lead [H].

Default: 0
R_s number | null

Resistance in the EE switch branch on the positive lead [Ohm].

Default: 0
Ud_switch number | null

Forward voltage of diode in the EE switch branch on the positive lead [V].

Default: 0
t_trigger_n number | null

Trigger time on the negative lead [s]. tEE (LEDET), tSwitchDelay (ProteCCT)

Default: 99999.0
R_EE_n number | null

Energy extraction resistance on the negative lead [Ohm]. R_EE_triggered (ProteCCT)

Default: 0
power_R_EE_n number | null

Varistor power component, R(I) = R_EE*abs(I)^power_R_EE on the negative lead [-]. RDumpPower (ProteCCT)

Default: 0.0
L_n number | null

Inductance in series with resistor on the negative lead [H].

Default: 0
C_n number | null

Snubber capacitance in parallel to the EE switch on the negative lead [F].

Default: 0
L_c_n number | null

Inductance in the snubber capacitance branch in parallel to the EE switch on the negative lead [H].

Default: 0
R_c_n number | null

Resistance in the snubber capacitance branch in parallel to the EE switch on the negative lead [Ohm].

Default: 0
Ud_snubber_n number | null

Forward voltage of diode in the snubber capacitance branch in parallel to the EE switch on the negative lead [V].

Default: 0
L_s_n number | null

Inductance in the EE switch branch on the negative lead [H].

Default: 0
R_s_n number | null

Resistance in the EE switch branch on the negative lead [Ohm].

Default: 0
Ud_switch_n number | null

Forward voltage of diode in the EE switch branch on the negative lead [V].

Default: 0
quench_heaters object

Level 2: Class for the quench heater parameters

22 nested properties
N_strips integer | null

Number of quench heater traces (typically 2 traces make one pad)

Default: null
t_trigger number[]

Trigger times list of of quench heaters [s]

Default:
[]
U0 number[]

Initial charging voltages list of capacitor for the trance (not full pad!) [V]

Default:
[]
C number[]

Capacitances list of quench heater power supply for the trance (not full pad!) [H]

Default:
[]
R_warm number[]

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]

Default:
[]
w number[]

Widths list of quench heater trance stainless steel part [m]

Default:
[]
h number[]

Thickness list of quench heater trance stainless steel part [m]

Default:
[]
s_ins number[] | number[][]

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

Default:
[]
type_ins string[] | string[][]

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

Default:
[]
s_ins_He number[] | number[][]

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

Default:
[]
type_ins_He string[] | string[][]

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

Default:
[]
l number[]

Lengths list of quench heaters [m]. Typically equal to magnet length.

Default:
[]
l_copper number[]

Lengths list of copper laminations of quench heaters [m].

Default:
[]
l_stainless_steel number[]

Lengths list of stainless steel only sections of quench heaters [m].

Default:
[]
f_cover number[]

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 [-].

Default:
[]
iQH_toHalfTurn_From integer[]

List of heater numbers (1 based) equal to the length of turns that are covered by (i.e. thermally connected to) quench heaters.

Default:
[]
iQH_toHalfTurn_To integer[]

List of turn numbers (1 based) that are covered by (i.e. thermally connected to) quench heaters.

Default:
[]
turns_sides string[]

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.

Default:
[]
quench_propagation string | null

Enables to have a variable length for the quench heater, different from the full magnet length.

Default: "full"
quench_prop_model string | null

Selects the model used for the material properties of the quench propagation. "Wilson" uses a scaled cv and Ts uses the cv at Ts.

Default: "Ts"
NZPV_multiplier number | null

Factor that multiplies the Normal Zone Propagation Velocity

Default: 1.0
L_QH_offset number[] | null

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).

Default:
[]
cliq object

Level 2: Class for the CLIQ parameters

9 nested properties
t_trigger number | null

Trigger time of CLIQ unit [s].

Default: 99999.0
current_direction integer[]

Polarity of current in groups specified as a list with length equal to the number of groups [-].

Default:
[]
sym_factor number | null

Obsolete.

Default: null
N_units integer | null

Obsolete.

Default: null
U0 number | null

Initial charging voltage of CLIQ unit [V].

Default: 0
C number | null

Capacitance of CLIQ unit [F].

Default: 0
R number | null

Resistance of CLIQ unit [Ohm].

Default: 0
L number | null

Inductance of CLIQ unit [H].

Default: 0
I0 number | null

Obsolete.

Default: null
esc object

Level 2: Class for the ESC parameters

8 nested properties
t_trigger number[]

Trigger time of ESC units [s] given as a list with length corresponding to the number of ESC units.

Default:
[]
U0 number[]

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

Default:
[]
C number[]

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

Default:
[]
L number[]

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

Default:
[]
R_unit number[]

Internal resistance of ESC units [Ohm] given as a list with length corresponding to the number of ESC units.

Default:
[]
R_leads number[]

Resistance of leads from ESC coil to ESC diode connections [Ohm] given as a list with length corresponding to the number of ESC units.

Default:
[]
Ud_Diode number[]

Forward diodes voltage across ESC coils [V] given as a list with length corresponding to the number of ESC units.

Default:
[]
L_Diode number[]

Inductance in series with diodes across ESC coils [V] given as a list with length corresponding to the number of ESC units.

Default:
[]
e_cliq object

Level 2: Class for the E-CLIQ parameters for protection

15 nested properties
t_trigger number[] | null

Trigger time of E-CLIQ current sources [s] given as a list with length corresponding to the number of E-CLIQ units.

Default:
[]
R_leads number[] | null

List of E-CLIQ unit lead resistances [Ohm]. List length corresponding to the number of E-CLIQ units.

Default: null
L_leads number[] | null

List of E-CLIQ unit lead inductances [H]. List length corresponding to the number of E-CLIQ units.

Default: null
source_type enum

Time evolution of applied current. Supported options are: sine, piecewise.

Default: null
Values: "sine" "piecewise" null
sine object

Level 3: Class for Sine source parameters for E-CLIQ

4 nested properties
frequency number | null

Frequency of the sine source [Hz].

Default: null
current_amplitude number | null

Amplitude of the sine current (A/turn).

Default: null
number_of_periods number | null

Number of periods of ECLIQ power supply [-].

Default: null
number_of_turns integer | null

Number of turns that conform ECLIQ [-].

Default: null
piecewise object

Level 3 Class for piecewise (linear) source parameters for E-CLIQ

5 nested properties
csv_file string | 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.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.

Default: null
currents number[] | null

E-CLIQ coil currents relative to current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.

Default: null
current_multiplier number | null

Multiplier for the E-CLIQ coil currents in currents. Also used for the values in the source_csv_file.

Default: null
quench_propagation string | null

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.

Default: "full"
quench_prop_model string | null

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.

Default: "Ts"
NZPV_multiplier number | null

Factor that multiplies the Normal Zone Propagation Velocity

Default: 1.0
N_units integer[] | null

Number of E-CLIQ units along the magnet length per ecliq coil. It must be an odd number for symmetry reasons.

Default:
[]
h_ecliq number[] | null

Spacing between the ecliq coils along the magnet length (m).

Default:
[]
l_ecliq number[] | null

length of the ecliq coils along the magnet length (m).

Default:
[]
L_ecliq_offset number[] | null

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).

Default:
[]
iECLIQ_toHalfTurn_From integer[] | null

List of coils to which the ECLIQ units are connected from, to which half turns they are in direct contact with.

Default:
[]
iECLIQ_toHalfTurn_To integer[] | null

List of half turns to whom the ECLIQ Units are in direct contact with.

Default:
[]
quench_detection object

Level 2: Class for FiQuS

3 nested properties
voltage_thresholds number[] | 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.

Default: null
discrimination_times number[] | 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.

Default: null
voltage_tap_pairs integer[][] | null

Voltage tap pairs for quench detection. The voltage difference between these pairs will be used for quench detection.

Default: null
conductors Record<string, object>
Default:
{}

Definitions

Air_g object

Level 2: Class for FiQuS CCT

name string | null
Default: null
sh_type string | null
Default: null
ar number | null
Default: null
z_min number | null
Default: null
z_max number | null
Default: null
Air_s object

Level 2: Class for FiQuS CCT

sigma number | null
Default: null
mu_r number | null
Default: null
BSCCO_2212_LBNL object

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

type string required
Constant: "BSCCO_2212_LBNL"
f_scaling_Jc_BSCCO2212 number | null
Default: null
Bordini object

Level 3: Class for cable Bordini's Nb3Sn fit

type string required
Constant: "Bordini"
Tc0_Bordini number | null
Default: null
Bc20_Bordini number | null
Default: null
C0_Bordini number | null
Default: null
alpha_Bordini number | null
Default: null
Bottura object

Level 3: Class for setting Bottura fit

type string required
Constant: "Bottura"
Tc0_Bottura number | null
Default: null
Bc20_Bottura number | null
Default: null
Jc_ref_Bottura number | null
Default: null
C0_Bottura number | null
Default: null
alpha_Bottura number | null
Default: null
beta_Bottura number | null
Default: null
gamma_Bottura number | null
Default: null
CACCC object

Level 1: Class for FiQuS CACCC

type string required
Constant: "CACCC"
geometry object

Level 2: Geometry for CACCC.

1 nested properties
air_radius number | null

Radius of air region.

Default: null
mesh object

Level 2: Mesh parameters for CACCC.

9 nested properties
HTS_n_elem_width integer | null

Number of elements along HTS width (x-direction).

Default: null
HTS_n_elem_thickness integer | null

Number of elements through HTS thickness (y-direction).

Default: null
substrate_elem_scale number | null

Element-count scale factor for substrate layer.

Default: null
substrate_side_progression number | null

Progression factor for substrate vertical sides near the HTS side.

Default: null
silver_elem_scale number | null

Element-count scale factor for silver layers.

Default: null
copper_elem_scale number | null

Element-count scale factor for copper layers.

Default: null
air_boundary_mesh_size_ratio number | null

Ratio of air outer-boundary mesh size to the HTS base size.

Default: null
scaling_global number | null

Global refinement factor.

Default: null
bump_coef number | null

Unified bump coefficient for transfinite horizontal edges. Used for both HTS and SilverTop when applying 'Bump' distributions. Values < 1 cluster nodes toward the edges; values > 1 cluster toward the center.

Default: null
solve object

Level 2: Solve block for CACCC

6 nested properties
pro_template string | null

Name of the .pro template file.

Default: "CAC_CC_template.pro"
conductor_name string | null

Name of the conductor. Must match a conductor name in the conductors section of the input YAML-file.

Default: null
general_parameters object

Level 3: Class for general parameters

2 nested properties
temperature number

Temperature (K).

Default: 1.9
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
initial_conditions object

Level 3: Class for initial conditions

2 nested properties
init_type string | null

Type of initialization for the simulation. (i) 'virgin' is the default type, the initial magnetic field is zero,(ii) 'pos_file' is to initialize from the solution of another solution, given by the solution_to_init_from entry, and (iii) 'uniform_field' is to initialize at a uniform field, which will be the applied field at the initial time of the simulation. Note that the uniform_field option does not allow any non-zero transport current (initialization from pos_file is needed for this).

Default: "virgin"
solution_to_init_from integer | string | null

Name xxx of the solution from which the simulation should be initialized. The file last_magnetic_field.pos of folder Solution_xxx will be used for the initial solution.It must be in the Geometry_.../Mesh_.../ folder in which the Solution_xxx will be saved.

Default: null
source_parameters object

Level 3: Class for material properties

4 nested properties
source_type string

Time evolution of applied current and magnetic field. Supported options are: sine, piecewise.

Default: "sine"
Values: "sine" "piecewise"
sine object

Level 4: Class for Sine source parameters

piecewise object

Level 4: Class for piecewise (linear) source parameters

field_angle_with_respect_to_normal_direction number | null

Angle of the source magnetic field with respect to the y-axis (normal to the tape) (degrees).

Default: null
numerical_parameters object

Level 3: Class for numerical parameters

5 nested properties
relative_tolerance number | null

Tolerance on the relative change of the power indicator for the convergence criterion (1e-6 is usually a safe choice).

Default: 1e-6
voltage_per_meter_stopping_criterion number | null

If a non-zero value is given, the simulation will stop if the transport voltage per meter reaches this value (in absolute value).

Default: null
relaxation_factors boolean | null

Use of relaxation factors to help convergence (automatic selection based on the lowest residual).

Default: true
sine object

Level 4: Numerical parameters corresponding to the sine source

piecewise object

Level 4: Numerical parameters corresponding to the piecewise source

postproc object

Post-processing options for CACCC

2 nested properties
pos_files object

Level 3: Class for post-pro .pos file requests

2 nested properties
quantities string[] | null

List of GetDP postprocessing quantities to write to .pos file. Examples of valid entry is: phi, h, b, j, jz, power

Default: null
regions string[] | null

List of GetDP regions to write to .pos file postprocessing for. Examples of a valid entry is: Matrix, Filaments, Omega (full domain), OmegaC (conducting domain), OmegaCC (non conducting domain)

Default: null
cleanup object

Level 3: Class for cleanup settings

3 nested properties
remove_pre_file boolean

Set True to remove the .pre-file after post-processing, to save disk space.

Default: false
remove_res_file boolean

Set True to remove the .res-file after post-processing, to save disk space.

Default: false
remove_msh_file boolean

Set True to remove the .msh-file after post-processing, to save disk space.

Default: false
CACCCGeneralparameters object

Level 3: Class for general parameters

temperature number

Temperature (K).

Default: 1.9
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
CACCCGeometry object

Level 2: Geometry for CACCC.

air_radius number | null

Radius of air region.

Default: null
CACCCMesh object

Level 2: Mesh parameters for CACCC.

HTS_n_elem_width integer | null

Number of elements along HTS width (x-direction).

Default: null
HTS_n_elem_thickness integer | null

Number of elements through HTS thickness (y-direction).

Default: null
substrate_elem_scale number | null

Element-count scale factor for substrate layer.

Default: null
substrate_side_progression number | null

Progression factor for substrate vertical sides near the HTS side.

Default: null
silver_elem_scale number | null

Element-count scale factor for silver layers.

Default: null
copper_elem_scale number | null

Element-count scale factor for copper layers.

Default: null
air_boundary_mesh_size_ratio number | null

Ratio of air outer-boundary mesh size to the HTS base size.

Default: null
scaling_global number | null

Global refinement factor.

Default: null
bump_coef number | null

Unified bump coefficient for transfinite horizontal edges. Used for both HTS and SilverTop when applying 'Bump' distributions. Values < 1 cluster nodes toward the edges; values > 1 cluster toward the center.

Default: null
CACCCPostproc object

Post-processing options for CACCC

pos_files object

Level 3: Class for post-pro .pos file requests

2 nested properties
quantities string[] | null

List of GetDP postprocessing quantities to write to .pos file. Examples of valid entry is: phi, h, b, j, jz, power

Default: null
regions string[] | null

List of GetDP regions to write to .pos file postprocessing for. Examples of a valid entry is: Matrix, Filaments, Omega (full domain), OmegaC (conducting domain), OmegaCC (non conducting domain)

Default: null
cleanup object

Level 3: Class for cleanup settings

3 nested properties
remove_pre_file boolean

Set True to remove the .pre-file after post-processing, to save disk space.

Default: false
remove_res_file boolean

Set True to remove the .res-file after post-processing, to save disk space.

Default: false
remove_msh_file boolean

Set True to remove the .msh-file after post-processing, to save disk space.

Default: false
CACCCPostprocPosFiles object

Level 3: Class for post-pro .pos file requests

quantities string[] | null

List of GetDP postprocessing quantities to write to .pos file. Examples of valid entry is: phi, h, b, j, jz, power

Default: null
regions string[] | null

List of GetDP regions to write to .pos file postprocessing for. Examples of a valid entry is: Matrix, Filaments, Omega (full domain), OmegaC (conducting domain), OmegaCC (non conducting domain)

Default: null
CACCCSolve object

Level 2: Solve block for CACCC

pro_template string | null

Name of the .pro template file.

Default: "CAC_CC_template.pro"
conductor_name string | null

Name of the conductor. Must match a conductor name in the conductors section of the input YAML-file.

Default: null
general_parameters object

Level 3: Class for general parameters

2 nested properties
temperature number

Temperature (K).

Default: 1.9
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
initial_conditions object

Level 3: Class for initial conditions

2 nested properties
init_type string | null

Type of initialization for the simulation. (i) 'virgin' is the default type, the initial magnetic field is zero,(ii) 'pos_file' is to initialize from the solution of another solution, given by the solution_to_init_from entry, and (iii) 'uniform_field' is to initialize at a uniform field, which will be the applied field at the initial time of the simulation. Note that the uniform_field option does not allow any non-zero transport current (initialization from pos_file is needed for this).

Default: "virgin"
solution_to_init_from integer | string | null

Name xxx of the solution from which the simulation should be initialized. The file last_magnetic_field.pos of folder Solution_xxx will be used for the initial solution.It must be in the Geometry_.../Mesh_.../ folder in which the Solution_xxx will be saved.

Default: null
source_parameters object

Level 3: Class for material properties

4 nested properties
source_type string

Time evolution of applied current and magnetic field. Supported options are: sine, piecewise.

Default: "sine"
Values: "sine" "piecewise"
sine object

Level 4: Class for Sine source parameters

3 nested properties
frequency number | null

Frequency of the sine source (Hz).

Default: null
field_amplitude number | null

Amplitude of the sine field (T).

Default: null
current_amplitude number | null

Amplitude of the sine current (A).

Default: null
piecewise object

Level 4: Class for piecewise (linear) source parameters

7 nested properties
source_csv_file string | null

File name for the from_file source type defining the time evolution of current and field (in-phase).Multipliers are used for each of them.The file should contain two columns: 'time' (s) and 'value' (field/current (T/A)), with these headers.If this field is set, times, applied_fields_relative and transport_currents_relative are ignored.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources.Used only if source_csv_file is not set.Can be scaled by time_multiplier.

Default: null
applied_fields_relative number[] | null

Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'.Used only if source_csv_file is not set.

Default: null
transport_currents_relative number[] | null

Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'.Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values).Also used for the time values in the source_csv_file.

Default: null
applied_field_multiplier number | null

Multiplier for the applied fields in applied_fields_relative.Also used for the values in the source_csv_file.

Default: null
transport_current_multiplier number | null

Multiplier for the transport currents in transport_currents_relative.Also used for the values in the source_csv_file.

Default: null
field_angle_with_respect_to_normal_direction number | null

Angle of the source magnetic field with respect to the y-axis (normal to the tape) (degrees).

Default: null
numerical_parameters object

Level 3: Class for numerical parameters

5 nested properties
relative_tolerance number | null

Tolerance on the relative change of the power indicator for the convergence criterion (1e-6 is usually a safe choice).

Default: 1e-6
voltage_per_meter_stopping_criterion number | null

If a non-zero value is given, the simulation will stop if the transport voltage per meter reaches this value (in absolute value).

Default: null
relaxation_factors boolean | null

Use of relaxation factors to help convergence (automatic selection based on the lowest residual).

Default: true
sine object

Level 4: Numerical parameters corresponding to the sine source

2 nested properties
timesteps_per_period number | null

Initial value for number of time steps (-) per period for the sine source.Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the sine source.

Default: null
piecewise object

Level 4: Numerical parameters corresponding to the piecewise source

6 nested properties
time_to_simulate number | null

Total time to simulate (s). Used for the piecewise source.

Default: null
timesteps_per_time_to_simulate number | null

If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.

Default: null
force_stepping_at_times_piecewise_linear boolean

If True, time-stepping will contain exactly the time instants that are inthe times_source_piecewise_linear list (to avoid truncation maximum applied field/current values).

Default: false
variable_max_timestep boolean

If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.

Default: false
times_max_timestep_piecewise_linear number[] | null

Time instants (s) defining the piecewise linear maximum time step.

Default: null
max_timestep_piecewise_linear number[] | null

Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

Default: null
CACCCSolveInitialconditions object

Level 3: Class for initial conditions

init_type string | null

Type of initialization for the simulation. (i) 'virgin' is the default type, the initial magnetic field is zero,(ii) 'pos_file' is to initialize from the solution of another solution, given by the solution_to_init_from entry, and (iii) 'uniform_field' is to initialize at a uniform field, which will be the applied field at the initial time of the simulation. Note that the uniform_field option does not allow any non-zero transport current (initialization from pos_file is needed for this).

Default: "virgin"
solution_to_init_from integer | string | null

Name xxx of the solution from which the simulation should be initialized. The file last_magnetic_field.pos of folder Solution_xxx will be used for the initial solution.It must be in the Geometry_.../Mesh_.../ folder in which the Solution_xxx will be saved.

Default: null
CACCCSolveNumericalparameters object

Level 3: Class for numerical parameters

relative_tolerance number | null

Tolerance on the relative change of the power indicator for the convergence criterion (1e-6 is usually a safe choice).

Default: 1e-6
voltage_per_meter_stopping_criterion number | null

If a non-zero value is given, the simulation will stop if the transport voltage per meter reaches this value (in absolute value).

Default: null
relaxation_factors boolean | null

Use of relaxation factors to help convergence (automatic selection based on the lowest residual).

Default: true
sine object

Level 4: Numerical parameters corresponding to the sine source

2 nested properties
timesteps_per_period number | null

Initial value for number of time steps (-) per period for the sine source.Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the sine source.

Default: null
piecewise object

Level 4: Numerical parameters corresponding to the piecewise source

6 nested properties
time_to_simulate number | null

Total time to simulate (s). Used for the piecewise source.

Default: null
timesteps_per_time_to_simulate number | null

If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.

Default: null
force_stepping_at_times_piecewise_linear boolean

If True, time-stepping will contain exactly the time instants that are inthe times_source_piecewise_linear list (to avoid truncation maximum applied field/current values).

Default: false
variable_max_timestep boolean

If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.

Default: false
times_max_timestep_piecewise_linear number[] | null

Time instants (s) defining the piecewise linear maximum time step.

Default: null
max_timestep_piecewise_linear number[] | null

Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

Default: null
CACCCSolveNumericalparametersPiecewise object

Level 4: Numerical parameters corresponding to the piecewise source

time_to_simulate number | null

Total time to simulate (s). Used for the piecewise source.

Default: null
timesteps_per_time_to_simulate number | null

If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.

Default: null
force_stepping_at_times_piecewise_linear boolean

If True, time-stepping will contain exactly the time instants that are inthe times_source_piecewise_linear list (to avoid truncation maximum applied field/current values).

Default: false
variable_max_timestep boolean

If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.

Default: false
times_max_timestep_piecewise_linear number[] | null

Time instants (s) defining the piecewise linear maximum time step.

Default: null
max_timestep_piecewise_linear number[] | null

Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

Default: null
CACCCSolveNumericalparametersSine object

Level 4: Numerical parameters corresponding to the sine source

timesteps_per_period number | null

Initial value for number of time steps (-) per period for the sine source.Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the sine source.

Default: null
CACCCSolveSourceparameters object

Level 3: Class for material properties

source_type string

Time evolution of applied current and magnetic field. Supported options are: sine, piecewise.

Default: "sine"
Values: "sine" "piecewise"
sine object

Level 4: Class for Sine source parameters

3 nested properties
frequency number | null

Frequency of the sine source (Hz).

Default: null
field_amplitude number | null

Amplitude of the sine field (T).

Default: null
current_amplitude number | null

Amplitude of the sine current (A).

Default: null
piecewise object

Level 4: Class for piecewise (linear) source parameters

7 nested properties
source_csv_file string | null

File name for the from_file source type defining the time evolution of current and field (in-phase).Multipliers are used for each of them.The file should contain two columns: 'time' (s) and 'value' (field/current (T/A)), with these headers.If this field is set, times, applied_fields_relative and transport_currents_relative are ignored.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources.Used only if source_csv_file is not set.Can be scaled by time_multiplier.

Default: null
applied_fields_relative number[] | null

Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'.Used only if source_csv_file is not set.

Default: null
transport_currents_relative number[] | null

Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'.Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values).Also used for the time values in the source_csv_file.

Default: null
applied_field_multiplier number | null

Multiplier for the applied fields in applied_fields_relative.Also used for the values in the source_csv_file.

Default: null
transport_current_multiplier number | null

Multiplier for the transport currents in transport_currents_relative.Also used for the values in the source_csv_file.

Default: null
field_angle_with_respect_to_normal_direction number | null

Angle of the source magnetic field with respect to the y-axis (normal to the tape) (degrees).

Default: null
CACCCSolveSourceparametersPiecewise object

Level 4: Class for piecewise (linear) source parameters

source_csv_file string | null

File name for the from_file source type defining the time evolution of current and field (in-phase).Multipliers are used for each of them.The file should contain two columns: 'time' (s) and 'value' (field/current (T/A)), with these headers.If this field is set, times, applied_fields_relative and transport_currents_relative are ignored.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources.Used only if source_csv_file is not set.Can be scaled by time_multiplier.

Default: null
applied_fields_relative number[] | null

Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'.Used only if source_csv_file is not set.

Default: null
transport_currents_relative number[] | null

Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'.Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values).Also used for the time values in the source_csv_file.

Default: null
applied_field_multiplier number | null

Multiplier for the applied fields in applied_fields_relative.Also used for the values in the source_csv_file.

Default: null
transport_current_multiplier number | null

Multiplier for the transport currents in transport_currents_relative.Also used for the values in the source_csv_file.

Default: null
CACCCSolveSourceparametersSine object

Level 4: Class for Sine source parameters

frequency number | null

Frequency of the sine source (Hz).

Default: null
field_amplitude number | null

Amplitude of the sine field (T).

Default: null
current_amplitude number | null

Amplitude of the sine current (A).

Default: null
CACRutherford object

Level 1: Class for FiQuS ConductorAC

type string required
Constant: "CACRutherford"
geometry object

Level 2: Class for cable geometry parameters

8 nested properties
io_settings object

Level 3: Class for Input/Output settings for the cable geometry

2 nested properties
load object

Level 3: Class for Input/Output settings for the cable geometry

save object

Level 3: Class for Input/Output settings for the cable geometry

point_snap_tolerance_relative_to_strand_diameter number | null

The maximum distance between two points, relative to the strand diameter, where the points are considered equal (i.e. they 'snap' together).

Default: null
min_roundness_factor number | null

Minimum roundness is the ratio between the min -and max radius for the corner circle-arcs.

Default: null
air_radius number | null

Radius of the air region (m).

Default: null
coating_corner_arc_radius number | null

Radius of the corner arcs of the coating (m).

Default: 0
coating_thickness number | null

Thickness of the coating (m).

Default: 0
keep_strand_area boolean | null

If True, the area of the strands are determined by the area of the strand described in 'conductors'. If False, the area of the strands are determined based on the cable geometry inputs.

Default: true
excitation_coils object

Level 3: Class for Input/Output settings for the cable geometry

3 nested properties
centers number[][] | null

List of center points for the centers of the excitations coil regions. Each center point is a list of three elements for x, y, and z (=0) coordinates.

Default: null
widths number[] | null

List of widths of the excitation coil regions.

Default: null
heights number[] | null

List of heights of the excitation coil regions.

Default: null
mesh object

Level 2: Class for FiQuS ConductorAC

4 nested properties
scaling_global number | null

Global scaling factor for mesh size.

Default: 1
strand_mesh_size_ratio number | null

Mesh size ratio for the strand, relative to the strand diameter.

Default: 1
coating_mesh_size_ratio number | null

Mesh size ratio for the coating, relative to the strand diameter.

Default: 1
air_boundary_mesh_size_ratio number | null

Mesh size ratio for the air boundary, relative to the strand diameter.

Default: 1
solve object

Level 2: Class for FiQuS ConductorAC

8 nested properties
pro_template string | null

Name of the .pro template file.

Default: null
conductor_name string | null

Name of the conductor.

Default: null
formulation_parameters object

Level 3: Class for finite element formulation parameters

3 nested properties
stranded_strands boolean

Are the strands solved as 'stranded conductors', i.e., with fixed source current density, and no eddy current effect? Put to True if we solve for homogenized strands.

Default: true
rohm boolean

Do we use the ROHM model to describe the stranded strand magnetization? This is only relevant with stranded strands, but can be used without (without much meaning). If fase, solves with permeability mu0.

Default: true
rohf boolean

Do we use the ROHF model to describe the stranded strand voltage and inductance? This is only possible with stranded strands. If stranded_strands=false, rohf is considered false as well.

Default: true
general_parameters object

Level 3: Class for general parameters

9 nested properties
temperature number

Temperature (K) of the strand.

Default: 1.9
superconductor_n_value number | null

n value for the power law (-), used in current sharing law.

Default: 30
superconductor_Ic number | null

Critical current of the strands (A) (e.g., typical value at T=1.9K and B=10T). Will be taken as a constant as in this model the field dependence is not included (the main purpose of the model is to verify the more efficient Homogenized Conductor model). Including field-dependence could be done but is not trivial because is mixes global and local quantities in this Rutherford model with strand discretized individually as stranded conductors.

Default: 350
matrix_resistance number | null

Resistance of the matrix (per unit length) (Ohm/m) for the current sharing law. Kept constant in this model (for simplicity).

Default: 0.0006536208
crossing_coupling_resistance number | null

Crossing coupling resistance (Ohm).

Default: 1e-6
adjacent_coupling_resistance number | null

Adjacent coupling resistance (Ohm).

Default: 1e-6
rho_coating number | null

Resistivity of coating domain outside of the strands (Ohm.m).

Default: 1e-7
rho_strands number | null

Resistivity of strands, when modelled as massive conductors (Ohm.m).

Default: 1e-12
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
initial_conditions object

Level 3: Class for initial conditions

2 nested properties
init_from_pos_file boolean

Do we initialize the solution at a non-zero field.

Default: false
pos_file_to_init_from string | null

Name of .pos file for magnetic field (A/m) from which the solution should be initialized. Should be in the Geometry_xxx/Mesh_xxx/ folder in which the Solution_xxx will be saved.

Default: null
frequency_domain_solver object

Level 3: Class for frequency domain solver settings

2 nested properties
enable boolean

Set True to enable the frequency domain solver.

Default: false
frequency_sweep object

Level 4: Class for frequency sweep settings

source_parameters object

Level 3: Class for material properties

6 nested properties
source_type string

Time evolution of applied current and magnetic field. Supported options are: sine, sine_with_DC, piecewise_linear, from_list.

Default: "sine"
Values: "sine" "piecewise"
parallel_resistor boolean | number | null

If False, no parallel resistor and the current source directly and only feeds the cable. If True, a resistor is placed in parallel with the cable, with a default resistance of 1 Ohm. If float (cannot be zero), this defines the value of the resistance.

Default: false
boundary_condition_type string

Boundary condition type. Supported options are: Natural, Essential. Do not use essential boundary condition with induced currents.

Default: "Natural"
sine object

Level 4: Class for Sine source parameters

piecewise object

Level 4: Class for piecewise (linear) source parameters

excitation_coils object

Level 4: Class for excitation coils

numerical_parameters object

Level 3: Class for numerical parameters

2 nested properties
sine object

Level 4: Numerical parameters corresponding to the sine source

piecewise object

Level 4: Numerical parameters corresponding to the piecewise source

postproc object

Level 2: Class for FiQuS ConductorAC

7 nested properties
generate_pos_files boolean

Set True to generate .pos-files during post-processing

Default: true
plot_instantaneous_power object

Level 3: Class with settings for generating plots of instantaneous power

4 nested properties
show boolean

Creates a plot for the calculated instantaneous AC loss (W/m) as a function of time (s).

Default: false
title string

Title for the plot.

Default: "Instantaneous Power"
save boolean

Set True to save the plot.

Default: false
save_file_name string

Name of the plot file.

Default: "instantaneous_power"
compute_current_per_filament boolean

Computes current in every filament, with decomposition into magnetization and transport current.

Default: false
save_last_current_density string | null

Saves the last current density field solution (out-of-plane) in the file given as a string. The '.pos' extension will be appended to it. Nothing is done if None. This can be for using the current density as an initial condition (but not implemented yet).

Default: null
save_last_magnetic_field string | null

Saves the last magnetic field solution (in-plane) in the file given as a string. The '.pos' extension will be appended to it. Nothing is done if None. This is for using the magnetic field as an initial condition for another resolution.

Default: null
cleanup object

Level 3: Class for cleanup settings

3 nested properties
remove_pre_file boolean

Set True to remove the .pre-file after post-processing, to save disk space.

Default: false
remove_res_file boolean

Set True to remove the .res-file after post-processing, to save disk space.

Default: false
remove_msh_file boolean

Set True to remove the .msh-file after post-processing, to save disk space.

Default: false
batch_postproc object

Level 3: Class for batch post-processing settings

6 nested properties
postProc_csv string | null

Name of the .csv file for post-processing (without file extension). This file specifies the simulations to be post-processed. The file is structured into three columns, specifying the folder names to access the simulation results: 'input.run.geometry', 'input.run.mesh' and 'input.run.solve'. Each row corresponds to a simulation to be post-processed.

Default: null
output_folder string | null

Batch post-processing creates a folder with the given name in the output directory, where all the plots are saved.

Default: null
filter object

Level 4: Field for filtering simulations based on simulation parameters for batch post-processing

sort object

Level 4: Field for sorting simulations based on simulation parameters for batch post-processing

loss_map object

Level 4: Class with settings for generating loss maps

plot2d object

Level 4: Class for 2D plot settings

CACRutherfordExcitationCoils object

Level 3: Class for Input/Output settings for the cable geometry

centers number[][] | null

List of center points for the centers of the excitations coil regions. Each center point is a list of three elements for x, y, and z (=0) coordinates.

Default: null
widths number[] | null

List of widths of the excitation coil regions.

Default: null
heights number[] | null

List of heights of the excitation coil regions.

Default: null
CACRutherfordGeometry object

Level 2: Class for cable geometry parameters

io_settings object

Level 3: Class for Input/Output settings for the cable geometry

2 nested properties
load object

Level 3: Class for Input/Output settings for the cable geometry

2 nested properties
load_from_yaml boolean | null

True to load cable geometry from yaml-file, false to create the geometry.

Default: null
filename string | null

Name of the file from which to load the cable geometry.

Default: null
save object

Level 3: Class for Input/Output settings for the cable geometry

2 nested properties
save_to_yaml boolean | null

True to save cable geometry to yaml-file, false to not save the geometry.

Default: null
filename string | null

Name of the file to which to save the cable geometry.

Default: null
point_snap_tolerance_relative_to_strand_diameter number | null

The maximum distance between two points, relative to the strand diameter, where the points are considered equal (i.e. they 'snap' together).

Default: null
min_roundness_factor number | null

Minimum roundness is the ratio between the min -and max radius for the corner circle-arcs.

Default: null
air_radius number | null

Radius of the air region (m).

Default: null
coating_corner_arc_radius number | null

Radius of the corner arcs of the coating (m).

Default: 0
coating_thickness number | null

Thickness of the coating (m).

Default: 0
keep_strand_area boolean | null

If True, the area of the strands are determined by the area of the strand described in 'conductors'. If False, the area of the strands are determined based on the cable geometry inputs.

Default: true
excitation_coils object

Level 3: Class for Input/Output settings for the cable geometry

3 nested properties
centers number[][] | null

List of center points for the centers of the excitations coil regions. Each center point is a list of three elements for x, y, and z (=0) coordinates.

Default: null
widths number[] | null

List of widths of the excitation coil regions.

Default: null
heights number[] | null

List of heights of the excitation coil regions.

Default: null
CACRutherfordIOsettings object

Level 3: Class for Input/Output settings for the cable geometry

load object

Level 3: Class for Input/Output settings for the cable geometry

2 nested properties
load_from_yaml boolean | null

True to load cable geometry from yaml-file, false to create the geometry.

Default: null
filename string | null

Name of the file from which to load the cable geometry.

Default: null
save object

Level 3: Class for Input/Output settings for the cable geometry

2 nested properties
save_to_yaml boolean | null

True to save cable geometry to yaml-file, false to not save the geometry.

Default: null
filename string | null

Name of the file to which to save the cable geometry.

Default: null
CACRutherfordIOsettingsLoad object

Level 3: Class for Input/Output settings for the cable geometry

load_from_yaml boolean | null

True to load cable geometry from yaml-file, false to create the geometry.

Default: null
filename string | null

Name of the file from which to load the cable geometry.

Default: null
CACRutherfordIOsettingsSave object

Level 3: Class for Input/Output settings for the cable geometry

save_to_yaml boolean | null

True to save cable geometry to yaml-file, false to not save the geometry.

Default: null
filename string | null

Name of the file to which to save the cable geometry.

Default: null
CACRutherfordMesh object

Level 2: Class for FiQuS ConductorAC

scaling_global number | null

Global scaling factor for mesh size.

Default: 1
strand_mesh_size_ratio number | null

Mesh size ratio for the strand, relative to the strand diameter.

Default: 1
coating_mesh_size_ratio number | null

Mesh size ratio for the coating, relative to the strand diameter.

Default: 1
air_boundary_mesh_size_ratio number | null

Mesh size ratio for the air boundary, relative to the strand diameter.

Default: 1
CACRutherfordPostproc object

Level 2: Class for FiQuS ConductorAC

generate_pos_files boolean

Set True to generate .pos-files during post-processing

Default: true
plot_instantaneous_power object

Level 3: Class with settings for generating plots of instantaneous power

4 nested properties
show boolean

Creates a plot for the calculated instantaneous AC loss (W/m) as a function of time (s).

Default: false
title string

Title for the plot.

Default: "Instantaneous Power"
save boolean

Set True to save the plot.

Default: false
save_file_name string

Name of the plot file.

Default: "instantaneous_power"
compute_current_per_filament boolean

Computes current in every filament, with decomposition into magnetization and transport current.

Default: false
save_last_current_density string | null

Saves the last current density field solution (out-of-plane) in the file given as a string. The '.pos' extension will be appended to it. Nothing is done if None. This can be for using the current density as an initial condition (but not implemented yet).

Default: null
save_last_magnetic_field string | null

Saves the last magnetic field solution (in-plane) in the file given as a string. The '.pos' extension will be appended to it. Nothing is done if None. This is for using the magnetic field as an initial condition for another resolution.

Default: null
cleanup object

Level 3: Class for cleanup settings

3 nested properties
remove_pre_file boolean

Set True to remove the .pre-file after post-processing, to save disk space.

Default: false
remove_res_file boolean

Set True to remove the .res-file after post-processing, to save disk space.

Default: false
remove_msh_file boolean

Set True to remove the .msh-file after post-processing, to save disk space.

Default: false
batch_postproc object

Level 3: Class for batch post-processing settings

6 nested properties
postProc_csv string | null

Name of the .csv file for post-processing (without file extension). This file specifies the simulations to be post-processed. The file is structured into three columns, specifying the folder names to access the simulation results: 'input.run.geometry', 'input.run.mesh' and 'input.run.solve'. Each row corresponds to a simulation to be post-processed.

Default: null
output_folder string | null

Batch post-processing creates a folder with the given name in the output directory, where all the plots are saved.

Default: null
filter object

Level 4: Field for filtering simulations based on simulation parameters for batch post-processing

2 nested properties
apply_filter boolean

Set True to filter simulations by parameters from the input YAML-file.

Default: false
filter_criterion string | null

Criterion used to filter simulations based on simulation parameters. For example will '<<solve.source_parameters.sine.frequency>> > 100' disregard simulations done with frequencies lower than 100Hz.

Default: null
sort object

Level 4: Field for sorting simulations based on simulation parameters for batch post-processing

2 nested properties
apply_sort boolean

Set True to sort simulations.

Default: false
sort_key string | null

Criterion used to sort simulations based on simulation parameters. For example will 'sd.total_power_per_cycle['TotalLoss'] sort simulations based on the total loss.

Default: null
loss_map object

Level 4: Class with settings for generating loss maps

21 nested properties
produce_loss_map boolean

Set True to produce a loss map.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "loss_map"
x_val string | null

Parameter to be plotted on the x-axis. This field corresponds to a parameter in the input YAML-file. E.g. 'solve.source_parameters.sine.frequency' will plot the loss map for different frequencies.

Default: null
y_val string | null

Parameter to be plotted on the y-axis. This field corresponds to a parameter in the input YAML-file. E.g. 'solve.source_parameters.sine.field_amplitude' will plot the loss map for different applied field amplitudes.

Default: null
x_steps integer

Number of steps on the x-axis.

Default: 20
y_steps integer

Number of steps on the y-axis.

Default: 20
loss_type string

Type of loss to be plotted. Supported options are: TotalLoss, FilamentLoss, CouplingLoss, EddyLoss.

Default: "TotalLoss"
Values: "TotalLoss" "FilamentLoss" "CouplingLoss" "EddyLoss"
x_log boolean

Set True to plot x-axis in log-scale.

Default: true
y_log boolean

Set True to plot y-axis in log-scale.

Default: true
loss_log boolean

Set True to plot loss in log-scale.

Default: true
x_norm number

Normalization factor for x-axis.

Default: 1
y_norm number

Normalization factor for y-axis.

Default: 1
loss_norm number

Normalization factor for the AC-loss.

Default: 1
show_datapoints boolean

Set True to show markers for all the datapoints in the loss map.

Default: true
title string | null

Title for the plot.

Default: null
xlabel string | null

Label for the x-axis.

Default: null
ylabel string | null

Label for the y-axis.

Default: null
show_loss_type_dominance_contour boolean

Set True to plot a contour curve separating regions where different loss types dominate.

Default: false
cross_section object

Level 5: Class with settings for plotting a cross-section of the loss map.

cross_section_sweep object

Level 5: Class with settings for animating a cross-section sweep of the loss map along one axis.

plot2d object

Level 4: Class for 2D plot settings

14 nested properties
produce_plot2d boolean

Set True to produce a 2D plot.

Default: false
combined_plot boolean

Set True to produce a combined plot for all simulations. If False, a separate plot is produced for each simulation.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "plot2d"
x_val string | null

Value to be plotted on the x-axis. Parameters in the input YAML-file and class-variables from the plotter 'SimulationData' class can be accessed trough the notation << . >>. E.g. '<<solve.source_parameters.sine.frequency>>' will create a 2D plot with frequency on the x-axis. '<

Default: null
y_vals string[] | null

List of values to be plotted on the y-axis. Parameters in the input YAML-file and class-variables from the plotter 'SimulationData' class can be accessed trough the notation << . >>. E.g. total AC-loss per cycle can be accessed as ['<<total_power_per_cycle['TotalLoss_dyn']>>'].

Default: null
labels string[] | null

List of labels for the plot. Each label corresponding to a value in y_val.

Default: null
linestyle string | null

Linestyle for the plot.

Default: null
title string | null

Title for the plot.

Default: null
xlabel string | null

Label for the x-axis.

Default: null
ylabel string | null

Label for the y-axis.

Default: null
x_log boolean

Set True to plot x-axis in log-scale.

Default: false
y_log boolean

Set True to plot y-axis in log-scale.

Default: false
legend boolean

Set True to show legend.

Default: true
CACRutherfordPostprocBatchpostproc object

Level 3: Class for batch post-processing settings

postProc_csv string | null

Name of the .csv file for post-processing (without file extension). This file specifies the simulations to be post-processed. The file is structured into three columns, specifying the folder names to access the simulation results: 'input.run.geometry', 'input.run.mesh' and 'input.run.solve'. Each row corresponds to a simulation to be post-processed.

Default: null
output_folder string | null

Batch post-processing creates a folder with the given name in the output directory, where all the plots are saved.

Default: null
filter object

Level 4: Field for filtering simulations based on simulation parameters for batch post-processing

2 nested properties
apply_filter boolean

Set True to filter simulations by parameters from the input YAML-file.

Default: false
filter_criterion string | null

Criterion used to filter simulations based on simulation parameters. For example will '<<solve.source_parameters.sine.frequency>> > 100' disregard simulations done with frequencies lower than 100Hz.

Default: null
sort object

Level 4: Field for sorting simulations based on simulation parameters for batch post-processing

2 nested properties
apply_sort boolean

Set True to sort simulations.

Default: false
sort_key string | null

Criterion used to sort simulations based on simulation parameters. For example will 'sd.total_power_per_cycle['TotalLoss'] sort simulations based on the total loss.

Default: null
loss_map object

Level 4: Class with settings for generating loss maps

21 nested properties
produce_loss_map boolean

Set True to produce a loss map.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "loss_map"
x_val string | null

Parameter to be plotted on the x-axis. This field corresponds to a parameter in the input YAML-file. E.g. 'solve.source_parameters.sine.frequency' will plot the loss map for different frequencies.

Default: null
y_val string | null

Parameter to be plotted on the y-axis. This field corresponds to a parameter in the input YAML-file. E.g. 'solve.source_parameters.sine.field_amplitude' will plot the loss map for different applied field amplitudes.

Default: null
x_steps integer

Number of steps on the x-axis.

Default: 20
y_steps integer

Number of steps on the y-axis.

Default: 20
loss_type string

Type of loss to be plotted. Supported options are: TotalLoss, FilamentLoss, CouplingLoss, EddyLoss.

Default: "TotalLoss"
Values: "TotalLoss" "FilamentLoss" "CouplingLoss" "EddyLoss"
x_log boolean

Set True to plot x-axis in log-scale.

Default: true
y_log boolean

Set True to plot y-axis in log-scale.

Default: true
loss_log boolean

Set True to plot loss in log-scale.

Default: true
x_norm number

Normalization factor for x-axis.

Default: 1
y_norm number

Normalization factor for y-axis.

Default: 1
loss_norm number

Normalization factor for the AC-loss.

Default: 1
show_datapoints boolean

Set True to show markers for all the datapoints in the loss map.

Default: true
title string | null

Title for the plot.

Default: null
xlabel string | null

Label for the x-axis.

Default: null
ylabel string | null

Label for the y-axis.

Default: null
show_loss_type_dominance_contour boolean

Set True to plot a contour curve separating regions where different loss types dominate.

Default: false
cross_section object

Level 5: Class with settings for plotting a cross-section of the loss map.

7 nested properties
plot_cross_section boolean

Set True to plot a cross-section of the loss map.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "cross_section"
axis_to_cut string

Axis to cut for the cross-section.

Default: "x"
cut_value number

Value of the axis to cut for the cross-section.

Default: 0
ylabel string

Label of the y-axis.

Default: "Loss"
title string | null

Title of the plot. The placeholder <<cut_value>> can be used to indicate the value of the cut axis.

Default: null
cross_section_sweep object

Level 5: Class with settings for animating a cross-section sweep of the loss map along one axis.

6 nested properties
animate_cross_section_sweep boolean

Set True to animate a cross-section sweep of the loss map along one axis.

Default: false
save_plot boolean

Set True to save the animation.

Default: false
filename string

Name of the animation file.

Default: "crossSectionSweep"
axis_to_sweep string

Axis to sweep for the animation.

Default: "x"
ylabel string

Label of the y-axis.

Default: "Loss"
title string | null

Title of the plot. Use <<sweep_value>> to indicate the value of the sweep axis.

Default: null
plot2d object

Level 4: Class for 2D plot settings

14 nested properties
produce_plot2d boolean

Set True to produce a 2D plot.

Default: false
combined_plot boolean

Set True to produce a combined plot for all simulations. If False, a separate plot is produced for each simulation.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "plot2d"
x_val string | null

Value to be plotted on the x-axis. Parameters in the input YAML-file and class-variables from the plotter 'SimulationData' class can be accessed trough the notation << . >>. E.g. '<<solve.source_parameters.sine.frequency>>' will create a 2D plot with frequency on the x-axis. '<

Default: null
y_vals string[] | null

List of values to be plotted on the y-axis. Parameters in the input YAML-file and class-variables from the plotter 'SimulationData' class can be accessed trough the notation << . >>. E.g. total AC-loss per cycle can be accessed as ['<<total_power_per_cycle['TotalLoss_dyn']>>'].

Default: null
labels string[] | null

List of labels for the plot. Each label corresponding to a value in y_val.

Default: null
linestyle string | null

Linestyle for the plot.

Default: null
title string | null

Title for the plot.

Default: null
xlabel string | null

Label for the x-axis.

Default: null
ylabel string | null

Label for the y-axis.

Default: null
x_log boolean

Set True to plot x-axis in log-scale.

Default: false
y_log boolean

Set True to plot y-axis in log-scale.

Default: false
legend boolean

Set True to show legend.

Default: true
CACRutherfordPostprocBatchpostprocFilter object

Level 4: Field for filtering simulations based on simulation parameters for batch post-processing

apply_filter boolean

Set True to filter simulations by parameters from the input YAML-file.

Default: false
filter_criterion string | null

Criterion used to filter simulations based on simulation parameters. For example will '<<solve.source_parameters.sine.frequency>> > 100' disregard simulations done with frequencies lower than 100Hz.

Default: null
CACRutherfordPostprocBatchpostprocLossMap object

Level 4: Class with settings for generating loss maps

produce_loss_map boolean

Set True to produce a loss map.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "loss_map"
x_val string | null

Parameter to be plotted on the x-axis. This field corresponds to a parameter in the input YAML-file. E.g. 'solve.source_parameters.sine.frequency' will plot the loss map for different frequencies.

Default: null
y_val string | null

Parameter to be plotted on the y-axis. This field corresponds to a parameter in the input YAML-file. E.g. 'solve.source_parameters.sine.field_amplitude' will plot the loss map for different applied field amplitudes.

Default: null
x_steps integer

Number of steps on the x-axis.

Default: 20
y_steps integer

Number of steps on the y-axis.

Default: 20
loss_type string

Type of loss to be plotted. Supported options are: TotalLoss, FilamentLoss, CouplingLoss, EddyLoss.

Default: "TotalLoss"
Values: "TotalLoss" "FilamentLoss" "CouplingLoss" "EddyLoss"
x_log boolean

Set True to plot x-axis in log-scale.

Default: true
y_log boolean

Set True to plot y-axis in log-scale.

Default: true
loss_log boolean

Set True to plot loss in log-scale.

Default: true
x_norm number

Normalization factor for x-axis.

Default: 1
y_norm number

Normalization factor for y-axis.

Default: 1
loss_norm number

Normalization factor for the AC-loss.

Default: 1
show_datapoints boolean

Set True to show markers for all the datapoints in the loss map.

Default: true
title string | null

Title for the plot.

Default: null
xlabel string | null

Label for the x-axis.

Default: null
ylabel string | null

Label for the y-axis.

Default: null
show_loss_type_dominance_contour boolean

Set True to plot a contour curve separating regions where different loss types dominate.

Default: false
cross_section object

Level 5: Class with settings for plotting a cross-section of the loss map.

7 nested properties
plot_cross_section boolean

Set True to plot a cross-section of the loss map.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "cross_section"
axis_to_cut string

Axis to cut for the cross-section.

Default: "x"
cut_value number

Value of the axis to cut for the cross-section.

Default: 0
ylabel string

Label of the y-axis.

Default: "Loss"
title string | null

Title of the plot. The placeholder <<cut_value>> can be used to indicate the value of the cut axis.

Default: null
cross_section_sweep object

Level 5: Class with settings for animating a cross-section sweep of the loss map along one axis.

6 nested properties
animate_cross_section_sweep boolean

Set True to animate a cross-section sweep of the loss map along one axis.

Default: false
save_plot boolean

Set True to save the animation.

Default: false
filename string

Name of the animation file.

Default: "crossSectionSweep"
axis_to_sweep string

Axis to sweep for the animation.

Default: "x"
ylabel string

Label of the y-axis.

Default: "Loss"
title string | null

Title of the plot. Use <<sweep_value>> to indicate the value of the sweep axis.

Default: null
CACRutherfordPostprocBatchpostprocLossMapCrossSection object

Level 5: Class with settings for plotting a cross-section of the loss map.

plot_cross_section boolean

Set True to plot a cross-section of the loss map.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "cross_section"
axis_to_cut string

Axis to cut for the cross-section.

Default: "x"
cut_value number

Value of the axis to cut for the cross-section.

Default: 0
ylabel string

Label of the y-axis.

Default: "Loss"
title string | null

Title of the plot. The placeholder <<cut_value>> can be used to indicate the value of the cut axis.

Default: null
CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep object

Level 5: Class with settings for animating a cross-section sweep of the loss map along one axis.

animate_cross_section_sweep boolean

Set True to animate a cross-section sweep of the loss map along one axis.

Default: false
save_plot boolean

Set True to save the animation.

Default: false
filename string

Name of the animation file.

Default: "crossSectionSweep"
axis_to_sweep string

Axis to sweep for the animation.

Default: "x"
ylabel string

Label of the y-axis.

Default: "Loss"
title string | null

Title of the plot. Use <<sweep_value>> to indicate the value of the sweep axis.

Default: null
CACRutherfordPostprocBatchpostprocPlot2d object

Level 4: Class for 2D plot settings

produce_plot2d boolean

Set True to produce a 2D plot.

Default: false
combined_plot boolean

Set True to produce a combined plot for all simulations. If False, a separate plot is produced for each simulation.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "plot2d"
x_val string | null

Value to be plotted on the x-axis. Parameters in the input YAML-file and class-variables from the plotter 'SimulationData' class can be accessed trough the notation << . >>. E.g. '<<solve.source_parameters.sine.frequency>>' will create a 2D plot with frequency on the x-axis. '<

Default: null
y_vals string[] | null

List of values to be plotted on the y-axis. Parameters in the input YAML-file and class-variables from the plotter 'SimulationData' class can be accessed trough the notation << . >>. E.g. total AC-loss per cycle can be accessed as ['<<total_power_per_cycle['TotalLoss_dyn']>>'].

Default: null
labels string[] | null

List of labels for the plot. Each label corresponding to a value in y_val.

Default: null
linestyle string | null

Linestyle for the plot.

Default: null
title string | null

Title for the plot.

Default: null
xlabel string | null

Label for the x-axis.

Default: null
ylabel string | null

Label for the y-axis.

Default: null
x_log boolean

Set True to plot x-axis in log-scale.

Default: false
y_log boolean

Set True to plot y-axis in log-scale.

Default: false
legend boolean

Set True to show legend.

Default: true
CACRutherfordPostprocBatchpostprocSort object

Level 4: Field for sorting simulations based on simulation parameters for batch post-processing

apply_sort boolean

Set True to sort simulations.

Default: false
sort_key string | null

Criterion used to sort simulations based on simulation parameters. For example will 'sd.total_power_per_cycle['TotalLoss'] sort simulations based on the total loss.

Default: null
CACRutherfordPostprocCleanup object

Level 3: Class for cleanup settings

remove_pre_file boolean

Set True to remove the .pre-file after post-processing, to save disk space.

Default: false
remove_res_file boolean

Set True to remove the .res-file after post-processing, to save disk space.

Default: false
remove_msh_file boolean

Set True to remove the .msh-file after post-processing, to save disk space.

Default: false
CACRutherfordPostprocPlotInstPower object

Level 3: Class with settings for generating plots of instantaneous power

show boolean

Creates a plot for the calculated instantaneous AC loss (W/m) as a function of time (s).

Default: false
title string

Title for the plot.

Default: "Instantaneous Power"
save boolean

Set True to save the plot.

Default: false
save_file_name string

Name of the plot file.

Default: "instantaneous_power"
CACRutherfordSolve object

Level 2: Class for FiQuS ConductorAC

pro_template string | null

Name of the .pro template file.

Default: null
conductor_name string | null

Name of the conductor.

Default: null
formulation_parameters object

Level 3: Class for finite element formulation parameters

3 nested properties
stranded_strands boolean

Are the strands solved as 'stranded conductors', i.e., with fixed source current density, and no eddy current effect? Put to True if we solve for homogenized strands.

Default: true
rohm boolean

Do we use the ROHM model to describe the stranded strand magnetization? This is only relevant with stranded strands, but can be used without (without much meaning). If fase, solves with permeability mu0.

Default: true
rohf boolean

Do we use the ROHF model to describe the stranded strand voltage and inductance? This is only possible with stranded strands. If stranded_strands=false, rohf is considered false as well.

Default: true
general_parameters object

Level 3: Class for general parameters

9 nested properties
temperature number

Temperature (K) of the strand.

Default: 1.9
superconductor_n_value number | null

n value for the power law (-), used in current sharing law.

Default: 30
superconductor_Ic number | null

Critical current of the strands (A) (e.g., typical value at T=1.9K and B=10T). Will be taken as a constant as in this model the field dependence is not included (the main purpose of the model is to verify the more efficient Homogenized Conductor model). Including field-dependence could be done but is not trivial because is mixes global and local quantities in this Rutherford model with strand discretized individually as stranded conductors.

Default: 350
matrix_resistance number | null

Resistance of the matrix (per unit length) (Ohm/m) for the current sharing law. Kept constant in this model (for simplicity).

Default: 0.0006536208
crossing_coupling_resistance number | null

Crossing coupling resistance (Ohm).

Default: 1e-6
adjacent_coupling_resistance number | null

Adjacent coupling resistance (Ohm).

Default: 1e-6
rho_coating number | null

Resistivity of coating domain outside of the strands (Ohm.m).

Default: 1e-7
rho_strands number | null

Resistivity of strands, when modelled as massive conductors (Ohm.m).

Default: 1e-12
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
initial_conditions object

Level 3: Class for initial conditions

2 nested properties
init_from_pos_file boolean

Do we initialize the solution at a non-zero field.

Default: false
pos_file_to_init_from string | null

Name of .pos file for magnetic field (A/m) from which the solution should be initialized. Should be in the Geometry_xxx/Mesh_xxx/ folder in which the Solution_xxx will be saved.

Default: null
frequency_domain_solver object

Level 3: Class for frequency domain solver settings

2 nested properties
enable boolean

Set True to enable the frequency domain solver.

Default: false
frequency_sweep object

Level 4: Class for frequency sweep settings

4 nested properties
run_sweep boolean

Set True to run a frequency sweep (logarithmic).

Default: false
start_frequency number

Start frequency (Hz) of the sweep.

Default: 1
end_frequency number

End frequency (Hz) of the sweep.

Default: 100
number_of_frequencies integer

Number of frequencies in the sweep.

Default: 10
source_parameters object

Level 3: Class for material properties

6 nested properties
source_type string

Time evolution of applied current and magnetic field. Supported options are: sine, sine_with_DC, piecewise_linear, from_list.

Default: "sine"
Values: "sine" "piecewise"
parallel_resistor boolean | number | null

If False, no parallel resistor and the current source directly and only feeds the cable. If True, a resistor is placed in parallel with the cable, with a default resistance of 1 Ohm. If float (cannot be zero), this defines the value of the resistance.

Default: false
boundary_condition_type string

Boundary condition type. Supported options are: Natural, Essential. Do not use essential boundary condition with induced currents.

Default: "Natural"
sine object

Level 4: Class for Sine source parameters

5 nested properties
frequency number | null

Frequency of the sine source (Hz).

Default: null
field_amplitude number | null

Amplitude of the sine field (T).

Default: null
current_amplitude number | null

Amplitude of the sine current (A).

Default: null
field_angle number | null

Angle of the sine field direction, with respect to the x-axis (degrees).

Default: 90
superimposed_DC object

Level 5: Class for superimposed DC field or current parameters for the sine source

piecewise object

Level 4: Class for piecewise (linear) source parameters

8 nested properties
source_csv_file string | null

File name for the from_file source type defining the time evolution of current and field (in-phase). Multipliers are used for each of them. The file should contain two columns: 'time' (s) and 'value' (field/current (T/A)), with these headers. If this field is set, times, applied_fields_relative and transport_currents_relative are ignored.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.

Default: null
applied_fields_relative number[] | null

Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
transport_currents_relative number[] | null

Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.

Default: null
applied_field_multiplier number | null

Multiplier for the applied fields in applied_fields_relative. Also used for the values in the source_csv_file.

Default: null
transport_current_multiplier number | null

Multiplier for the transport currents in transport_currents_relative. Also used for the values in the source_csv_file.

Default: null
field_angle number | null

Angle of the sine field direction, with respect to the x-axis (degrees).

Default: 90
excitation_coils object

Level 4: Class for excitation coils

2 nested properties
enable boolean | null

Are the excitation coils used in the model? (they can exist in the geometry and mesh but be ignored at the solution stage)

Default: false
source_csv_file string | null

The file should contain a first column with 'time' (s) and one additional column per excitation coil with 'value', which is the TOTAL current (A) per coil (with appropriate sign).

Default: null
numerical_parameters object

Level 3: Class for numerical parameters

2 nested properties
sine object

Level 4: Numerical parameters corresponding to the sine source

2 nested properties
timesteps_per_period number | null

Initial value for number of time steps (-) per period for the sine source. Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the sine source.

Default: null
piecewise object

Level 4: Numerical parameters corresponding to the piecewise source

6 nested properties
time_to_simulate number | null

Total time to simulate (s). Used for the piecewise source.

Default: null
timesteps_per_time_to_simulate number | null

If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.

Default: null
force_stepping_at_times_piecewise_linear boolean

If True, time-stepping will contain exactly the time instants that are in the times_source_piecewise_linear list (to avoid truncation maximum applied field/current values).

Default: false
variable_max_timestep boolean

If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.

Default: false
times_max_timestep_piecewise_linear number[] | null

Time instants (s) defining the piecewise linear maximum time step.

Default: null
max_timestep_piecewise_linear number[] | null

Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

Default: null
CACRutherfordSolveFormulationparameters object

Level 3: Class for finite element formulation parameters

stranded_strands boolean

Are the strands solved as 'stranded conductors', i.e., with fixed source current density, and no eddy current effect? Put to True if we solve for homogenized strands.

Default: true
rohm boolean

Do we use the ROHM model to describe the stranded strand magnetization? This is only relevant with stranded strands, but can be used without (without much meaning). If fase, solves with permeability mu0.

Default: true
rohf boolean

Do we use the ROHF model to describe the stranded strand voltage and inductance? This is only possible with stranded strands. If stranded_strands=false, rohf is considered false as well.

Default: true
CACRutherfordSolveFrequencydomainsolver object

Level 3: Class for frequency domain solver settings

enable boolean

Set True to enable the frequency domain solver.

Default: false
frequency_sweep object

Level 4: Class for frequency sweep settings

4 nested properties
run_sweep boolean

Set True to run a frequency sweep (logarithmic).

Default: false
start_frequency number

Start frequency (Hz) of the sweep.

Default: 1
end_frequency number

End frequency (Hz) of the sweep.

Default: 100
number_of_frequencies integer

Number of frequencies in the sweep.

Default: 10
CACRutherfordSolveFrequencydomainsolverFrequencysweep object

Level 4: Class for frequency sweep settings

run_sweep boolean

Set True to run a frequency sweep (logarithmic).

Default: false
start_frequency number

Start frequency (Hz) of the sweep.

Default: 1
end_frequency number

End frequency (Hz) of the sweep.

Default: 100
number_of_frequencies integer

Number of frequencies in the sweep.

Default: 10
CACRutherfordSolveGeneralparameters object

Level 3: Class for general parameters

temperature number

Temperature (K) of the strand.

Default: 1.9
superconductor_n_value number | null

n value for the power law (-), used in current sharing law.

Default: 30
superconductor_Ic number | null

Critical current of the strands (A) (e.g., typical value at T=1.9K and B=10T). Will be taken as a constant as in this model the field dependence is not included (the main purpose of the model is to verify the more efficient Homogenized Conductor model). Including field-dependence could be done but is not trivial because is mixes global and local quantities in this Rutherford model with strand discretized individually as stranded conductors.

Default: 350
matrix_resistance number | null

Resistance of the matrix (per unit length) (Ohm/m) for the current sharing law. Kept constant in this model (for simplicity).

Default: 0.0006536208
crossing_coupling_resistance number | null

Crossing coupling resistance (Ohm).

Default: 1e-6
adjacent_coupling_resistance number | null

Adjacent coupling resistance (Ohm).

Default: 1e-6
rho_coating number | null

Resistivity of coating domain outside of the strands (Ohm.m).

Default: 1e-7
rho_strands number | null

Resistivity of strands, when modelled as massive conductors (Ohm.m).

Default: 1e-12
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
CACRutherfordSolveInitialConditions object

Level 3: Class for initial conditions

init_from_pos_file boolean

Do we initialize the solution at a non-zero field.

Default: false
pos_file_to_init_from string | null

Name of .pos file for magnetic field (A/m) from which the solution should be initialized. Should be in the Geometry_xxx/Mesh_xxx/ folder in which the Solution_xxx will be saved.

Default: null
CACRutherfordSolveNumericalparameters object

Level 3: Class for numerical parameters

sine object

Level 4: Numerical parameters corresponding to the sine source

2 nested properties
timesteps_per_period number | null

Initial value for number of time steps (-) per period for the sine source. Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the sine source.

Default: null
piecewise object

Level 4: Numerical parameters corresponding to the piecewise source

6 nested properties
time_to_simulate number | null

Total time to simulate (s). Used for the piecewise source.

Default: null
timesteps_per_time_to_simulate number | null

If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.

Default: null
force_stepping_at_times_piecewise_linear boolean

If True, time-stepping will contain exactly the time instants that are in the times_source_piecewise_linear list (to avoid truncation maximum applied field/current values).

Default: false
variable_max_timestep boolean

If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.

Default: false
times_max_timestep_piecewise_linear number[] | null

Time instants (s) defining the piecewise linear maximum time step.

Default: null
max_timestep_piecewise_linear number[] | null

Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

Default: null
CACRutherfordSolveNumericalparametersPiecewise object

Level 4: Numerical parameters corresponding to the piecewise source

time_to_simulate number | null

Total time to simulate (s). Used for the piecewise source.

Default: null
timesteps_per_time_to_simulate number | null

If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.

Default: null
force_stepping_at_times_piecewise_linear boolean

If True, time-stepping will contain exactly the time instants that are in the times_source_piecewise_linear list (to avoid truncation maximum applied field/current values).

Default: false
variable_max_timestep boolean

If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.

Default: false
times_max_timestep_piecewise_linear number[] | null

Time instants (s) defining the piecewise linear maximum time step.

Default: null
max_timestep_piecewise_linear number[] | null

Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

Default: null
CACRutherfordSolveNumericalparametersSine object

Level 4: Numerical parameters corresponding to the sine source

timesteps_per_period number | null

Initial value for number of time steps (-) per period for the sine source. Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the sine source.

Default: null
CACRutherfordSolveSourceparameters object

Level 3: Class for material properties

source_type string

Time evolution of applied current and magnetic field. Supported options are: sine, sine_with_DC, piecewise_linear, from_list.

Default: "sine"
Values: "sine" "piecewise"
parallel_resistor boolean | number | null

If False, no parallel resistor and the current source directly and only feeds the cable. If True, a resistor is placed in parallel with the cable, with a default resistance of 1 Ohm. If float (cannot be zero), this defines the value of the resistance.

Default: false
boundary_condition_type string

Boundary condition type. Supported options are: Natural, Essential. Do not use essential boundary condition with induced currents.

Default: "Natural"
sine object

Level 4: Class for Sine source parameters

5 nested properties
frequency number | null

Frequency of the sine source (Hz).

Default: null
field_amplitude number | null

Amplitude of the sine field (T).

Default: null
current_amplitude number | null

Amplitude of the sine current (A).

Default: null
field_angle number | null

Angle of the sine field direction, with respect to the x-axis (degrees).

Default: 90
superimposed_DC object

Level 5: Class for superimposed DC field or current parameters for the sine source

2 nested properties
field_magnitude number | null

DC field magnitude (T) (direction along y-axis). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC field is used.

Default: 0.0
current_magnitude number | null

DC current magnitude (A). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC current is used.

Default: 0.0
piecewise object

Level 4: Class for piecewise (linear) source parameters

8 nested properties
source_csv_file string | null

File name for the from_file source type defining the time evolution of current and field (in-phase). Multipliers are used for each of them. The file should contain two columns: 'time' (s) and 'value' (field/current (T/A)), with these headers. If this field is set, times, applied_fields_relative and transport_currents_relative are ignored.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.

Default: null
applied_fields_relative number[] | null

Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
transport_currents_relative number[] | null

Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.

Default: null
applied_field_multiplier number | null

Multiplier for the applied fields in applied_fields_relative. Also used for the values in the source_csv_file.

Default: null
transport_current_multiplier number | null

Multiplier for the transport currents in transport_currents_relative. Also used for the values in the source_csv_file.

Default: null
field_angle number | null

Angle of the sine field direction, with respect to the x-axis (degrees).

Default: 90
excitation_coils object

Level 4: Class for excitation coils

2 nested properties
enable boolean | null

Are the excitation coils used in the model? (they can exist in the geometry and mesh but be ignored at the solution stage)

Default: false
source_csv_file string | null

The file should contain a first column with 'time' (s) and one additional column per excitation coil with 'value', which is the TOTAL current (A) per coil (with appropriate sign).

Default: null
CACRutherfordSolveSourceparametersExcitationCoils object

Level 4: Class for excitation coils

enable boolean | null

Are the excitation coils used in the model? (they can exist in the geometry and mesh but be ignored at the solution stage)

Default: false
source_csv_file string | null

The file should contain a first column with 'time' (s) and one additional column per excitation coil with 'value', which is the TOTAL current (A) per coil (with appropriate sign).

Default: null
CACRutherfordSolveSourceparametersPiecewise object

Level 4: Class for piecewise (linear) source parameters

source_csv_file string | null

File name for the from_file source type defining the time evolution of current and field (in-phase). Multipliers are used for each of them. The file should contain two columns: 'time' (s) and 'value' (field/current (T/A)), with these headers. If this field is set, times, applied_fields_relative and transport_currents_relative are ignored.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.

Default: null
applied_fields_relative number[] | null

Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
transport_currents_relative number[] | null

Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.

Default: null
applied_field_multiplier number | null

Multiplier for the applied fields in applied_fields_relative. Also used for the values in the source_csv_file.

Default: null
transport_current_multiplier number | null

Multiplier for the transport currents in transport_currents_relative. Also used for the values in the source_csv_file.

Default: null
field_angle number | null

Angle of the sine field direction, with respect to the x-axis (degrees).

Default: 90
CACRutherfordSolveSourceparametersSine object

Level 4: Class for Sine source parameters

frequency number | null

Frequency of the sine source (Hz).

Default: null
field_amplitude number | null

Amplitude of the sine field (T).

Default: null
current_amplitude number | null

Amplitude of the sine current (A).

Default: null
field_angle number | null

Angle of the sine field direction, with respect to the x-axis (degrees).

Default: 90
superimposed_DC object

Level 5: Class for superimposed DC field or current parameters for the sine source

2 nested properties
field_magnitude number | null

DC field magnitude (T) (direction along y-axis). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC field is used.

Default: 0.0
current_magnitude number | null

DC current magnitude (A). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC current is used.

Default: 0.0
CACRutherfordSolveSourceparametersSineSuperimposedDC object

Level 5: Class for superimposed DC field or current parameters for the sine source

field_magnitude number | null

DC field magnitude (T) (direction along y-axis). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC field is used.

Default: 0.0
current_magnitude number | null

DC current magnitude (A). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC current is used.

Default: 0.0
CACStrand object

Level 1: Class for FiQuS ConductorAC

type string required
Constant: "CACStrand"
geometry object

Level 2: Class for strand geometry parameters

8 nested properties
io_settings object

Level 2: Class for Input/Output settings for the cable geometry

2 nested properties
load object

Level 3: Class for Input/Output settings for the cable geometry

save object

Level 3: Class for Input/Output settings for the cable geometry

hexagonal_filaments boolean | null

Field for specifying the shape of the filaments. True for hexagonal, False for circular.

Default: null
hexagonal_holes boolean | null

Field for specifying the shape of the filament holes. True for hexagonal, False for circular.

Default: null
filament_circular_distribution boolean | null

Field for specifying the geometrical distribution of the filaments. Set True to distribute the filaments in a circular pattern and False to distribute them in a hexagonal pattern.

Default: null
air_radius number | null

Radius of the circular numerical air region (m).

Default: null
type string

Type of model geometry which will be generated. Supported options are: strand_only, periodic_squarestrand_only models the strand in an circular air domain (natural boundary condition)periodic_square models the strand in an square air domain (periodic boundary condition)coil models a single coil winding in open space (uses hybrid boundary conditions)

Default: "strand_only"
Values: "strand_only" "periodic_square" "coil"
coil_radius number | null

used in geometry type 'coil' to determine the distance from strand center to mirroring plane (m). Should always be bigger than strand radius.

Default: null
rotate_angle number | null

Rotates strand geometry by specified angle in deg counterclockwise around the z axis and x=0 and y=0

Default: null
mesh object

Level 2: Class for FiQuS ConductorAC

4 nested properties
scaling_global number | null

Global scaling factor for mesh size.

Default: 1
filaments object

Level 3: Class for FiQuS ConductorAC

5 nested properties
boundary_mesh_size_ratio number | null

Mesh size at filament boundaries, relative to the radius of the filaments. E.g. 0.1 means that the mesh size is 0.1 times the filament radius.

Default: null
center_mesh_size_ratio number | null

Mesh size at filament center, relative to the radius of the filaments. E.g. 0.1 means that the mesh size is 0.1 times the filament radius.

Default: null
amplitude_dependent_scaling boolean | null

Amplitude dependent scaling uses the field amplitude to approximate the field penetration distance in the filaments to alter the filament mesh. If the field penetration distance is low (i.e. for low field amplitudes) this feature increases mesh density in the region where the field is expected to penetrate, and decreases the mesh resolution in the region where the field does not penetrate.

Default: false
field_penetration_depth_scaling_factor number | null

Scaling factor for the estimate of the field penetration depth, used for amplitude dependent scaling.

Default: null
desired_elements_in_field_penetration_region number | null

Desired number of elements in the field penetration region. This parameter is used for amplitude dependent scaling, and determines the number of elements in the region where the field is expected to penetrate.

Default: null
matrix object

Level 3: Class for FiQuS ConductorAC

8 nested properties
mesh_size_matrix_ratio_inner number | null

Mesh size at the matrix center, relative to the filament radius.

Default: null
mesh_size_matrix_ratio_middle number | null

Mesh size at the matrix middle partition, relative to the filament radius.

Default: null
mesh_size_matrix_ratio_outer number | null

Mesh size at the matrix outer boundary, relative to the filament radius.

Default: null
interpolation_distance_from_filaments_ratio number | null

The mesh size is interpolated from the filament boundaries into the matrix, over a given distance. This parameter determines the distance over which the mesh size is interpolated.

Default: null
rate_dependent_scaling_matrix boolean | null

Rate dependent scaling uses the expected skin depth in the matrix to determine the matrix mesh. If the skin depth is low (i.e. for high frequencies) this feature increases mesh density in the region where the current is expected to flow, while decreasing the mesh resolution in the region where the current is not expected to flow.

Default: false
skindepth_scaling_factor number | null

Scaling factor for the estimate of the skin depth, used for rate dependent scaling.

Default: null
desired_elements_in_skindepth number | null

Desired number of elements in the skin depth region. This parameter is used for rate dependent scaling, and determines the number of elements in the region where the current is expected to flow.

Default: null
force_center_symmetry boolean | null

This option can be set in strands without center filament to enforce a cross of symmetric nodes in the center of the strand mesh - used within Glock thesis.

Default: false
air object

Level 3: Class for FiQuS ConductorAC

1 nested properties
max_mesh_size_ratio number | null

Mesh size at the outer boundary of the air region, relative to the filament radius. E.g. 10 means that the mesh size is 10 times the filament radius.

Default: null
solve object

Level 2: Class for FiQuS ConductorAC Strand solver settings

9 nested properties
pro_template string | null

Name of the .pro template file.

Default: "CAC_Strand_template.pro"
conductor_name string | null

Name of the conductor. Must match a conductor name in the conductors section of the input YAML-file.

Default: null
formulation_parameters object

Level 3: Class for finite element formulation parameters

4 nested properties
formulation string

Which formulation? CATI is the default and usual choice to model hysteresis/coupling/eddy currents with the CATI method. AI_uncoupled is a conventional 2D formulation with axial currents modelling UNCOUPLED filaments (and eddy currents in matrix).

Default: "CATI"
Values: "CATI" "AI_uncoupled"
dynamic_correction boolean | null

With the CATI method, do we activate the dynamic correction?

Default: true
compute_temperature boolean | null

Do we compute the temperature?

Default: false
two_ell_periodicity boolean | null

With CATI method: True to integrate over twice the shortest periodicity length (recommended), False to integrate over the shortest periodicity length (not recommended).

Default: true
general_parameters object

Level 3: Class for general parameters

3 nested properties
temperature number

Temperature (K) of the strand.

Default: 1.9
superconductor_linear boolean | null

For debugging: replace LTS by normal conductor.

Default: false
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
initial_conditions object

Level 3: Class for initial conditions

2 nested properties
init_type string | null

Type of initialization for the simulation. (i) 'virgin' is the default type, the initial magnetic field is zero, (ii) 'pos_file' is to initialize from the solution of another solution, given by the solution_to_init_from entry, and (iii) 'uniform_field' is to initialize at a uniform field, which will be the applied field at the initial time of the simulation. Note that the uniform_field option does not allow any non-zero transport current.

Default: "virgin"
solution_to_init_from integer | string | null

Name xxx of the solution from which the simulation should be initialized. The file last_magnetic_field.pos of folder Solution_xxx will be used for the initial solution. It must be in the Geometry_xxx/Mesh_xxx/ folder in which the Solution_xxx will be saved.

Default: null
diffusion_barriers object
4 nested properties
enable boolean | null

Set True to enable diffusion barriers.

Default: false
load_data_from_yaml boolean | null

Set True to load the diffusion barrier data from the input YAML-file. Otherwise, the thickness and resistivity specified in this file are used.

Default: false
resistivity number | null

Resistivity of the diffusion barriers (Ohm*m).

Default: 1e-6
thickness number | null

Thickness of the diffusion barriers (m).

Default: 1e-6
global_diffusion_barrier object
4 nested properties
enable boolean | null

Set True to enable diffusion barriers.

Default: false
load_data_from_yaml boolean | null

Set True to load the diffusion barrier data from the input YAML-file. Otherwise, the thickness and resistivity specified in this file are used.

Default: false
resistivity number | null

Resistivity of the diffusion barriers (Ohm*m).

Default: 1e-6
thickness number | null

Thickness of the diffusion barriers (m).

Default: 1e-6
source_parameters object

Level 3: Class for material properties

5 nested properties
source_type string

Time evolution of applied current and magnetic field. Supported options are: sine, sine_with_DC, piecewise_linear, from_list, rotating.

Default: "sine"
Values: "sine" "piecewise" "rotating"
sine object

Level 4: Class for Sine source parameters

piecewise object

Level 4: Class for piecewise (linear) source parameters

rotating object

Level 4: Class for Rotating magnetic source field parameters

field_angle number | null

Angle of the source magnetic field, with respect to the x-axis (degrees).

Default: 90
numerical_parameters object

Level 3: Class for numerical parameters

3 nested properties
sine object

Level 4: Numerical parameters corresponding to the sine source

piecewise object

Level 4: Numerical parameters corresponding to the piecewise source

rotating object

Level 4: Numerical parameters corresponding to the sine source

postproc object

Level 2: Class for FiQuS ConductorAC

8 nested properties
pos_files object

Level 3: Class for cleanup settings

2 nested properties
quantities string[] | null

List of GetDP postprocessing quantity to write to .pos file. Examples of valid entry is: phi, h, b, b_reaction, j, jz, jc, power_filaments, power_matrix, sigma_matrix, j_plane, v_plane, hsVal

Default: null
regions string[] | null

List of GetDP region to to write to .pos file postprocessing for. Examples of valid entry is: Matrix, Filaments, Omega (full domain), OmegaC (conducting domain), OmegaCC (non conducting domain)

Default: null
compute_current_per_filament boolean

Computes current in every filament, with decomposition into magnetization and transport current.

Default: false
output_folder string | null

Batch post-processing creates a folder with the given name in the output directory, where all the plots are saved.

Default: "Results"
generate_report boolean | null

Generates a PDF report including all postprocessing graphs. File is saved in the output_folder.

Default: false
cleanup object

Level 3: Class for cleanup settings

3 nested properties
remove_pre_file boolean

Set True to remove the .pre-file after post-processing, to save disk space.

Default: false
remove_res_file boolean

Set True to remove the .res-file after post-processing, to save disk space.

Default: false
remove_msh_file boolean

Set True to remove the .msh-file after post-processing, to save disk space.

Default: false
plot_flux object

Level 3: Class with settings flux related plots and the related - reduced order hysteretic flux (ROHF) model. The ROHF model can either be initialized from a predefined parameter file or freshly fitted on the solution with a given number_of_cells and kappa_spacing_type (will not be rate dependent).

5 nested properties
show boolean | null

Enable flux related plots.

Default: false
rohf boolean | null

Enable ROHF model.

Default: false
rohf_file string | null

Name of a .txt file in the geometry folder containing tau, kappa and alpha values. The file has to be structured into three columns (separated by whitespaces) with the preliminary header-row 'taus kappas alphas'. Each row corresponds to one cell of the multicell ROHF model.

Default: null
rohf_N integer | null

Total number of cells (N) for the ROHF model. If a parameter_file_name is given this option will be disregarded in favour of the parameterfile definitions.

Default: null
rohf_kappa_spacing string | null

Spacing strategy for the N kappa values of the ROHF model. Options: 'linear', 'log', 'invlog' if left blank it will set the kappa interval based on a error minimization. If a parameter_file_name is given this option will be disregarded in favour of the parameterfile definitions.

Default: null
plot_instantaneous_power object

Level 3: Class with settings for generating plots of instantaneous power

4 nested properties
show boolean

Creates a plot for the calculated instantaneous AC loss (W/m) as a function of time (s).

Default: false
title string

Title for the plot.

Default: "Instantaneous Power"
save boolean

Set True to save the plot.

Default: false
save_file_name string

Name of the plot file.

Default: "instantaneous_power"
batch_postproc object

Level 3: Class for batch post-processing settings

7 nested properties
simulations_csv string | null

Name of the .csv file for post-processing (without file extension). This file specifies the simulations to be post-processed. The file is structured into three columns, specifying the folder names to access the simulation results: 'input.run.geometry', 'input.run.mesh' and 'input.run.solve'. Each row corresponds to a simulation to be post-processed.

Default: null
fluxmodels_csv string | null

Name of the .csv file for post-processing (without file extension). This file specifies the fluxmodels to be post-processed. The file is structured into three columns, specifying the folder names to access the simulation results: 'input.run.geometry', 'input.run.mesh' and 'input.run.solve'. Each row corresponds to a simulation to be post-processed.

Default: null
filter object

Level 4: Field for filtering simulations based on simulation parameters for batch post-processing

sort object

Level 4: Field for sorting simulations based on simulation parameters for batch post-processing

loss_map object

Level 4: Class with settings for generating loss maps

rohf_on_grid object

Level 4: Class with settings to perform actions on a ROHF model based on a grid of simulations.

plot2d object

Level 4: Class for 2D plot settings

CACStrandGeometry object

Level 2: Class for strand geometry parameters

io_settings object

Level 2: Class for Input/Output settings for the cable geometry

2 nested properties
load object

Level 3: Class for Input/Output settings for the cable geometry

2 nested properties
load_from_yaml boolean | null

True to load the geometry from a YAML file, false to generate the geometry.

Default: false
filename string | null

Name of the YAML file from which to load the geometry.

Default: null
save object

Level 3: Class for Input/Output settings for the cable geometry

2 nested properties
save_to_yaml boolean | null

True to save the geometry to a YAML-file, false to not save the geometry.

Default: false
filename string | null

Name of the output geometry YAML file.

Default: null
hexagonal_filaments boolean | null

Field for specifying the shape of the filaments. True for hexagonal, False for circular.

Default: null
hexagonal_holes boolean | null

Field for specifying the shape of the filament holes. True for hexagonal, False for circular.

Default: null
filament_circular_distribution boolean | null

Field for specifying the geometrical distribution of the filaments. Set True to distribute the filaments in a circular pattern and False to distribute them in a hexagonal pattern.

Default: null
air_radius number | null

Radius of the circular numerical air region (m).

Default: null
type string

Type of model geometry which will be generated. Supported options are: strand_only, periodic_squarestrand_only models the strand in an circular air domain (natural boundary condition)periodic_square models the strand in an square air domain (periodic boundary condition)coil models a single coil winding in open space (uses hybrid boundary conditions)

Default: "strand_only"
Values: "strand_only" "periodic_square" "coil"
coil_radius number | null

used in geometry type 'coil' to determine the distance from strand center to mirroring plane (m). Should always be bigger than strand radius.

Default: null
rotate_angle number | null

Rotates strand geometry by specified angle in deg counterclockwise around the z axis and x=0 and y=0

Default: null
CACStrandGeometryIOsettings object

Level 2: Class for Input/Output settings for the cable geometry

load object

Level 3: Class for Input/Output settings for the cable geometry

2 nested properties
load_from_yaml boolean | null

True to load the geometry from a YAML file, false to generate the geometry.

Default: false
filename string | null

Name of the YAML file from which to load the geometry.

Default: null
save object

Level 3: Class for Input/Output settings for the cable geometry

2 nested properties
save_to_yaml boolean | null

True to save the geometry to a YAML-file, false to not save the geometry.

Default: false
filename string | null

Name of the output geometry YAML file.

Default: null
CACStrandIOsettingsLoad object

Level 3: Class for Input/Output settings for the cable geometry

load_from_yaml boolean | null

True to load the geometry from a YAML file, false to generate the geometry.

Default: false
filename string | null

Name of the YAML file from which to load the geometry.

Default: null
CACStrandIOsettingsSave object

Level 3: Class for Input/Output settings for the cable geometry

save_to_yaml boolean | null

True to save the geometry to a YAML-file, false to not save the geometry.

Default: false
filename string | null

Name of the output geometry YAML file.

Default: null
CACStrandMesh object

Level 2: Class for FiQuS ConductorAC

scaling_global number | null

Global scaling factor for mesh size.

Default: 1
filaments object

Level 3: Class for FiQuS ConductorAC

5 nested properties
boundary_mesh_size_ratio number | null

Mesh size at filament boundaries, relative to the radius of the filaments. E.g. 0.1 means that the mesh size is 0.1 times the filament radius.

Default: null
center_mesh_size_ratio number | null

Mesh size at filament center, relative to the radius of the filaments. E.g. 0.1 means that the mesh size is 0.1 times the filament radius.

Default: null
amplitude_dependent_scaling boolean | null

Amplitude dependent scaling uses the field amplitude to approximate the field penetration distance in the filaments to alter the filament mesh. If the field penetration distance is low (i.e. for low field amplitudes) this feature increases mesh density in the region where the field is expected to penetrate, and decreases the mesh resolution in the region where the field does not penetrate.

Default: false
field_penetration_depth_scaling_factor number | null

Scaling factor for the estimate of the field penetration depth, used for amplitude dependent scaling.

Default: null
desired_elements_in_field_penetration_region number | null

Desired number of elements in the field penetration region. This parameter is used for amplitude dependent scaling, and determines the number of elements in the region where the field is expected to penetrate.

Default: null
matrix object

Level 3: Class for FiQuS ConductorAC

8 nested properties
mesh_size_matrix_ratio_inner number | null

Mesh size at the matrix center, relative to the filament radius.

Default: null
mesh_size_matrix_ratio_middle number | null

Mesh size at the matrix middle partition, relative to the filament radius.

Default: null
mesh_size_matrix_ratio_outer number | null

Mesh size at the matrix outer boundary, relative to the filament radius.

Default: null
interpolation_distance_from_filaments_ratio number | null

The mesh size is interpolated from the filament boundaries into the matrix, over a given distance. This parameter determines the distance over which the mesh size is interpolated.

Default: null
rate_dependent_scaling_matrix boolean | null

Rate dependent scaling uses the expected skin depth in the matrix to determine the matrix mesh. If the skin depth is low (i.e. for high frequencies) this feature increases mesh density in the region where the current is expected to flow, while decreasing the mesh resolution in the region where the current is not expected to flow.

Default: false
skindepth_scaling_factor number | null

Scaling factor for the estimate of the skin depth, used for rate dependent scaling.

Default: null
desired_elements_in_skindepth number | null

Desired number of elements in the skin depth region. This parameter is used for rate dependent scaling, and determines the number of elements in the region where the current is expected to flow.

Default: null
force_center_symmetry boolean | null

This option can be set in strands without center filament to enforce a cross of symmetric nodes in the center of the strand mesh - used within Glock thesis.

Default: false
air object

Level 3: Class for FiQuS ConductorAC

1 nested properties
max_mesh_size_ratio number | null

Mesh size at the outer boundary of the air region, relative to the filament radius. E.g. 10 means that the mesh size is 10 times the filament radius.

Default: null
CACStrandMeshAir object

Level 3: Class for FiQuS ConductorAC

max_mesh_size_ratio number | null

Mesh size at the outer boundary of the air region, relative to the filament radius. E.g. 10 means that the mesh size is 10 times the filament radius.

Default: null
CACStrandMeshFilaments object

Level 3: Class for FiQuS ConductorAC

boundary_mesh_size_ratio number | null

Mesh size at filament boundaries, relative to the radius of the filaments. E.g. 0.1 means that the mesh size is 0.1 times the filament radius.

Default: null
center_mesh_size_ratio number | null

Mesh size at filament center, relative to the radius of the filaments. E.g. 0.1 means that the mesh size is 0.1 times the filament radius.

Default: null
amplitude_dependent_scaling boolean | null

Amplitude dependent scaling uses the field amplitude to approximate the field penetration distance in the filaments to alter the filament mesh. If the field penetration distance is low (i.e. for low field amplitudes) this feature increases mesh density in the region where the field is expected to penetrate, and decreases the mesh resolution in the region where the field does not penetrate.

Default: false
field_penetration_depth_scaling_factor number | null

Scaling factor for the estimate of the field penetration depth, used for amplitude dependent scaling.

Default: null
desired_elements_in_field_penetration_region number | null

Desired number of elements in the field penetration region. This parameter is used for amplitude dependent scaling, and determines the number of elements in the region where the field is expected to penetrate.

Default: null
CACStrandMeshMatrix object

Level 3: Class for FiQuS ConductorAC

mesh_size_matrix_ratio_inner number | null

Mesh size at the matrix center, relative to the filament radius.

Default: null
mesh_size_matrix_ratio_middle number | null

Mesh size at the matrix middle partition, relative to the filament radius.

Default: null
mesh_size_matrix_ratio_outer number | null

Mesh size at the matrix outer boundary, relative to the filament radius.

Default: null
interpolation_distance_from_filaments_ratio number | null

The mesh size is interpolated from the filament boundaries into the matrix, over a given distance. This parameter determines the distance over which the mesh size is interpolated.

Default: null
rate_dependent_scaling_matrix boolean | null

Rate dependent scaling uses the expected skin depth in the matrix to determine the matrix mesh. If the skin depth is low (i.e. for high frequencies) this feature increases mesh density in the region where the current is expected to flow, while decreasing the mesh resolution in the region where the current is not expected to flow.

Default: false
skindepth_scaling_factor number | null

Scaling factor for the estimate of the skin depth, used for rate dependent scaling.

Default: null
desired_elements_in_skindepth number | null

Desired number of elements in the skin depth region. This parameter is used for rate dependent scaling, and determines the number of elements in the region where the current is expected to flow.

Default: null
force_center_symmetry boolean | null

This option can be set in strands without center filament to enforce a cross of symmetric nodes in the center of the strand mesh - used within Glock thesis.

Default: false
CACStrandPostproc object

Level 2: Class for FiQuS ConductorAC

pos_files object

Level 3: Class for cleanup settings

2 nested properties
quantities string[] | null

List of GetDP postprocessing quantity to write to .pos file. Examples of valid entry is: phi, h, b, b_reaction, j, jz, jc, power_filaments, power_matrix, sigma_matrix, j_plane, v_plane, hsVal

Default: null
regions string[] | null

List of GetDP region to to write to .pos file postprocessing for. Examples of valid entry is: Matrix, Filaments, Omega (full domain), OmegaC (conducting domain), OmegaCC (non conducting domain)

Default: null
compute_current_per_filament boolean

Computes current in every filament, with decomposition into magnetization and transport current.

Default: false
output_folder string | null

Batch post-processing creates a folder with the given name in the output directory, where all the plots are saved.

Default: "Results"
generate_report boolean | null

Generates a PDF report including all postprocessing graphs. File is saved in the output_folder.

Default: false
cleanup object

Level 3: Class for cleanup settings

3 nested properties
remove_pre_file boolean

Set True to remove the .pre-file after post-processing, to save disk space.

Default: false
remove_res_file boolean

Set True to remove the .res-file after post-processing, to save disk space.

Default: false
remove_msh_file boolean

Set True to remove the .msh-file after post-processing, to save disk space.

Default: false
plot_flux object

Level 3: Class with settings flux related plots and the related - reduced order hysteretic flux (ROHF) model. The ROHF model can either be initialized from a predefined parameter file or freshly fitted on the solution with a given number_of_cells and kappa_spacing_type (will not be rate dependent).

5 nested properties
show boolean | null

Enable flux related plots.

Default: false
rohf boolean | null

Enable ROHF model.

Default: false
rohf_file string | null

Name of a .txt file in the geometry folder containing tau, kappa and alpha values. The file has to be structured into three columns (separated by whitespaces) with the preliminary header-row 'taus kappas alphas'. Each row corresponds to one cell of the multicell ROHF model.

Default: null
rohf_N integer | null

Total number of cells (N) for the ROHF model. If a parameter_file_name is given this option will be disregarded in favour of the parameterfile definitions.

Default: null
rohf_kappa_spacing string | null

Spacing strategy for the N kappa values of the ROHF model. Options: 'linear', 'log', 'invlog' if left blank it will set the kappa interval based on a error minimization. If a parameter_file_name is given this option will be disregarded in favour of the parameterfile definitions.

Default: null
plot_instantaneous_power object

Level 3: Class with settings for generating plots of instantaneous power

4 nested properties
show boolean

Creates a plot for the calculated instantaneous AC loss (W/m) as a function of time (s).

Default: false
title string

Title for the plot.

Default: "Instantaneous Power"
save boolean

Set True to save the plot.

Default: false
save_file_name string

Name of the plot file.

Default: "instantaneous_power"
batch_postproc object

Level 3: Class for batch post-processing settings

7 nested properties
simulations_csv string | null

Name of the .csv file for post-processing (without file extension). This file specifies the simulations to be post-processed. The file is structured into three columns, specifying the folder names to access the simulation results: 'input.run.geometry', 'input.run.mesh' and 'input.run.solve'. Each row corresponds to a simulation to be post-processed.

Default: null
fluxmodels_csv string | null

Name of the .csv file for post-processing (without file extension). This file specifies the fluxmodels to be post-processed. The file is structured into three columns, specifying the folder names to access the simulation results: 'input.run.geometry', 'input.run.mesh' and 'input.run.solve'. Each row corresponds to a simulation to be post-processed.

Default: null
filter object

Level 4: Field for filtering simulations based on simulation parameters for batch post-processing

2 nested properties
apply_filter boolean

Set True to filter simulations by parameters from the input YAML-file.

Default: false
filter_criterion string | null

Criterion used to filter simulations based on simulation parameters. For example will '<<solve.source_parameters.sine.frequency>> > 100' disregard simulations done with frequencies lower than 100Hz.

Default: null
sort object

Level 4: Field for sorting simulations based on simulation parameters for batch post-processing

2 nested properties
apply_sort boolean

Set True to sort simulations.

Default: false
sort_key string | null

Criterion used to sort simulations based on simulation parameters. For example will 'sd.total_power_per_cycle['TotalLoss'] sort simulations based on the total loss.

Default: null
loss_map object

Level 4: Class with settings for generating loss maps

21 nested properties
produce_loss_map boolean

Set True to produce a loss map.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "loss_map"
x_val string | null

Parameter to be plotted on the x-axis. This field corresponds to a parameter in the input YAML-file. E.g. 'solve.source_parameters.sine.frequency' will plot the loss map for different frequencies.

Default: null
y_val string | null

Parameter to be plotted on the y-axis. This field corresponds to a parameter in the input YAML-file. E.g. 'solve.source_parameters.sine.field_amplitude' will plot the loss map for different applied field amplitudes.

Default: null
x_steps integer

Number of steps on the x-axis.

Default: 20
y_steps integer

Number of steps on the y-axis.

Default: 20
loss_type string

Type of loss to be plotted. Supported options are: TotalLoss, FilamentLoss, CouplingLoss, EddyLoss.

Default: "TotalLoss"
Values: "TotalLoss" "FilamentLoss" "CouplingLoss" "EddyLoss"
x_log boolean

Set True to plot x-axis in log-scale.

Default: true
y_log boolean

Set True to plot y-axis in log-scale.

Default: true
loss_log boolean

Set True to plot loss in log-scale.

Default: true
x_norm number

Normalization factor for x-axis.

Default: 1
y_norm number

Normalization factor for y-axis.

Default: 1
loss_norm number

Normalization factor for the AC-loss.

Default: 1
show_datapoints boolean

Set True to show markers for all the datapoints in the loss map.

Default: true
title string | null

Title for the plot.

Default: null
xlabel string | null

Label for the x-axis.

Default: null
ylabel string | null

Label for the y-axis.

Default: null
show_loss_type_dominance_contour boolean

Set True to plot a contour curve separating regions where different loss types dominate.

Default: false
cross_section object

Level 5: Class with settings for plotting a cross-section of the loss map.

cross_section_sweep object

Level 5: Class with settings for animating a cross-section sweep of the loss map along one axis.

rohf_on_grid object

Level 4: Class with settings to perform actions on a ROHF model based on a grid of simulations.

6 nested properties
produce_error_map boolean

Set True to produce a error map of the definced error_type. If the fit_rohf option is enabled it will compute the map for the new ROHF model ignoring everything in the fluxmodel.csv.

Default: false
interpolate_error_map boolean

Interpolate colormap linear between the computed values (graphical purposes)

Default: false
error_type string

realtive error metric displayed by the map. Options: pc_loss, flux, dyn_loss

Default: "pc_loss"
fit_rohf boolean

Fit a ROHF model on the simulation grid given in the simulation.csv

Default: false
fit_rohf_N integer | null

Number of ROHF cells to use for the fit. Default is 7.

Default: 7
fit_rohf_tausweep_IIC number | null

I/Ic ratio used to fit the ratedependence parameters (taus).

Default: 1.0
plot2d object

Level 4: Class for 2D plot settings

18 nested properties
produce_plot2d boolean

Set True to produce a 2D plot.

Default: false
combined_plot boolean

Set True to produce a combined plot for all simulations. If False, a separate plot is produced for each simulation.

Default: false
save_pgfdata boolean

Set True to export the plot data in pgfplot readable .txt format stored in output_folder. Currently only supports combined plots.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "plot2d"
x_val string | null

Value to be plotted on the x-axis. Parameters in the input YAML-file and class-variables from the plotter 'SimulationData' class can be accessed trough dot notation 'simulation.' E.g. 'simulation.f' will create a 2D plot with sine source frequency on the x-axis. 'simulation.time' will create a plot with time on the x-axis.

Default: null
y_vals string[] | null

List of values to be plotted on the y-axis. Parameters in the input YAML-file and class-variables from the plotter 'SimulationData' class can be accessed trough dot notation 'simulation.' E.g. total AC-loss per cycle can be accessed as ['simulation.total_power_per_cycle['TotalLoss_dyn']'].

Default: null
y_val_fluxmodel string | null

Attribute of the 'ROHFmodel' class which is plotted on the y-axis. Access via dot notation with 'fluxmodel.' and 'simulation.' E.g. ROHF computed flux - 'fluxmodel.compute(I=simulation.I_transport,time=simulation.time)[0]'

Default: null
reference_vals string[] | null

reference values as set of two list [xvals, yvals] which will be plotted in the combined plot (For reference curves)

Default: null
reference_label string | null

label text for the reference data in the plot legend

Default: null
labels string[] | null

List of labels for the plot. Each label corresponding to a value in y_val.

Default: null
linestyle string | null

Linestyle for the plot.

Default: null
title string | null

Title for the plot.

Default: null
xlabel string | null

Label for the x-axis.

Default: null
ylabel string | null

Label for the y-axis.

Default: null
x_log boolean

Set True to plot x-axis in log-scale.

Default: false
y_log boolean

Set True to plot y-axis in log-scale.

Default: false
legend boolean

Set True to show legend.

Default: true
CACStrandPostprocBatchpostproc object

Level 3: Class for batch post-processing settings

simulations_csv string | null

Name of the .csv file for post-processing (without file extension). This file specifies the simulations to be post-processed. The file is structured into three columns, specifying the folder names to access the simulation results: 'input.run.geometry', 'input.run.mesh' and 'input.run.solve'. Each row corresponds to a simulation to be post-processed.

Default: null
fluxmodels_csv string | null

Name of the .csv file for post-processing (without file extension). This file specifies the fluxmodels to be post-processed. The file is structured into three columns, specifying the folder names to access the simulation results: 'input.run.geometry', 'input.run.mesh' and 'input.run.solve'. Each row corresponds to a simulation to be post-processed.

Default: null
filter object

Level 4: Field for filtering simulations based on simulation parameters for batch post-processing

2 nested properties
apply_filter boolean

Set True to filter simulations by parameters from the input YAML-file.

Default: false
filter_criterion string | null

Criterion used to filter simulations based on simulation parameters. For example will '<<solve.source_parameters.sine.frequency>> > 100' disregard simulations done with frequencies lower than 100Hz.

Default: null
sort object

Level 4: Field for sorting simulations based on simulation parameters for batch post-processing

2 nested properties
apply_sort boolean

Set True to sort simulations.

Default: false
sort_key string | null

Criterion used to sort simulations based on simulation parameters. For example will 'sd.total_power_per_cycle['TotalLoss'] sort simulations based on the total loss.

Default: null
loss_map object

Level 4: Class with settings for generating loss maps

21 nested properties
produce_loss_map boolean

Set True to produce a loss map.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "loss_map"
x_val string | null

Parameter to be plotted on the x-axis. This field corresponds to a parameter in the input YAML-file. E.g. 'solve.source_parameters.sine.frequency' will plot the loss map for different frequencies.

Default: null
y_val string | null

Parameter to be plotted on the y-axis. This field corresponds to a parameter in the input YAML-file. E.g. 'solve.source_parameters.sine.field_amplitude' will plot the loss map for different applied field amplitudes.

Default: null
x_steps integer

Number of steps on the x-axis.

Default: 20
y_steps integer

Number of steps on the y-axis.

Default: 20
loss_type string

Type of loss to be plotted. Supported options are: TotalLoss, FilamentLoss, CouplingLoss, EddyLoss.

Default: "TotalLoss"
Values: "TotalLoss" "FilamentLoss" "CouplingLoss" "EddyLoss"
x_log boolean

Set True to plot x-axis in log-scale.

Default: true
y_log boolean

Set True to plot y-axis in log-scale.

Default: true
loss_log boolean

Set True to plot loss in log-scale.

Default: true
x_norm number

Normalization factor for x-axis.

Default: 1
y_norm number

Normalization factor for y-axis.

Default: 1
loss_norm number

Normalization factor for the AC-loss.

Default: 1
show_datapoints boolean

Set True to show markers for all the datapoints in the loss map.

Default: true
title string | null

Title for the plot.

Default: null
xlabel string | null

Label for the x-axis.

Default: null
ylabel string | null

Label for the y-axis.

Default: null
show_loss_type_dominance_contour boolean

Set True to plot a contour curve separating regions where different loss types dominate.

Default: false
cross_section object

Level 5: Class with settings for plotting a cross-section of the loss map.

7 nested properties
plot_cross_section boolean

Set True to plot a cross-section of the loss map.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "cross_section"
axis_to_cut string

Axis to cut for the cross-section.

Default: "x"
cut_value number

Value of the axis to cut for the cross-section.

Default: 0
ylabel string

Label of the y-axis.

Default: "Loss"
title string | null

Title of the plot. The placeholder <<cut_value>> can be used to indicate the value of the cut axis.

Default: null
cross_section_sweep object

Level 5: Class with settings for animating a cross-section sweep of the loss map along one axis.

6 nested properties
animate_cross_section_sweep boolean

Set True to animate a cross-section sweep of the loss map along one axis.

Default: false
save_plot boolean

Set True to save the animation.

Default: false
filename string

Name of the animation file.

Default: "crossSectionSweep"
axis_to_sweep string

Axis to sweep for the animation.

Default: "x"
ylabel string

Label of the y-axis.

Default: "Loss"
title string | null

Title of the plot. Use <<sweep_value>> to indicate the value of the sweep axis.

Default: null
rohf_on_grid object

Level 4: Class with settings to perform actions on a ROHF model based on a grid of simulations.

6 nested properties
produce_error_map boolean

Set True to produce a error map of the definced error_type. If the fit_rohf option is enabled it will compute the map for the new ROHF model ignoring everything in the fluxmodel.csv.

Default: false
interpolate_error_map boolean

Interpolate colormap linear between the computed values (graphical purposes)

Default: false
error_type string

realtive error metric displayed by the map. Options: pc_loss, flux, dyn_loss

Default: "pc_loss"
fit_rohf boolean

Fit a ROHF model on the simulation grid given in the simulation.csv

Default: false
fit_rohf_N integer | null

Number of ROHF cells to use for the fit. Default is 7.

Default: 7
fit_rohf_tausweep_IIC number | null

I/Ic ratio used to fit the ratedependence parameters (taus).

Default: 1.0
plot2d object

Level 4: Class for 2D plot settings

18 nested properties
produce_plot2d boolean

Set True to produce a 2D plot.

Default: false
combined_plot boolean

Set True to produce a combined plot for all simulations. If False, a separate plot is produced for each simulation.

Default: false
save_pgfdata boolean

Set True to export the plot data in pgfplot readable .txt format stored in output_folder. Currently only supports combined plots.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "plot2d"
x_val string | null

Value to be plotted on the x-axis. Parameters in the input YAML-file and class-variables from the plotter 'SimulationData' class can be accessed trough dot notation 'simulation.' E.g. 'simulation.f' will create a 2D plot with sine source frequency on the x-axis. 'simulation.time' will create a plot with time on the x-axis.

Default: null
y_vals string[] | null

List of values to be plotted on the y-axis. Parameters in the input YAML-file and class-variables from the plotter 'SimulationData' class can be accessed trough dot notation 'simulation.' E.g. total AC-loss per cycle can be accessed as ['simulation.total_power_per_cycle['TotalLoss_dyn']'].

Default: null
y_val_fluxmodel string | null

Attribute of the 'ROHFmodel' class which is plotted on the y-axis. Access via dot notation with 'fluxmodel.' and 'simulation.' E.g. ROHF computed flux - 'fluxmodel.compute(I=simulation.I_transport,time=simulation.time)[0]'

Default: null
reference_vals string[] | null

reference values as set of two list [xvals, yvals] which will be plotted in the combined plot (For reference curves)

Default: null
reference_label string | null

label text for the reference data in the plot legend

Default: null
labels string[] | null

List of labels for the plot. Each label corresponding to a value in y_val.

Default: null
linestyle string | null

Linestyle for the plot.

Default: null
title string | null

Title for the plot.

Default: null
xlabel string | null

Label for the x-axis.

Default: null
ylabel string | null

Label for the y-axis.

Default: null
x_log boolean

Set True to plot x-axis in log-scale.

Default: false
y_log boolean

Set True to plot y-axis in log-scale.

Default: false
legend boolean

Set True to show legend.

Default: true
CACStrandPostprocBatchpostprocFilter object

Level 4: Field for filtering simulations based on simulation parameters for batch post-processing

apply_filter boolean

Set True to filter simulations by parameters from the input YAML-file.

Default: false
filter_criterion string | null

Criterion used to filter simulations based on simulation parameters. For example will '<<solve.source_parameters.sine.frequency>> > 100' disregard simulations done with frequencies lower than 100Hz.

Default: null
CACStrandPostprocBatchpostprocLossMap object

Level 4: Class with settings for generating loss maps

produce_loss_map boolean

Set True to produce a loss map.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "loss_map"
x_val string | null

Parameter to be plotted on the x-axis. This field corresponds to a parameter in the input YAML-file. E.g. 'solve.source_parameters.sine.frequency' will plot the loss map for different frequencies.

Default: null
y_val string | null

Parameter to be plotted on the y-axis. This field corresponds to a parameter in the input YAML-file. E.g. 'solve.source_parameters.sine.field_amplitude' will plot the loss map for different applied field amplitudes.

Default: null
x_steps integer

Number of steps on the x-axis.

Default: 20
y_steps integer

Number of steps on the y-axis.

Default: 20
loss_type string

Type of loss to be plotted. Supported options are: TotalLoss, FilamentLoss, CouplingLoss, EddyLoss.

Default: "TotalLoss"
Values: "TotalLoss" "FilamentLoss" "CouplingLoss" "EddyLoss"
x_log boolean

Set True to plot x-axis in log-scale.

Default: true
y_log boolean

Set True to plot y-axis in log-scale.

Default: true
loss_log boolean

Set True to plot loss in log-scale.

Default: true
x_norm number

Normalization factor for x-axis.

Default: 1
y_norm number

Normalization factor for y-axis.

Default: 1
loss_norm number

Normalization factor for the AC-loss.

Default: 1
show_datapoints boolean

Set True to show markers for all the datapoints in the loss map.

Default: true
title string | null

Title for the plot.

Default: null
xlabel string | null

Label for the x-axis.

Default: null
ylabel string | null

Label for the y-axis.

Default: null
show_loss_type_dominance_contour boolean

Set True to plot a contour curve separating regions where different loss types dominate.

Default: false
cross_section object

Level 5: Class with settings for plotting a cross-section of the loss map.

7 nested properties
plot_cross_section boolean

Set True to plot a cross-section of the loss map.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "cross_section"
axis_to_cut string

Axis to cut for the cross-section.

Default: "x"
cut_value number

Value of the axis to cut for the cross-section.

Default: 0
ylabel string

Label of the y-axis.

Default: "Loss"
title string | null

Title of the plot. The placeholder <<cut_value>> can be used to indicate the value of the cut axis.

Default: null
cross_section_sweep object

Level 5: Class with settings for animating a cross-section sweep of the loss map along one axis.

6 nested properties
animate_cross_section_sweep boolean

Set True to animate a cross-section sweep of the loss map along one axis.

Default: false
save_plot boolean

Set True to save the animation.

Default: false
filename string

Name of the animation file.

Default: "crossSectionSweep"
axis_to_sweep string

Axis to sweep for the animation.

Default: "x"
ylabel string

Label of the y-axis.

Default: "Loss"
title string | null

Title of the plot. Use <<sweep_value>> to indicate the value of the sweep axis.

Default: null
CACStrandPostprocBatchpostprocLossMapCrossSection object

Level 5: Class with settings for plotting a cross-section of the loss map.

plot_cross_section boolean

Set True to plot a cross-section of the loss map.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "cross_section"
axis_to_cut string

Axis to cut for the cross-section.

Default: "x"
cut_value number

Value of the axis to cut for the cross-section.

Default: 0
ylabel string

Label of the y-axis.

Default: "Loss"
title string | null

Title of the plot. The placeholder <<cut_value>> can be used to indicate the value of the cut axis.

Default: null
CACStrandPostprocBatchpostprocLossMapCrossSectionSweep object

Level 5: Class with settings for animating a cross-section sweep of the loss map along one axis.

animate_cross_section_sweep boolean

Set True to animate a cross-section sweep of the loss map along one axis.

Default: false
save_plot boolean

Set True to save the animation.

Default: false
filename string

Name of the animation file.

Default: "crossSectionSweep"
axis_to_sweep string

Axis to sweep for the animation.

Default: "x"
ylabel string

Label of the y-axis.

Default: "Loss"
title string | null

Title of the plot. Use <<sweep_value>> to indicate the value of the sweep axis.

Default: null
CACStrandPostprocBatchpostprocPlot2d object

Level 4: Class for 2D plot settings

produce_plot2d boolean

Set True to produce a 2D plot.

Default: false
combined_plot boolean

Set True to produce a combined plot for all simulations. If False, a separate plot is produced for each simulation.

Default: false
save_pgfdata boolean

Set True to export the plot data in pgfplot readable .txt format stored in output_folder. Currently only supports combined plots.

Default: false
save_plot boolean

Set True to save the plot.

Default: false
filename string

Name of the plot file.

Default: "plot2d"
x_val string | null

Value to be plotted on the x-axis. Parameters in the input YAML-file and class-variables from the plotter 'SimulationData' class can be accessed trough dot notation 'simulation.' E.g. 'simulation.f' will create a 2D plot with sine source frequency on the x-axis. 'simulation.time' will create a plot with time on the x-axis.

Default: null
y_vals string[] | null

List of values to be plotted on the y-axis. Parameters in the input YAML-file and class-variables from the plotter 'SimulationData' class can be accessed trough dot notation 'simulation.' E.g. total AC-loss per cycle can be accessed as ['simulation.total_power_per_cycle['TotalLoss_dyn']'].

Default: null
y_val_fluxmodel string | null

Attribute of the 'ROHFmodel' class which is plotted on the y-axis. Access via dot notation with 'fluxmodel.' and 'simulation.' E.g. ROHF computed flux - 'fluxmodel.compute(I=simulation.I_transport,time=simulation.time)[0]'

Default: null
reference_vals string[] | null

reference values as set of two list [xvals, yvals] which will be plotted in the combined plot (For reference curves)

Default: null
reference_label string | null

label text for the reference data in the plot legend

Default: null
labels string[] | null

List of labels for the plot. Each label corresponding to a value in y_val.

Default: null
linestyle string | null

Linestyle for the plot.

Default: null
title string | null

Title for the plot.

Default: null
xlabel string | null

Label for the x-axis.

Default: null
ylabel string | null

Label for the y-axis.

Default: null
x_log boolean

Set True to plot x-axis in log-scale.

Default: false
y_log boolean

Set True to plot y-axis in log-scale.

Default: false
legend boolean

Set True to show legend.

Default: true
CACStrandPostprocBatchpostprocROHFgrid object

Level 4: Class with settings to perform actions on a ROHF model based on a grid of simulations.

produce_error_map boolean

Set True to produce a error map of the definced error_type. If the fit_rohf option is enabled it will compute the map for the new ROHF model ignoring everything in the fluxmodel.csv.

Default: false
interpolate_error_map boolean

Interpolate colormap linear between the computed values (graphical purposes)

Default: false
error_type string

realtive error metric displayed by the map. Options: pc_loss, flux, dyn_loss

Default: "pc_loss"
fit_rohf boolean

Fit a ROHF model on the simulation grid given in the simulation.csv

Default: false
fit_rohf_N integer | null

Number of ROHF cells to use for the fit. Default is 7.

Default: 7
fit_rohf_tausweep_IIC number | null

I/Ic ratio used to fit the ratedependence parameters (taus).

Default: 1.0
CACStrandPostprocBatchpostprocSort object

Level 4: Field for sorting simulations based on simulation parameters for batch post-processing

apply_sort boolean

Set True to sort simulations.

Default: false
sort_key string | null

Criterion used to sort simulations based on simulation parameters. For example will 'sd.total_power_per_cycle['TotalLoss'] sort simulations based on the total loss.

Default: null
CACStrandPostprocCleanup object

Level 3: Class for cleanup settings

remove_pre_file boolean

Set True to remove the .pre-file after post-processing, to save disk space.

Default: false
remove_res_file boolean

Set True to remove the .res-file after post-processing, to save disk space.

Default: false
remove_msh_file boolean

Set True to remove the .msh-file after post-processing, to save disk space.

Default: false
CACStrandPostprocPlotFlux object

Level 3: Class with settings flux related plots and the related - reduced order hysteretic flux (ROHF) model. The ROHF model can either be initialized from a predefined parameter file or freshly fitted on the solution with a given number_of_cells and kappa_spacing_type (will not be rate dependent).

show boolean | null

Enable flux related plots.

Default: false
rohf boolean | null

Enable ROHF model.

Default: false
rohf_file string | null

Name of a .txt file in the geometry folder containing tau, kappa and alpha values. The file has to be structured into three columns (separated by whitespaces) with the preliminary header-row 'taus kappas alphas'. Each row corresponds to one cell of the multicell ROHF model.

Default: null
rohf_N integer | null

Total number of cells (N) for the ROHF model. If a parameter_file_name is given this option will be disregarded in favour of the parameterfile definitions.

Default: null
rohf_kappa_spacing string | null

Spacing strategy for the N kappa values of the ROHF model. Options: 'linear', 'log', 'invlog' if left blank it will set the kappa interval based on a error minimization. If a parameter_file_name is given this option will be disregarded in favour of the parameterfile definitions.

Default: null
CACStrandPostprocPlotInstPower object

Level 3: Class with settings for generating plots of instantaneous power

show boolean

Creates a plot for the calculated instantaneous AC loss (W/m) as a function of time (s).

Default: false
title string

Title for the plot.

Default: "Instantaneous Power"
save boolean

Set True to save the plot.

Default: false
save_file_name string

Name of the plot file.

Default: "instantaneous_power"
CACStrandPostprocPosFiles object

Level 3: Class for cleanup settings

quantities string[] | null

List of GetDP postprocessing quantity to write to .pos file. Examples of valid entry is: phi, h, b, b_reaction, j, jz, jc, power_filaments, power_matrix, sigma_matrix, j_plane, v_plane, hsVal

Default: null
regions string[] | null

List of GetDP region to to write to .pos file postprocessing for. Examples of valid entry is: Matrix, Filaments, Omega (full domain), OmegaC (conducting domain), OmegaCC (non conducting domain)

Default: null
CACStrandSolve object

Level 2: Class for FiQuS ConductorAC Strand solver settings

pro_template string | null

Name of the .pro template file.

Default: "CAC_Strand_template.pro"
conductor_name string | null

Name of the conductor. Must match a conductor name in the conductors section of the input YAML-file.

Default: null
formulation_parameters object

Level 3: Class for finite element formulation parameters

4 nested properties
formulation string

Which formulation? CATI is the default and usual choice to model hysteresis/coupling/eddy currents with the CATI method. AI_uncoupled is a conventional 2D formulation with axial currents modelling UNCOUPLED filaments (and eddy currents in matrix).

Default: "CATI"
Values: "CATI" "AI_uncoupled"
dynamic_correction boolean | null

With the CATI method, do we activate the dynamic correction?

Default: true
compute_temperature boolean | null

Do we compute the temperature?

Default: false
two_ell_periodicity boolean | null

With CATI method: True to integrate over twice the shortest periodicity length (recommended), False to integrate over the shortest periodicity length (not recommended).

Default: true
general_parameters object

Level 3: Class for general parameters

3 nested properties
temperature number

Temperature (K) of the strand.

Default: 1.9
superconductor_linear boolean | null

For debugging: replace LTS by normal conductor.

Default: false
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
initial_conditions object

Level 3: Class for initial conditions

2 nested properties
init_type string | null

Type of initialization for the simulation. (i) 'virgin' is the default type, the initial magnetic field is zero, (ii) 'pos_file' is to initialize from the solution of another solution, given by the solution_to_init_from entry, and (iii) 'uniform_field' is to initialize at a uniform field, which will be the applied field at the initial time of the simulation. Note that the uniform_field option does not allow any non-zero transport current.

Default: "virgin"
solution_to_init_from integer | string | null

Name xxx of the solution from which the simulation should be initialized. The file last_magnetic_field.pos of folder Solution_xxx will be used for the initial solution. It must be in the Geometry_xxx/Mesh_xxx/ folder in which the Solution_xxx will be saved.

Default: null
diffusion_barriers object
4 nested properties
enable boolean | null

Set True to enable diffusion barriers.

Default: false
load_data_from_yaml boolean | null

Set True to load the diffusion barrier data from the input YAML-file. Otherwise, the thickness and resistivity specified in this file are used.

Default: false
resistivity number | null

Resistivity of the diffusion barriers (Ohm*m).

Default: 1e-6
thickness number | null

Thickness of the diffusion barriers (m).

Default: 1e-6
global_diffusion_barrier object
4 nested properties
enable boolean | null

Set True to enable diffusion barriers.

Default: false
load_data_from_yaml boolean | null

Set True to load the diffusion barrier data from the input YAML-file. Otherwise, the thickness and resistivity specified in this file are used.

Default: false
resistivity number | null

Resistivity of the diffusion barriers (Ohm*m).

Default: 1e-6
thickness number | null

Thickness of the diffusion barriers (m).

Default: 1e-6
source_parameters object

Level 3: Class for material properties

5 nested properties
source_type string

Time evolution of applied current and magnetic field. Supported options are: sine, sine_with_DC, piecewise_linear, from_list, rotating.

Default: "sine"
Values: "sine" "piecewise" "rotating"
sine object

Level 4: Class for Sine source parameters

4 nested properties
frequency number | null

Frequency of the sine source (Hz).

Default: null
field_amplitude number | null

Amplitude of the sine field (T).

Default: null
current_amplitude number | null

Amplitude of the sine current (A).

Default: null
superimposed_DC object

Level 5: Class for superimposed DC field or current parameters for the sine source

piecewise object

Level 4: Class for piecewise (linear) source parameters

7 nested properties
source_csv_file string | null

File name for the from_file source type defining the time evolution of current and field (in-phase). Multipliers are used for each of them. The file should contain two columns: 'time' (s) and 'value' (field/current (T/A)), with these headers. If this field is set, times, applied_fields_relative and transport_currents_relative are ignored.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.

Default: null
applied_fields_relative number[] | null

Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
transport_currents_relative number[] | null

Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.

Default: null
applied_field_multiplier number | null

Multiplier for the applied fields in applied_fields_relative. Also used for the values in the source_csv_file.

Default: null
transport_current_multiplier number | null

Multiplier for the transport currents in transport_currents_relative. Also used for the values in the source_csv_file.

Default: null
rotating object

Level 4: Class for Rotating magnetic source field parameters

2 nested properties
frequency number | null

Frequency of field rotation around z-axis

Default: null
field_magnitude number | null

constant Magnitude of the rotating field (T).

Default: null
field_angle number | null

Angle of the source magnetic field, with respect to the x-axis (degrees).

Default: 90
numerical_parameters object

Level 3: Class for numerical parameters

3 nested properties
sine object

Level 4: Numerical parameters corresponding to the sine source

2 nested properties
timesteps_per_period number | null

Initial value for number of time steps (-) per period for the sine source. Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the sine source.

Default: null
piecewise object

Level 4: Numerical parameters corresponding to the piecewise source

6 nested properties
time_to_simulate number | null

Total time to simulate (s). Used for the piecewise source.

Default: null
timesteps_per_time_to_simulate number | null

If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.

Default: null
force_stepping_at_times_piecewise_linear boolean

If True, time-stepping will contain exactly the time instants that are in the times_source_piecewise_linear list (to avoid truncation maximum applied field/current values).

Default: false
variable_max_timestep boolean

If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.

Default: false
times_max_timestep_piecewise_linear number[] | null

Time instants (s) defining the piecewise linear maximum time step.

Default: null
max_timestep_piecewise_linear number[] | null

Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

Default: null
rotating object

Level 4: Numerical parameters corresponding to the sine source

2 nested properties
timesteps_per_period number | null

Initial value for number of time steps (-) per period for source rotation. Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the source rotation.

Default: null
CACStrandSolveDiffusionBarriers object
enable boolean | null

Set True to enable diffusion barriers.

Default: false
load_data_from_yaml boolean | null

Set True to load the diffusion barrier data from the input YAML-file. Otherwise, the thickness and resistivity specified in this file are used.

Default: false
resistivity number | null

Resistivity of the diffusion barriers (Ohm*m).

Default: 1e-6
thickness number | null

Thickness of the diffusion barriers (m).

Default: 1e-6
CACStrandSolveFormulationparameters object

Level 3: Class for finite element formulation parameters

formulation string

Which formulation? CATI is the default and usual choice to model hysteresis/coupling/eddy currents with the CATI method. AI_uncoupled is a conventional 2D formulation with axial currents modelling UNCOUPLED filaments (and eddy currents in matrix).

Default: "CATI"
Values: "CATI" "AI_uncoupled"
dynamic_correction boolean | null

With the CATI method, do we activate the dynamic correction?

Default: true
compute_temperature boolean | null

Do we compute the temperature?

Default: false
two_ell_periodicity boolean | null

With CATI method: True to integrate over twice the shortest periodicity length (recommended), False to integrate over the shortest periodicity length (not recommended).

Default: true
CACStrandSolveGeneralparameters object

Level 3: Class for general parameters

temperature number

Temperature (K) of the strand.

Default: 1.9
superconductor_linear boolean | null

For debugging: replace LTS by normal conductor.

Default: false
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
CACStrandSolveInitialconditions object

Level 3: Class for initial conditions

init_type string | null

Type of initialization for the simulation. (i) 'virgin' is the default type, the initial magnetic field is zero, (ii) 'pos_file' is to initialize from the solution of another solution, given by the solution_to_init_from entry, and (iii) 'uniform_field' is to initialize at a uniform field, which will be the applied field at the initial time of the simulation. Note that the uniform_field option does not allow any non-zero transport current.

Default: "virgin"
solution_to_init_from integer | string | null

Name xxx of the solution from which the simulation should be initialized. The file last_magnetic_field.pos of folder Solution_xxx will be used for the initial solution. It must be in the Geometry_xxx/Mesh_xxx/ folder in which the Solution_xxx will be saved.

Default: null
CACStrandSolveNumericalparameters object

Level 3: Class for numerical parameters

sine object

Level 4: Numerical parameters corresponding to the sine source

2 nested properties
timesteps_per_period number | null

Initial value for number of time steps (-) per period for the sine source. Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the sine source.

Default: null
piecewise object

Level 4: Numerical parameters corresponding to the piecewise source

6 nested properties
time_to_simulate number | null

Total time to simulate (s). Used for the piecewise source.

Default: null
timesteps_per_time_to_simulate number | null

If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.

Default: null
force_stepping_at_times_piecewise_linear boolean

If True, time-stepping will contain exactly the time instants that are in the times_source_piecewise_linear list (to avoid truncation maximum applied field/current values).

Default: false
variable_max_timestep boolean

If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.

Default: false
times_max_timestep_piecewise_linear number[] | null

Time instants (s) defining the piecewise linear maximum time step.

Default: null
max_timestep_piecewise_linear number[] | null

Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

Default: null
rotating object

Level 4: Numerical parameters corresponding to the sine source

2 nested properties
timesteps_per_period number | null

Initial value for number of time steps (-) per period for source rotation. Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the source rotation.

Default: null
CACStrandSolveNumericalparametersPiecewise object

Level 4: Numerical parameters corresponding to the piecewise source

time_to_simulate number | null

Total time to simulate (s). Used for the piecewise source.

Default: null
timesteps_per_time_to_simulate number | null

If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.

Default: null
force_stepping_at_times_piecewise_linear boolean

If True, time-stepping will contain exactly the time instants that are in the times_source_piecewise_linear list (to avoid truncation maximum applied field/current values).

Default: false
variable_max_timestep boolean

If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.

Default: false
times_max_timestep_piecewise_linear number[] | null

Time instants (s) defining the piecewise linear maximum time step.

Default: null
max_timestep_piecewise_linear number[] | null

Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

Default: null
CACStrandSolveNumericalparametersRotating object

Level 4: Numerical parameters corresponding to the sine source

timesteps_per_period number | null

Initial value for number of time steps (-) per period for source rotation. Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the source rotation.

Default: null
CACStrandSolveNumericalparametersSine object

Level 4: Numerical parameters corresponding to the sine source

timesteps_per_period number | null

Initial value for number of time steps (-) per period for the sine source. Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the sine source.

Default: null
CACStrandSolveSourceparameters object

Level 3: Class for material properties

source_type string

Time evolution of applied current and magnetic field. Supported options are: sine, sine_with_DC, piecewise_linear, from_list, rotating.

Default: "sine"
Values: "sine" "piecewise" "rotating"
sine object

Level 4: Class for Sine source parameters

4 nested properties
frequency number | null

Frequency of the sine source (Hz).

Default: null
field_amplitude number | null

Amplitude of the sine field (T).

Default: null
current_amplitude number | null

Amplitude of the sine current (A).

Default: null
superimposed_DC object

Level 5: Class for superimposed DC field or current parameters for the sine source

2 nested properties
field_magnitude number | null

DC field magnitude (T), in the same direction as the AC applied field. Solution must be initialized with a non-zero field solution, either stored in a .pos file, or a uniform field, if non-zero DC field is used.

Default: 0.0
current_magnitude number | null

DC current magnitude (A). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC current is used.

Default: 0.0
piecewise object

Level 4: Class for piecewise (linear) source parameters

7 nested properties
source_csv_file string | null

File name for the from_file source type defining the time evolution of current and field (in-phase). Multipliers are used for each of them. The file should contain two columns: 'time' (s) and 'value' (field/current (T/A)), with these headers. If this field is set, times, applied_fields_relative and transport_currents_relative are ignored.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.

Default: null
applied_fields_relative number[] | null

Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
transport_currents_relative number[] | null

Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.

Default: null
applied_field_multiplier number | null

Multiplier for the applied fields in applied_fields_relative. Also used for the values in the source_csv_file.

Default: null
transport_current_multiplier number | null

Multiplier for the transport currents in transport_currents_relative. Also used for the values in the source_csv_file.

Default: null
rotating object

Level 4: Class for Rotating magnetic source field parameters

2 nested properties
frequency number | null

Frequency of field rotation around z-axis

Default: null
field_magnitude number | null

constant Magnitude of the rotating field (T).

Default: null
field_angle number | null

Angle of the source magnetic field, with respect to the x-axis (degrees).

Default: 90
CACStrandSolveSourceparametersPiecewise object

Level 4: Class for piecewise (linear) source parameters

source_csv_file string | null

File name for the from_file source type defining the time evolution of current and field (in-phase). Multipliers are used for each of them. The file should contain two columns: 'time' (s) and 'value' (field/current (T/A)), with these headers. If this field is set, times, applied_fields_relative and transport_currents_relative are ignored.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.

Default: null
applied_fields_relative number[] | null

Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
transport_currents_relative number[] | null

Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.

Default: null
applied_field_multiplier number | null

Multiplier for the applied fields in applied_fields_relative. Also used for the values in the source_csv_file.

Default: null
transport_current_multiplier number | null

Multiplier for the transport currents in transport_currents_relative. Also used for the values in the source_csv_file.

Default: null
CACStrandSolveSourceparametersRotating object

Level 4: Class for Rotating magnetic source field parameters

frequency number | null

Frequency of field rotation around z-axis

Default: null
field_magnitude number | null

constant Magnitude of the rotating field (T).

Default: null
CACStrandSolveSourceparametersSine object

Level 4: Class for Sine source parameters

frequency number | null

Frequency of the sine source (Hz).

Default: null
field_amplitude number | null

Amplitude of the sine field (T).

Default: null
current_amplitude number | null

Amplitude of the sine current (A).

Default: null
superimposed_DC object

Level 5: Class for superimposed DC field or current parameters for the sine source

2 nested properties
field_magnitude number | null

DC field magnitude (T), in the same direction as the AC applied field. Solution must be initialized with a non-zero field solution, either stored in a .pos file, or a uniform field, if non-zero DC field is used.

Default: 0.0
current_magnitude number | null

DC current magnitude (A). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC current is used.

Default: 0.0
CACStrandSolveSourceparametersSineSuperimposedDC object

Level 5: Class for superimposed DC field or current parameters for the sine source

field_magnitude number | null

DC field magnitude (T), in the same direction as the AC applied field. Solution must be initialized with a non-zero field solution, either stored in a .pos file, or a uniform field, if non-zero DC field is used.

Default: 0.0
current_magnitude number | null

DC current magnitude (A). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC current is used.

Default: 0.0
CC object

Level 2: Class for coated conductor parameters

type string required
Constant: "CC"
HTS_thickness number | null

HTS thickness in meters.

Default: null
HTS_width number | null

HTS width in meters.

Default: null
number_of_filaments integer | null

Number of HTS filaments. If 1, no striation case

Default: 1
gap_between_filaments number | null

Gap between HTS filaments in meters. Only applies when number_of_filaments > 1.

Default: null
substrate_thickness number | null

Substrate layer thickness in meters.

Default: null
copper_thickness object
4 nested properties
left number | null

On the left side.

Default: null
right number | null

On the right side.

Default: null
top number | null

On the top side.

Default: null
bottom number | null

On the bottom side.

Default: null
silver_thickness object
2 nested properties
top number | null

On the top side.

Default: null
bottom number | null

On the bottom side.

Default: null
material_superconductor string | null

Material of the superconductor. E.g. NbTi, Nb3Sn, etc.

Default: null
n_value_superconductor number | null

n value of the superconductor (for power law fit).

Default: null
ec_superconductor number | null

Critical electric field of the superconductor.

Default: null
minimum_jc_fraction number | 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

Default: null
minimum_jc_field number | 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

Default: null
k_material_superconductor string | number | null

Thermal conductivity of the superconductor.

Default: null
Cv_material_superconductor string | number | null

Material function for specific heat of the superconductor.

Default: null
k_material_stabilizer string | number | null

Thermal conductivity of the stabilizer, typically copper.

Default: null
Cv_material_stabilizer string | number | null

Material function for specific heat of the stabilizer, typically copper.

Default: null
rho_material_stabilizer string | number | null

Material function for resistivity of the stabilizer. Constant resistivity can be given as float.

Default: null
RRR number | number[] | 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)

Default: null
T_ref_RRR_high number | null

Upper reference temperature for RRR measurements.

Default: null
T_ref_RRR_low number | null

Lower reference temperature for RRR measurements.

Default: null
k_material_silver string | number | null

Thermal conductivity of the silver

Default: null
Cv_material_silver string | number | null

Material function for specific heat of the silver

Default: null
rho_material_silver string | number | null

Material function for resistivity of the silver. Constant resistivity can be given as float.

Default: null
RRR_silver number | number[] | 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)

Default: null
T_ref_RRR_high_silver number | null

Upper reference temperature for RRR measurements for silver.

Default: null
T_ref_RRR_low_silver number | null

Lower reference temperature for RRR measurements for silver.

Default: null
rho_material_substrate string | number | null

Material function for resistivity of the substrate. Constant resistivity can be given as float.

Default: null
k_material_substrate string | number | null

Thermal conductivity of the substrate.

Default: null
Cv_material_substrate string | number | null

Material function for specific heat of the substrate.

Default: null
CCPostProc object
variables_I string[] | null

Currents from the circuit that will be exported as csv

Default:
[]
variables_U string[] | null

Voltages from the circuit that will be exported as csv

Default:
[]
assemble_veusz boolean | null

It determines whether the post-processing data is assembled in a veusz file.

Default: false
CCT object

Level 1: Class for FiQuS CCT

type string
Default: "CCT_straight"
Constant: "CCT_straight"
geometry object

Level 2: Class for FiQuS CCT for FiQuS input

4 nested properties
windings object

Level 2: Class for FiQuS CCT

10 nested properties
names string[] | null
Default: null
r_wms number[] | null
Default: null
n_turnss number[] | null
Default: null
ndpts integer[] | null
Default: null
ndpt_ins integer[] | null
Default: null
ndpt_outs integer[] | null
Default: null
lps number[] | null
Default: null
alphas number[] | null
Default: null
wwws number[] | null
Default: null
wwhs number[] | null
Default: null
fqpls object

Level 2: Class for FiQuS CCT

10 nested properties
names string[]
Default:
[]
fndpls integer[] | null
Default: null
fwws number[] | null
Default: null
fwhs number[] | null
Default: null
r_ins number[] | null
Default: null
r_bs number[] | null
Default: null
n_sbs integer[] | null
Default: null
thetas number[] | null
Default: null
z_starts string[] | null
Default: null
z_ends number[] | null
Default: null
formers object

Level 2: Class for FiQuS CCT

5 nested properties
names string[] | null
Default: null
r_ins number[] | null
Default: null
r_outs number[] | null
Default: null
z_mins number[] | null
Default: null
z_maxs number[] | null
Default: null
air object

Level 2: Class for FiQuS CCT

5 nested properties
name string | null
Default: null
sh_type string | null
Default: null
ar number | null
Default: null
z_min number | null
Default: null
z_max number | null
Default: null
mesh object

Level 2: Class for FiQuS CCT

5 nested properties
MaxAspectWindings number | null
Default: null
ThresholdSizeMin number | null
Default: null
ThresholdSizeMax number | null
Default: null
ThresholdDistMin number | null
Default: null
ThresholdDistMax number | null
Default: null
solve object

Level 2: Class for FiQuS CCT

8 nested properties
windings object

Level 2: Class for FiQuS CCT

3 nested properties
currents number[] | null
Default: null
sigmas number[] | null
Default: null
mu_rs number[] | null
Default: null
fqpls object

Level 2: Class for FiQuS CCT

3 nested properties
currents number[]
Default:
[]
sigmas number[]
Default:
[]
mu_rs number[]
Default:
[]
formers object

Level 2: Class for FiQuS CCT

2 nested properties
sigmas number[] | null
Default: null
mu_rs number[] | null
Default: null
air object

Level 2: Class for FiQuS CCT

2 nested properties
sigma number | null
Default: null
mu_r number | null
Default: null
pro_template string | null
Default: null
variables string[] | null
Default: null
volumes string[] | null
Default: null
file_exts string[] | null
Default: null
postproc object

Class for FiQuS CCT input file

8 nested properties
windings_wwns integer[] | null
Default: null
windings_whns integer[] | null
Default: null
additional_outputs string[] | null
Default: null
winding_order integer[] | null
Default: null
fqpl_export_trim_tol number[] | null
Default: null
variables string[] | null
Default: null
volumes string[] | null
Default: null
file_exts string[] | null
Default: null
CLIQ_Class object

Level 2: Class for the CLIQ parameters

t_trigger number | null

Trigger time of CLIQ unit [s].

Default: 99999.0
current_direction integer[]

Polarity of current in groups specified as a list with length equal to the number of groups [-].

Default:
[]
sym_factor number | null

Obsolete.

Default: null
N_units integer | null

Obsolete.

Default: null
U0 number | null

Initial charging voltage of CLIQ unit [V].

Default: 0
C number | null

Capacitance of CLIQ unit [F].

Default: 0
R number | null

Resistance of CLIQ unit [Ohm].

Default: 0
L number | null

Inductance of CLIQ unit [H].

Default: 0
I0 number | null

Obsolete.

Default: null
CUDI1 object

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

type string required
Constant: "CUDI1"
Tc0_CUDI1 number | null
Default: null
Bc20_CUDI1 number | null
Default: null
C1_CUDI1 number | null
Default: null
C2_CUDI1 number | null
Default: null
CUDI3 object

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

type string required
Constant: "CUDI3"
Tc0_CUDI3 number | null
Default: null
Bc20_CUDI3 number | null
Default: null
c1_CUDI3 number | null
Default: null
c2_CUDI3 number | null
Default: null
c3_CUDI3 number | null
Default: null
c4_CUDI3 number | null
Default: null
c5_CUDI3 number | null
Default: null
c6_CUDI3 number | null
Default: null
CWSStrandPostprocCleanup object

Level 3: Class for cleanup settings

remove_pre_file boolean

Set True to remove the .pre-file after post-processing, to save disk space.

Default: false
remove_res_file boolean

Set True to remove the .res-file after post-processing, to save disk space.

Default: false
remove_msh_file boolean

Set True to remove the .msh-file after post-processing, to save disk space.

Default: false
Circle object

Level 2: Class for Input/Output settings for the cable geometry

center_position number[] | null

Center position in two dimensional plane (x, y).

Default: null
radius number | null

Radius of the circle (m).

Default: null
Circuit_Class object

Level 1: Class for the circuit parameters

field_circuit boolean | null

Allows to use Field-Circuit Coupling equations in the model.

Default: false
R_circuit number | null
Default: null
L_circuit number | null
Default: null
R_parallel number | null
Default: null
Conductor object

Level 1: Class for conductor parameters

version string | null
Default: null
case string | null
Default: null
state string | null
Default: null
cable Rutherford | Mono | Ribbon | TSTC
Default:
{
  "type": "Rutherford"
}
strand Round | Rectangular | CC | Homogenized
Default:
{
  "type": "Round"
}
Jc_fit ConstantJc | Bottura | CUDI1 | CUDI3 | Summers | Bordini | Nb3Sn_HFM | BSCCO_2212_LBNL | Ic_A_NbTi | ProDefined | Succi_fixed | Fujikura
Default:
{
  "type": "CUDI1"
}
ConstantJc object

Level 3: Class for setting constant Jc

type string required
Constant: "Constant Jc"
Jc_constant number | null
Default: null
Copper_thickness object
left number | null

On the left side.

Default: null
right number | null

On the right side.

Default: null
top number | null

On the top side.

Default: null
bottom number | null

On the bottom side.

Default: null
ESC_Class object

Level 2: Class for the ESC parameters

t_trigger number[]

Trigger time of ESC units [s] given as a list with length corresponding to the number of ESC units.

Default:
[]
U0 number[]

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

Default:
[]
C number[]

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

Default:
[]
L number[]

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

Default:
[]
R_unit number[]

Internal resistance of ESC units [Ohm] given as a list with length corresponding to the number of ESC units.

Default:
[]
R_leads number[]

Resistance of leads from ESC coil to ESC diode connections [Ohm] given as a list with length corresponding to the number of ESC units.

Default:
[]
Ud_Diode number[]

Forward diodes voltage across ESC coils [V] given as a list with length corresponding to the number of ESC units.

Default:
[]
L_Diode number[]

Inductance in series with diodes across ESC coils [V] given as a list with length corresponding to the number of ESC units.

Default:
[]
E_CLIQ_Class object

Level 2: Class for the E-CLIQ parameters for protection

t_trigger number[] | null

Trigger time of E-CLIQ current sources [s] given as a list with length corresponding to the number of E-CLIQ units.

Default:
[]
R_leads number[] | null

List of E-CLIQ unit lead resistances [Ohm]. List length corresponding to the number of E-CLIQ units.

Default: null
L_leads number[] | null

List of E-CLIQ unit lead inductances [H]. List length corresponding to the number of E-CLIQ units.

Default: null
source_type enum

Time evolution of applied current. Supported options are: sine, piecewise.

Default: null
Values: "sine" "piecewise" null
sine object

Level 3: Class for Sine source parameters for E-CLIQ

4 nested properties
frequency number | null

Frequency of the sine source [Hz].

Default: null
current_amplitude number | null

Amplitude of the sine current (A/turn).

Default: null
number_of_periods number | null

Number of periods of ECLIQ power supply [-].

Default: null
number_of_turns integer | null

Number of turns that conform ECLIQ [-].

Default: null
piecewise object

Level 3 Class for piecewise (linear) source parameters for E-CLIQ

5 nested properties
csv_file string | 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.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.

Default: null
currents number[] | null

E-CLIQ coil currents relative to current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.

Default: null
current_multiplier number | null

Multiplier for the E-CLIQ coil currents in currents. Also used for the values in the source_csv_file.

Default: null
quench_propagation string | null

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.

Default: "full"
quench_prop_model string | null

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.

Default: "Ts"
NZPV_multiplier number | null

Factor that multiplies the Normal Zone Propagation Velocity

Default: 1.0
N_units integer[] | null

Number of E-CLIQ units along the magnet length per ecliq coil. It must be an odd number for symmetry reasons.

Default:
[]
h_ecliq number[] | null

Spacing between the ecliq coils along the magnet length (m).

Default:
[]
l_ecliq number[] | null

length of the ecliq coils along the magnet length (m).

Default:
[]
L_ecliq_offset number[] | null

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).

Default:
[]
iECLIQ_toHalfTurn_From integer[] | null

List of coils to which the ECLIQ units are connected from, to which half turns they are in direct contact with.

Default:
[]
iECLIQ_toHalfTurn_To integer[] | null

List of half turns to whom the ECLIQ Units are in direct contact with.

Default:
[]
EnergyExtraction object

Level 2: Class for the energy extraction parameters

t_trigger number | null

Trigger time on the positive lead [s]. tEE (LEDET), tSwitchDelay (ProteCCT)

Default: 99999.0
R_EE number | null

Energy extraction resistance on the positive lead [Ohm]. R_EE_triggered (ProteCCT)

Default: 0
power_R_EE number | null

Varistor power component, R(I) = R_EE*abs(I)^power_R_EE on the positive lead [-]. RDumpPower (ProteCCT)

Default: 0.0
L number | null

Inductance in series with resistor on the positive lead [H].

Default: 0
C number | null

Snubber capacitance in parallel to the EE switch on the positive lead [F].

Default: 0
L_c number | null

Inductance in the snubber capacitance branch in parallel to the EE switch on the positive lead [H].

Default: 0
R_c number | null

Resistance in the snubber capacitance branch in parallel to the EE switch on the positive lead [Ohm].

Default: 0
Ud_snubber number | null

Forward voltage of diode in the snubber capacitance branch in parallel to the EE switch on the positive lead [V].

Default: 0
L_s number | null

Inductance in the EE switch branch on the positive lead [H].

Default: 0
R_s number | null

Resistance in the EE switch branch on the positive lead [Ohm].

Default: 0
Ud_switch number | null

Forward voltage of diode in the EE switch branch on the positive lead [V].

Default: 0
t_trigger_n number | null

Trigger time on the negative lead [s]. tEE (LEDET), tSwitchDelay (ProteCCT)

Default: 99999.0
R_EE_n number | null

Energy extraction resistance on the negative lead [Ohm]. R_EE_triggered (ProteCCT)

Default: 0
power_R_EE_n number | null

Varistor power component, R(I) = R_EE*abs(I)^power_R_EE on the negative lead [-]. RDumpPower (ProteCCT)

Default: 0.0
L_n number | null

Inductance in series with resistor on the negative lead [H].

Default: 0
C_n number | null

Snubber capacitance in parallel to the EE switch on the negative lead [F].

Default: 0
L_c_n number | null

Inductance in the snubber capacitance branch in parallel to the EE switch on the negative lead [H].

Default: 0
R_c_n number | null

Resistance in the snubber capacitance branch in parallel to the EE switch on the negative lead [Ohm].

Default: 0
Ud_snubber_n number | null

Forward voltage of diode in the snubber capacitance branch in parallel to the EE switch on the negative lead [V].

Default: 0
L_s_n number | null

Inductance in the EE switch branch on the negative lead [H].

Default: 0
R_s_n number | null

Resistance in the EE switch branch on the negative lead [Ohm].

Default: 0
Ud_switch_n number | null

Forward voltage of diode in the EE switch branch on the negative lead [V].

Default: 0
FQPL_g object

Level 2: Class for FiQuS CCT

names string[]
Default:
[]
fndpls integer[] | null
Default: null
fwws number[] | null
Default: null
fwhs number[] | null
Default: null
r_ins number[] | null
Default: null
r_bs number[] | null
Default: null
n_sbs integer[] | null
Default: null
thetas number[] | null
Default: null
z_starts string[] | null
Default: null
z_ends number[] | null
Default: null
FQPL_s object

Level 2: Class for FiQuS CCT

currents number[]
Default:
[]
sigmas number[]
Default:
[]
mu_rs number[]
Default:
[]
Former_gFiQuS object

Level 2: Class for FiQuS CCT

names string[] | null
Default: null
r_ins number[] | null
Default: null
r_outs number[] | null
Default: null
z_mins number[] | null
Default: null
z_maxs number[] | null
Default: null
Former_s object

Level 2: Class for FiQuS CCT

sigmas number[] | null
Default: null
mu_rs number[] | null
Default: null
Fujikura object

Level 3: Class for cable Fujikura's fit

type string required
Constant: "Fujikura"
Jc_factor number | null

This factor multiplies the Jc returned by the function.

Default: 1.0
GeneralFiQuS object

Class for FiQuS general

magnet_name string | null
Default: null
GeometryCCTFiQuS object

Level 2: Class for FiQuS CCT for FiQuS input

windings object

Level 2: Class for FiQuS CCT

10 nested properties
names string[] | null
Default: null
r_wms number[] | null
Default: null
n_turnss number[] | null
Default: null
ndpts integer[] | null
Default: null
ndpt_ins integer[] | null
Default: null
ndpt_outs integer[] | null
Default: null
lps number[] | null
Default: null
alphas number[] | null
Default: null
wwws number[] | null
Default: null
wwhs number[] | null
Default: null
fqpls object

Level 2: Class for FiQuS CCT

10 nested properties
names string[]
Default:
[]
fndpls integer[] | null
Default: null
fwws number[] | null
Default: null
fwhs number[] | null
Default: null
r_ins number[] | null
Default: null
r_bs number[] | null
Default: null
n_sbs integer[] | null
Default: null
thetas number[] | null
Default: null
z_starts string[] | null
Default: null
z_ends number[] | null
Default: null
formers object

Level 2: Class for FiQuS CCT

5 nested properties
names string[] | null
Default: null
r_ins number[] | null
Default: null
r_outs number[] | null
Default: null
z_mins number[] | null
Default: null
z_maxs number[] | null
Default: null
air object

Level 2: Class for FiQuS CCT

5 nested properties
name string | null
Default: null
sh_type string | null
Default: null
ar number | null
Default: null
z_min number | null
Default: null
z_max number | null
Default: null
Homogenized object

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

type string required
Constant: "Homogenized"
diameter number | 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.

Default: null
HomogenizedConductorFormulationparameters object

Level 3: Class for finite element formulation parameters

hphia boolean | null

Use hphia formulation.

Default: false
HomogenizedConductorFormulationparametersCS object

Level 4: Class for Current Sharing (CS) model parameters

superconductor_n_value number | null

n value for the power law (-), used in current sharing law.

Default: 30
superconductor_Ic number | null

Critical current of the strands (A) (e.g., typical value at T=1.9K and B=10T). Will be taken as a constant as in this model the field dependence is not included (the main purpose of the model is to verify the more efficient Homogenized Conductor model). Including field-dependence could be done but is not trivial because is mixes global and local quantities in this Rutherford model with strand discretized individually as stranded conductors.

Default: 350
matrix_resistance number | null

Resistance of the matrix (per unit length) (Ohm/m) for the current sharing law. Kept constant in this model (for simplicity).

Default: 0.0006536208
HomogenizedConductorFormulationparametersDISCC object

Level 4: Class for DISCC model parameters

gamma_c number | null

Main crossing scaling parameter (-) that quantifies crossing coupling due to field perpendicular to cable wide face.

Default: 0.43
gamma_a number | null

Main adjacent scaling parameter (-) that quantifies adjacent coupling due to field parallel to cable wide face.

Default: 0.53
lambda_a number | null

Mixing scaling parameter (-) that quantifies adjacent coupling due to field perpendicular to cable wide face.

Default: 0.006
crossing_coupling_resistance number | null

Resistance (Ohm) of the contact between crossing strands.

Default: 0.00002
adjacent_coupling_resistance number | null

Resistance (Ohm) of the contact between adjacent strands over one periodicity length (strand twist pitch divided by the number of strands).

Default: 0.00001
HomogenizedConductorFormulationparametersSampleLine object

Level 3: Class for sampling along a predefined line within the model

start_point number[] | null

Start point of the line in cartesian coordinates: [x,y,z].

Default: null
end_point number[] | null

End point of the line in cartesian coordinates: [x,y,z].

Default: null
samples integer | null

Integer number of evenly spaced sample points along the line including start and end point.

Default: null
HomogenizedConductorGeometry object

Level 2: Class for strand geometry parameters

cables_definition Rectangle[]
Default:
{
  "center_position": null,
  "width": null,
  "height": null
}
excitation_coils Rectangle[] | null

List of excitation coils

Default:
[]
air object

Level 2: Class for Input/Output settings for the cable geometry

2 nested properties
center_position number[] | null

Center position in two dimensional plane (x, y).

Default: null
radius number | null

Radius of the circle (m).

Default: null
air_form string

Type of model geometry which will be generated. Supported options are only circle for now

Default: "circle"
Constant: "circle"
io_settings object

Level 2: Class for Input/Output settings for the cable geometry

2 nested properties
load object

Level 3: Class for Input/Output settings for the cable geometry

2 nested properties
load_from_yaml boolean | null

True to load the geometry from a YAML file, false to generate the geometry.

Default: false
filename string | null

Name of the YAML file from which to load the geometry.

Default: null
save object

Level 3: Class for Input/Output settings for the cable geometry

2 nested properties
save_to_yaml boolean | null

True to save the geometry to a YAML-file, false to not save the geometry.

Default: false
filename string | null

Name of the output geometry YAML file.

Default: null
HomogenizedConductorGeometryIOsettings object

Level 2: Class for Input/Output settings for the cable geometry

load object

Level 3: Class for Input/Output settings for the cable geometry

2 nested properties
load_from_yaml boolean | null

True to load the geometry from a YAML file, false to generate the geometry.

Default: false
filename string | null

Name of the YAML file from which to load the geometry.

Default: null
save object

Level 3: Class for Input/Output settings for the cable geometry

2 nested properties
save_to_yaml boolean | null

True to save the geometry to a YAML-file, false to not save the geometry.

Default: false
filename string | null

Name of the output geometry YAML file.

Default: null
HomogenizedConductorIOsettingsLoad object

Level 3: Class for Input/Output settings for the cable geometry

load_from_yaml boolean | null

True to load the geometry from a YAML file, false to generate the geometry.

Default: false
filename string | null

Name of the YAML file from which to load the geometry.

Default: null
HomogenizedConductorIOsettingsSave object

Level 3: Class for Input/Output settings for the cable geometry

save_to_yaml boolean | null

True to save the geometry to a YAML-file, false to not save the geometry.

Default: false
filename string | null

Name of the output geometry YAML file.

Default: null
HomogenizedConductorMesh object

Level 2: Class for FiQuS ConductorAC

scaling_global number | null

Global scaling factor for mesh size.

Default: 1
air_boundary_mesh_size_ratio number | null

Ratio within the air region from boundary to inner elements.

Default: 1
cable_mesh_size_ratio number | null

Scaling factor within the cable regions.

Default: 1
HomogenizedConductorNumericalparametersPiecewise object

Level 4: Numerical parameters corresponding to the piecewise source

time_to_simulate number | null

Total time to simulate (s). Used for the piecewise source.

Default: null
timesteps_per_time_to_simulate number | null

If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.

Default: null
force_stepping_at_times_piecewise_linear boolean

If True, time-stepping will contain exactly the time instants that are in the times_source_piecewise_linear list (to avoid truncation maximum applied field/current values).

Default: false
variable_max_timestep boolean

If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.

Default: false
times_max_timestep_piecewise_linear number[] | null

Time instants (s) defining the piecewise linear maximum time step.

Default: null
max_timestep_piecewise_linear number[] | null

Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

Default: null
HomogenizedConductorNumericalparametersSine object

Level 4: Numerical parameters corresponding to the sine source

timesteps_per_period number | null

Initial value for number of time steps (-) per period for the sine source. Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the sine source.

Default: null
HomogenizedConductorPostproc object

Level 2: Class for FiQuS ConductorAC

generate_pos_files boolean

Set True to generate .pos-files during post-processing

Default: true
output_folder string | null

Batch post-processing creates a folder with the given name in the output directory, where all the plots are saved.

Default: null
generate_report boolean | null

Generates a PDF report including all postprocessing graphs. File is saved in the output_folder.

Default: false
save_last_current_density string | null

Saves the last current density field solution (out-of-plane) in the file given as a string. The '.pos' extension will be appended to it. Nothing is done if None. This can be for using the current density as an initial condition (but not implemented yet).

Default: null
save_last_magnetic_field string | null

Saves the last magnetic field solution (in-plane) in the file given as a string. The '.pos' extension will be appended to it. Nothing is done if None. This is for using the magnetic field as an initial condition for another resolution.

Default: null
cleanup object

Level 3: Class for cleanup settings

3 nested properties
remove_pre_file boolean

Set True to remove the .pre-file after post-processing, to save disk space.

Default: false
remove_res_file boolean

Set True to remove the .res-file after post-processing, to save disk space.

Default: false
remove_msh_file boolean

Set True to remove the .msh-file after post-processing, to save disk space.

Default: false
sample_line object

Level 3: Class for sampling along a predefined line within the model

3 nested properties
start_point number[] | null

Start point of the line in cartesian coordinates: [x,y,z].

Default: null
end_point number[] | null

End point of the line in cartesian coordinates: [x,y,z].

Default: null
samples integer | null

Integer number of evenly spaced sample points along the line including start and end point.

Default: null
HomogenizedConductorPostprocCleanup object

Level 3: Class for cleanup settings

remove_pre_file boolean

Set True to remove the .pre-file after post-processing, to save disk space.

Default: false
remove_res_file boolean

Set True to remove the .res-file after post-processing, to save disk space.

Default: false
remove_msh_file boolean

Set True to remove the .msh-file after post-processing, to save disk space.

Default: false
HomogenizedConductorRunType object

Level 4: Class for runtype parameters

mode string | null

Type of simulation to run with homogenized conductors (ramp - real cooling conditions, isothermal_ramp - unlimited cooling, quench - non-zero initial conditions)

Default: "ramp"
ramp_file string | null

Name of the ramp model from which to start the simulation

Default: null
HomogenizedConductorSolve object

Level 2: Class for FiQuS HomogenizedConductor solver settings

pro_template string | null

Name of the .pro template file.

Default: "HomogenizedConductor_template.pro"
general_parameters object

Level 3: Class for general parameters

6 nested properties
superconductor_linear boolean | null

For debugging: replace LTS by normal conductor.

Default: false
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
rho_cables number | null

Resistance for cables when modelled as linear conductors (no current sharing with power law) [Ohm*m].

Default: 1
strand_transposition_length number | null

Transposition length of the strands in the Rutherford cable (m).

Default: 0.1
n_strands integer | null

Number of strands in the cable (-).

Default: 36
strand_filling_factor number | null

Filling factor of the strands in the rectangular cable envelope (-).

Default: 0.8617
formulation_parameters object

Level 3: Class for finite element formulation parameters

1 nested properties
hphia boolean | null

Use hphia formulation.

Default: false
discc object

Level 4: Class for DISCC model parameters

5 nested properties
gamma_c number | null

Main crossing scaling parameter (-) that quantifies crossing coupling due to field perpendicular to cable wide face.

Default: 0.43
gamma_a number | null

Main adjacent scaling parameter (-) that quantifies adjacent coupling due to field parallel to cable wide face.

Default: 0.53
lambda_a number | null

Mixing scaling parameter (-) that quantifies adjacent coupling due to field perpendicular to cable wide face.

Default: 0.006
crossing_coupling_resistance number | null

Resistance (Ohm) of the contact between crossing strands.

Default: 0.00002
adjacent_coupling_resistance number | null

Resistance (Ohm) of the contact between adjacent strands over one periodicity length (strand twist pitch divided by the number of strands).

Default: 0.00001
rohf object

Level 4: Class for ROHF model parameters

2 nested properties
enable boolean | null

Use ROHF to homogenize the internal flux hysteresis in the cables.

Default: false
parameter_csv_file string | null

Name of the csv file containing the ROHF parameters within the inputs folder with expected row structure: [alpha,kappa,tau].

Default: null
rohm object

Level 4: Class for ROHM model parameters

4 nested properties
enable boolean | null

Use ROHM to homogenize the magnetization hysteresis in the cables.

Default: false
parameter_csv_file string | null

Name of the csv file containing the ROHM parameters within the inputs folder with expected row structure: [alpha,kappa,chi,gamma,lambda].

Default: null
weight_scaling number | null

Downscaling factor (s<1.0) which is applied to all weights except the first, which is scaled up to compensate.

Default: 1.0
tau_scaling number | null

Scaling factor which is applied uniformly to all coupling time constants.

Default: 1.0
current_sharing object

Level 4: Class for Current Sharing (CS) model parameters

3 nested properties
superconductor_n_value number | null

n value for the power law (-), used in current sharing law.

Default: 30
superconductor_Ic number | null

Critical current of the strands (A) (e.g., typical value at T=1.9K and B=10T). Will be taken as a constant as in this model the field dependence is not included (the main purpose of the model is to verify the more efficient Homogenized Conductor model). Including field-dependence could be done but is not trivial because is mixes global and local quantities in this Rutherford model with strand discretized individually as stranded conductors.

Default: 350
matrix_resistance number | null

Resistance of the matrix (per unit length) (Ohm/m) for the current sharing law. Kept constant in this model (for simplicity).

Default: 0.0006536208
initial_conditions object

Level 3: Class for initial conditions

2 nested properties
init_from_pos_file boolean

This field is used to initialize the solution from a non-zero field solution stored in a .pos file.

Default: false
pos_file_to_init_from string | null

Name of .pos file for magnetic field (A/m) from which the solution should be initialized. Should be in the Geometry_xxx/Mesh_xxx/ folder in which the Solution_xxx will be saved.

Default: null
source_parameters object

Level 3: Class for material properties

8 nested properties
boundary_condition_type string

Type of boundary condition applied at the outer domain boundary.

Default: "Natural"
Values: "Natural" "Essential"
source_type string

Time evolution of applied current and magnetic field. Supported options are: sine, sine_with_DC, piecewise_linear, from_list.

Default: "sine"
Values: "sine" "piecewise"
parallel_resistor boolean | number | null

If False, no parallel resistor and the current source directly and only feeds the cable. If True, a resistor is placed in parallel with the cable, with a default resistance of 1 Ohm. If float (cannot be zero), this defines the value of the resistance. If more than one cable is modelled, they are all connected in series (and carry the same current).

Default: false
excitation_coils object

Level 5: Class for superimposed DC field or current parameters for the sine source

1 nested properties
enable boolean | null

Solve with excitation coils acting as sources.

Default: false
sine object

Level 4: Class for Sine source parameters

4 nested properties
frequency number | null

Frequency of the sine source (Hz).

Default: null
field_amplitude number | null

Amplitude of the sine field (T).

Default: null
current_amplitude number | null

Amplitude of the sine current (A).

Default: null
superimposed_DC object

Level 5: Class for superimposed DC field or current parameters for the sine source

piecewise object

Level 4: Class for piecewise (linear) source parameters

7 nested properties
source_csv_file string | null

File name for the from_file source type defining the time evolution of current and field (in-phase). Multipliers are used for each of them. The file should contain two columns: 'time' (s) and 'value' (field/current (T/A)), with these headers. If this field is set, times, applied_fields_relative and transport_currents_relative are ignored.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.

Default: null
applied_fields_relative number[] | null

Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
transport_currents_relative number[] | null

Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.

Default: null
applied_field_multiplier number | null

Multiplier for the applied fields in applied_fields_relative. Also used for the values in the source_csv_file.

Default: null
transport_current_multiplier number | null

Multiplier for the transport currents in transport_currents_relative. Also used for the values in the source_csv_file.

Default: null
field_angle number | null

Angle of the source magnetic field, with respect to the x-axis (degrees).

Default: 90
cable_current_multipliers number[] | null

Individual multipliers applied to the transport current imposed in each cable. factors are applied according to the cable declarations in the geometry section of the yaml.

Default: null
numerical_parameters object

Level 3: Class for numerical parameters

2 nested properties
sine object

Level 4: Numerical parameters corresponding to the sine source

2 nested properties
timesteps_per_period number | null

Initial value for number of time steps (-) per period for the sine source. Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the sine source.

Default: null
piecewise object

Level 4: Numerical parameters corresponding to the piecewise source

6 nested properties
time_to_simulate number | null

Total time to simulate (s). Used for the piecewise source.

Default: null
timesteps_per_time_to_simulate number | null

If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.

Default: null
force_stepping_at_times_piecewise_linear boolean

If True, time-stepping will contain exactly the time instants that are in the times_source_piecewise_linear list (to avoid truncation maximum applied field/current values).

Default: false
variable_max_timestep boolean

If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.

Default: false
times_max_timestep_piecewise_linear number[] | null

Time instants (s) defining the piecewise linear maximum time step.

Default: null
max_timestep_piecewise_linear number[] | null

Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

Default: null
frequency_domain_solver object

Level 3: Class for frequency domain solver parameters

2 nested properties
enable boolean | null

Enable frequency solver functionality in the solve step.

Default: false
frequency_sweep object

Level 4: Class for the frequency sweep definition within a frequency domain solver.

4 nested properties
run_sweep boolean | null

Enabling a frequency sweep.

Default: false
start_frequency number | null

Start frequency of the sweep in Hz.

Default: 1
end_frequency number | null

End frequency of the sweep in Hz.

Default: 100
number_of_frequencies integer | null

Total number of frequencies in the sweep (logspaced)

Default: 3
HomogenizedConductorSolveFrequencyDomain object

Level 3: Class for frequency domain solver parameters

enable boolean | null

Enable frequency solver functionality in the solve step.

Default: false
frequency_sweep object

Level 4: Class for the frequency sweep definition within a frequency domain solver.

4 nested properties
run_sweep boolean | null

Enabling a frequency sweep.

Default: false
start_frequency number | null

Start frequency of the sweep in Hz.

Default: 1
end_frequency number | null

End frequency of the sweep in Hz.

Default: 100
number_of_frequencies integer | null

Total number of frequencies in the sweep (logspaced)

Default: 3
HomogenizedConductorSolveFrequencyDomainSweep object

Level 4: Class for the frequency sweep definition within a frequency domain solver.

run_sweep boolean | null

Enabling a frequency sweep.

Default: false
start_frequency number | null

Start frequency of the sweep in Hz.

Default: 1
end_frequency number | null

End frequency of the sweep in Hz.

Default: 100
number_of_frequencies integer | null

Total number of frequencies in the sweep (logspaced)

Default: 3
HomogenizedConductorSolveGeneralparameters object

Level 3: Class for general parameters

superconductor_linear boolean | null

For debugging: replace LTS by normal conductor.

Default: false
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
rho_cables number | null

Resistance for cables when modelled as linear conductors (no current sharing with power law) [Ohm*m].

Default: 1
strand_transposition_length number | null

Transposition length of the strands in the Rutherford cable (m).

Default: 0.1
n_strands integer | null

Number of strands in the cable (-).

Default: 36
strand_filling_factor number | null

Filling factor of the strands in the rectangular cable envelope (-).

Default: 0.8617
HomogenizedConductorSolveInitialconditions object

Level 3: Class for initial conditions

init_from_pos_file boolean

This field is used to initialize the solution from a non-zero field solution stored in a .pos file.

Default: false
pos_file_to_init_from string | null

Name of .pos file for magnetic field (A/m) from which the solution should be initialized. Should be in the Geometry_xxx/Mesh_xxx/ folder in which the Solution_xxx will be saved.

Default: null
HomogenizedConductorSolveNumericalparameters object

Level 3: Class for numerical parameters

sine object

Level 4: Numerical parameters corresponding to the sine source

2 nested properties
timesteps_per_period number | null

Initial value for number of time steps (-) per period for the sine source. Determines the initial time step size.

Default: null
number_of_periods_to_simulate number | null

Number of periods (-) to simulate for the sine source.

Default: null
piecewise object

Level 4: Numerical parameters corresponding to the piecewise source

6 nested properties
time_to_simulate number | null

Total time to simulate (s). Used for the piecewise source.

Default: null
timesteps_per_time_to_simulate number | null

If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.

Default: null
force_stepping_at_times_piecewise_linear boolean

If True, time-stepping will contain exactly the time instants that are in the times_source_piecewise_linear list (to avoid truncation maximum applied field/current values).

Default: false
variable_max_timestep boolean

If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.

Default: false
times_max_timestep_piecewise_linear number[] | null

Time instants (s) defining the piecewise linear maximum time step.

Default: null
max_timestep_piecewise_linear number[] | null

Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

Default: null
HomogenizedConductorSolveSourceparameters object

Level 3: Class for material properties

boundary_condition_type string

Type of boundary condition applied at the outer domain boundary.

Default: "Natural"
Values: "Natural" "Essential"
source_type string

Time evolution of applied current and magnetic field. Supported options are: sine, sine_with_DC, piecewise_linear, from_list.

Default: "sine"
Values: "sine" "piecewise"
parallel_resistor boolean | number | null

If False, no parallel resistor and the current source directly and only feeds the cable. If True, a resistor is placed in parallel with the cable, with a default resistance of 1 Ohm. If float (cannot be zero), this defines the value of the resistance. If more than one cable is modelled, they are all connected in series (and carry the same current).

Default: false
excitation_coils object

Level 5: Class for superimposed DC field or current parameters for the sine source

1 nested properties
enable boolean | null

Solve with excitation coils acting as sources.

Default: false
sine object

Level 4: Class for Sine source parameters

4 nested properties
frequency number | null

Frequency of the sine source (Hz).

Default: null
field_amplitude number | null

Amplitude of the sine field (T).

Default: null
current_amplitude number | null

Amplitude of the sine current (A).

Default: null
superimposed_DC object

Level 5: Class for superimposed DC field or current parameters for the sine source

2 nested properties
field_magnitude number | null

DC field magnitude (T) (direction along y-axis). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC field is used.

Default: 0.0
current_magnitude number | null

DC current magnitude (A). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC current is used.

Default: 0.0
piecewise object

Level 4: Class for piecewise (linear) source parameters

7 nested properties
source_csv_file string | null

File name for the from_file source type defining the time evolution of current and field (in-phase). Multipliers are used for each of them. The file should contain two columns: 'time' (s) and 'value' (field/current (T/A)), with these headers. If this field is set, times, applied_fields_relative and transport_currents_relative are ignored.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.

Default: null
applied_fields_relative number[] | null

Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
transport_currents_relative number[] | null

Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.

Default: null
applied_field_multiplier number | null

Multiplier for the applied fields in applied_fields_relative. Also used for the values in the source_csv_file.

Default: null
transport_current_multiplier number | null

Multiplier for the transport currents in transport_currents_relative. Also used for the values in the source_csv_file.

Default: null
field_angle number | null

Angle of the source magnetic field, with respect to the x-axis (degrees).

Default: 90
cable_current_multipliers number[] | null

Individual multipliers applied to the transport current imposed in each cable. factors are applied according to the cable declarations in the geometry section of the yaml.

Default: null
Ic_A_NbTi object

Level 3: Class for setting IcNbTi fit

type string required
Constant: "Ic_A_NbTi"
Jc_5T_4_2K number | null
Default: null
MeshCCT object

Level 2: Class for FiQuS CCT

MaxAspectWindings number | null
Default: null
ThresholdSizeMin number | null
Default: null
ThresholdSizeMax number | null
Default: null
ThresholdDistMin number | null
Default: null
ThresholdDistMax number | null
Default: null
Mono object

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

type string required
Constant: "Mono"
bare_cable_width number | null
Default: null
bare_cable_height_low number | null
Default: null
bare_cable_height_high number | null
Default: null
bare_cable_height_mean number | null
Default: null
th_insulation_along_width number | null
Default: null
th_insulation_along_height number | null
Default: null
f_superconductor number | null
Default: null
f_stabilizer number | null
Default: null
f_insulation number | null
Default: null
f_inner_voids number | null
Default: null
f_outer_voids number | null
Default: null
material_insulation string | null
Default: null
material_inner_voids string | null
Default: null
material_outer_voids string | null
Default: null
MultipleSolveCollarHeCooling object
enabled boolean | null

It determines whether the helium cooling is enabled or not (adiabatic conditions).

Default: false
which string | array | null

It specifies the boundaries where the collar cooling is applied. If 'all', it applies to all boundaries. If a list, it applies to the specified boundaries numbered counter-clockwise.

Default: "all"
heat_transfer_coefficient string | number | null

It specifies the value or name of the function of the constant heat transfer coefficient.

Default: "CFUN_hHe_T_THe"
ref_temperature number | null

It specifies the reference temperature for the collar cooling. If not specified, it takes the value of the initial temperature.

Default: 0.0
move_cooling_holes string | integer | number[][] | null

It specifies if and how cooling holes are to be moved. Either choose '1' or '2' for predefined positions or a list [[dx,dy], [dx2,dy2]].. to shift each hole manually

Default: null
Multipole object

Level 1: Class for FiQuS Multipole

type string
Default: "multipole"
Constant: "multipole"
geometry object

Level 2: Class for FiQuS Multipole

4 nested properties
geom_file_path string | null

It contains the path to a .geom file. If null, the default .geom file produced by steam-sdk BuilderFiQuS will be used.

Default: null
plot_preview boolean | null

If true, it displays matplotlib figures of the magnet geometry with relevant information (e.g., conductor and block numbers).

Default: false
electromagnetics object

Level 2: Class for FiQuS Multipole

4 nested properties
create boolean

It determines whether the geometry is built or not.

Default: true
with_wedges boolean | null

It determines whether the wedge regions are built or not.

Default: true
areas string[] | null

List with areas to build.

Default:
[]
symmetry string | null

It determines the model regions to build according to the specified axis/axes.

Default: "none"
thermal object

Level 2: Class for FiQuS Multipole

6 nested properties
create boolean

It determines whether the geometry is built or not.

Default: true
with_wedges boolean | null

It determines whether the wedge regions are built or not.

Default: true
areas string[] | null

List with areas to build.

Default:
[]
use_TSA boolean | null

It determines whether the insulation regions are explicitly built or modeled via thin-shell approximation.

Default: false
correct_block_coil_tsa_checkered_scheme boolean | null

There is a bug in the TSA naming scheme for block coils, this flag activates a simple (not clean) bug fix that will be replaced in a future version.

Default: false
use_TSA_new boolean | null

It determines whether the regions between collar and coils are modeled via thin-shell approximation.

Default: false
mesh object

Level 2: Class for FiQuS Multipole

2 nested properties
electromagnetics object

Level 2: Class for FiQuS Multipole

7 nested properties
create boolean

It determines whether the mesh is built or not.

Default: true
conductors MultipoleMeshTransfiniteOrField | null

This dictionary contains the mesh information for the conductor regions.

Default:
{
  "transfinite": {
    "curve_target_size_height": 1.0,
    "curve_target_size_width": 1.0,
    "enabled_for": null
  },
  "field": {
    "DistMax": null,
    "DistMin": null,
    "SizeMax": null,
    "SizeMin": null,
    "enabled": false
  }
}
wedges MultipoleMeshTransfiniteOrField | null

This dictionary contains the mesh information for the wedge regions.

Default:
{
  "transfinite": {
    "curve_target_size_height": 1.0,
    "curve_target_size_width": 1.0,
    "enabled_for": null
  },
  "field": {
    "DistMax": null,
    "DistMin": null,
    "SizeMax": null,
    "SizeMin": null,
    "enabled": false
  }
}
iron_field MultipoleMeshThreshold | null

This dictionary contains the gmsh Field information for the iron yoke region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
collar MultipoleMeshThresholdCollar | null

This dictionary contains the gmsh Field information for the collar region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null,
  "Enforce_TSA_mapping": false
}
poles MultipoleMeshThreshold | null

This dictionary contains the mesh information for the poles region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
bore_field MultipoleMeshThreshold | null

This dictionary contains the gmsh Field information for the bore region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
thermal object

Level 2: Class for FiQuS Multipole

10 nested properties
create boolean

It determines whether the mesh is built or not.

Default: true
conductors MultipoleMeshTransfiniteOrField | null

This dictionary contains the mesh information for the conductor regions.

Default:
{
  "transfinite": {
    "curve_target_size_height": 1.0,
    "curve_target_size_width": 1.0,
    "enabled_for": null
  },
  "field": {
    "DistMax": null,
    "DistMin": null,
    "SizeMax": null,
    "SizeMin": null,
    "enabled": false
  }
}
wedges MultipoleMeshTransfiniteOrField | null

This dictionary contains the mesh information for the wedge regions.

Default:
{
  "transfinite": {
    "curve_target_size_height": 1.0,
    "curve_target_size_width": 1.0,
    "enabled_for": null
  },
  "field": {
    "DistMax": null,
    "DistMin": null,
    "SizeMax": null,
    "SizeMin": null,
    "enabled": false
  }
}
iron_field MultipoleMeshThreshold | null

This dictionary contains the gmsh Field information for the iron yoke region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
collar MultipoleMeshThresholdCollar | null

This dictionary contains the gmsh Field information for the collar region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null,
  "Enforce_TSA_mapping": false
}
poles MultipoleMeshThreshold | null

This dictionary contains the mesh information for the poles region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
reference MultipoleMeshThreshold | null

It determines whether the reference mesh is built or not. If True, an additional layer between the insulation and collar is meshed

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
insulation MultipoleThermalInsulationMesh | null

This dictionary contains the mesh information for the insulation regions.

Default:
{
  "global_size": 0.0001,
  "TSA": {
    "global_size_COL": 0.0001,
    "global_size_QH": 0.0001,
    "minimum_discretizations": 1,
    "minimum_discretizations_COL": 1,
    "minimum_discretizations_QH": 1,
    "scale_factor_azimuthal": -1.0,
    "scale_factor_radial": -1.0
  }
}
isothermal_conductors boolean | null

It determines whether the conductors are considered isothermal or not using getDP constraints.

Default: false
isothermal_wedges boolean | null

It determines whether the wedges are considered isothermal or not using getDP Link constraints.

Default: false
solve object

Level 2: Class for FiQuS Multipole

10 nested properties
coil_windings MultipoleSolveCoilWindings | null

This dictionary contains the information pertaining the number of coils and electrical order necessary to generate the associated electrical circuit

Default:
{
  "conductor_to_group": [],
  "group_to_coil_section": [],
  "polarities_in_group": [],
  "half_turn_length": [],
  "electrical_pairs": {
    "group_together": [],
    "overwrite_electrical_order": [],
    "reversed": []
  }
}
electromagnetics object

Level 3: Class for FiQuS Multipole

3 nested properties
non_linear_solver object

Level 4: Class for FiQuS Multipole

solve_type enum | null

It determines whether the magneto-static problem is solved ('stationary') or not ('null').

Default: null
time_stepping MultipoleSolveTransientElectromagnetics | null

This dictionary contains the information about the parameters for the transient solver.

Default:
{
  "initial_time": 0.0,
  "final_time": 0.0,
  "initial_time_step": 1e-10,
  "min_time_step": 1e-12,
  "max_time_step": 10.0,
  "breakpoints": [],
  "integration_method": "Euler",
  "rel_tol_time": 0.0001,
  "abs_tol_time": 0.0001,
  "norm_type": "LinfNorm",
  "T_sim": 1.9
}
thermal object

Level 3: Class for FiQuS Multipole

10 nested properties
non_linear_solver object

Level 4: Class for FiQuS Multipole

solve_type enum | null

It determines whether the thermal transient problem is solved ('transient') or not ('null').

Default: null
insulation_TSA MultipoleSolveInsulationTSA | null

This dictionary contains the information about the materials and thicknesses of the insulation regions modeled via thin-shell approximation.

Default:
{
  "block_to_block": {
    "blocks_connection_overwrite": [],
    "material": null,
    "materials_overwrite": [],
    "thicknesses_overwrite": []
  },
  "exterior": {
    "blocks": [],
    "materials_append": [],
    "thicknesses_append": []
  },
  "between_collar": {
    "material": null
  }
}
He_cooling object

Level 4: Class for FiQuS Multipole

collar_cooling object
overwrite_boundary_conditions MultipoleSolveBoundaryConditionsThermal | null

This dictionary contains the information about boundary conditions for explicitly specified boundaries.

Default:
{
  "temperature": {},
  "heat_flux": {},
  "cooling": {}
}
time_stepping object

Level 4: Class for FiQuS Multipole

jc_degradation_to_zero MultipoleSolveQuenchInitiation | null

This dictionary contains the information about half turns with zero critical current.

Default:
{
  "turns": [],
  "t_trigger": []
}
init_temperature number | null

It specifies the initial temperature of the simulation.

Default: 1.9
enforce_init_temperature_as_minimum boolean | null

It determines whether the initial temperature is enforced as the minimum temperature of the simulation.

Default: false
wedges object

Level 3: Class for FiQuS Multipole

4 nested properties
material string | null

It specifies the material of the region.

Default: null
RRR number | null

It specifies the RRR of the region.

Default: null
T_ref_RRR_high number | null

It specifies the reference temperature associated with the RRR.

Default: null
transient_effects_enabled boolean | null

It determines whether the transient effects are enabled or not.

Default: false
collar object

Level 3: Class for FiQuS Multipole

4 nested properties
material string | null

It specifies the material of the region.

Default: null
RRR number | null

It specifies the RRR of the region.

Default: null
T_ref_RRR_high number | null

It specifies the reference temperature associated with the RRR.

Default: null
transient_effects_enabled boolean | null

It determines whether the transient effects are enabled or not.

Default: false
iron_yoke object

Level 3: Class for FiQuS Multipole

4 nested properties
material string | null

It specifies the material of the region.

Default: null
RRR number | null

It specifies the RRR of the region.

Default: null
T_ref_RRR_high number | null

It specifies the reference temperature associated with the RRR.

Default: null
transient_effects_enabled boolean | null

It determines whether the transient effects are enabled or not.

Default: false
poles object

Level 3: Class for FiQuS Multipole

4 nested properties
material string | null

It specifies the material of the region.

Default: null
RRR number | null

It specifies the RRR of the region.

Default: null
T_ref_RRR_high number | null

It specifies the reference temperature associated with the RRR.

Default: null
transient_effects_enabled boolean | null

It determines whether the transient effects are enabled or not.

Default: false
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
time_stepping MultipoleSolveTransientCoupled | null

This dictionary contains the information about the parameters for the transient solver.

Default:
{
  "initial_time": 0.0,
  "final_time": 0.0,
  "initial_time_step": 1e-10,
  "min_time_step": 1e-12,
  "max_time_step": 10.0,
  "breakpoints": [],
  "integration_method": "Euler",
  "rel_tol_time": [
    0.0001,
    0.0001
  ],
  "abs_tol_time": [
    0.0001,
    0.0001
  ],
  "norm_type": [
    "LinfNorm",
    "LinfNorm"
  ],
  "stop_temperature": 300.0,
  "seq_NL": true
}
cable_homogenization fiqus__data__DataFiQuSMultipole__HomogenizedConductor | null

This dictionary contains the information about the homogenized conductor properties.

Default:
{
  "enabled": false,
  "run_type": {
    "mode": "ramp",
    "ramp_file": null
  },
  "rohm": {
    "enabled": false,
    "gather_cell_systems": false,
    "parameter_csv_file": null,
    "tau_scaling": 1.0,
    "weight_scaling": 1.0
  },
  "rohf": {
    "enabled": false,
    "gather_cell_systems": false,
    "parameter_csv_file": null
  }
}
postproc object

Level 2: Class for FiQuS Multipole

3 nested properties
electromagnetics object

Level 2: Class for FiQuS Multipole

8 nested properties
output_time_steps_pos boolean | integer | null

It determines whether the solution for the .pos file is saved for all time steps (True), none (False), or equidistant time steps (int).

Default: true
output_time_steps_txt boolean | integer | null

It determines whether the solution for the .txt file is saved for all time steps (True), none (False), or equidistant time steps (int).

Default: true
save_pos_at_the_end boolean | null

It determines whether the solution for the .pos file is saved at the end of the simulation or during run time.

Default: true
save_txt_at_the_end boolean | null

It determines whether the solution for the .txt file is saved at the end of the simulation or during run time.

Default: false
plot_all boolean | null

It determines whether the figures are generated and shown (true), generated only (null), or not generated (false). Useful for tests.

Default: false
compare_to_ROXIE string | null

It contains the absolute path to a reference ROXIE map2d file. If provided, comparative plots with respect to the reference are generated.

Default: null
variables string[] | null

It specifies the physical quantity to be output.

Default:
[]
volumes string[] | null

It specifies the regions associated with the physical quantity to be output.

Default:
[]
thermal object

Level 2: Class for FiQuS Multipole

8 nested properties
output_time_steps_pos boolean | integer | null

It determines whether the solution for the .pos file is saved for all time steps (True), none (False), or equidistant time steps (int).

Default: true
output_time_steps_txt boolean | integer | null

It determines whether the solution for the .txt file is saved for all time steps (True), none (False), or equidistant time steps (int).

Default: true
save_pos_at_the_end boolean | null

It determines whether the solution for the .pos file is saved at the end of the simulation or during run time.

Default: true
save_txt_at_the_end boolean | null

It determines whether the solution for the .txt file is saved at the end of the simulation or during run time.

Default: false
plot_all boolean | null

It determines whether the figures are generated and shown (true), generated only (null), or not generated (false). Useful for tests.

Default: false
take_average_conductor_temperature boolean | null

It determines whether the output files are based on the average conductor temperature or not (map2d).

Default: true
variables string[] | null

It specifies the physical quantity to be output.

Default:
[
  "T"
]
volumes string[] | null

It specifies the regions associated with the physical quantity to be output.

Default:
[
  "powered"
]
circuit_coupling object
3 nested properties
variables_I string[] | null

Currents from the circuit that will be exported as csv

Default:
[]
variables_U string[] | null

Voltages from the circuit that will be exported as csv

Default:
[]
assemble_veusz boolean | null

It determines whether the post-processing data is assembled in a veusz file.

Default: false
MultipoleGeometry object

Level 2: Class for FiQuS Multipole

geom_file_path string | null

It contains the path to a .geom file. If null, the default .geom file produced by steam-sdk BuilderFiQuS will be used.

Default: null
plot_preview boolean | null

If true, it displays matplotlib figures of the magnet geometry with relevant information (e.g., conductor and block numbers).

Default: false
electromagnetics object

Level 2: Class for FiQuS Multipole

4 nested properties
create boolean

It determines whether the geometry is built or not.

Default: true
with_wedges boolean | null

It determines whether the wedge regions are built or not.

Default: true
areas string[] | null

List with areas to build.

Default:
[]
symmetry string | null

It determines the model regions to build according to the specified axis/axes.

Default: "none"
thermal object

Level 2: Class for FiQuS Multipole

6 nested properties
create boolean

It determines whether the geometry is built or not.

Default: true
with_wedges boolean | null

It determines whether the wedge regions are built or not.

Default: true
areas string[] | null

List with areas to build.

Default:
[]
use_TSA boolean | null

It determines whether the insulation regions are explicitly built or modeled via thin-shell approximation.

Default: false
correct_block_coil_tsa_checkered_scheme boolean | null

There is a bug in the TSA naming scheme for block coils, this flag activates a simple (not clean) bug fix that will be replaced in a future version.

Default: false
use_TSA_new boolean | null

It determines whether the regions between collar and coils are modeled via thin-shell approximation.

Default: false
MultipoleGeometryElectromagnetics object

Level 2: Class for FiQuS Multipole

create boolean

It determines whether the geometry is built or not.

Default: true
with_wedges boolean | null

It determines whether the wedge regions are built or not.

Default: true
areas string[] | null

List with areas to build.

Default:
[]
symmetry string | null

It determines the model regions to build according to the specified axis/axes.

Default: "none"
MultipoleGeometryThermal object

Level 2: Class for FiQuS Multipole

create boolean

It determines whether the geometry is built or not.

Default: true
with_wedges boolean | null

It determines whether the wedge regions are built or not.

Default: true
areas string[] | null

List with areas to build.

Default:
[]
use_TSA boolean | null

It determines whether the insulation regions are explicitly built or modeled via thin-shell approximation.

Default: false
correct_block_coil_tsa_checkered_scheme boolean | null

There is a bug in the TSA naming scheme for block coils, this flag activates a simple (not clean) bug fix that will be replaced in a future version.

Default: false
use_TSA_new boolean | null

It determines whether the regions between collar and coils are modeled via thin-shell approximation.

Default: false
MultipoleMesh object

Level 2: Class for FiQuS Multipole

electromagnetics object

Level 2: Class for FiQuS Multipole

7 nested properties
create boolean

It determines whether the mesh is built or not.

Default: true
conductors MultipoleMeshTransfiniteOrField | null

This dictionary contains the mesh information for the conductor regions.

Default:
{
  "transfinite": {
    "curve_target_size_height": 1.0,
    "curve_target_size_width": 1.0,
    "enabled_for": null
  },
  "field": {
    "DistMax": null,
    "DistMin": null,
    "SizeMax": null,
    "SizeMin": null,
    "enabled": false
  }
}
wedges MultipoleMeshTransfiniteOrField | null

This dictionary contains the mesh information for the wedge regions.

Default:
{
  "transfinite": {
    "curve_target_size_height": 1.0,
    "curve_target_size_width": 1.0,
    "enabled_for": null
  },
  "field": {
    "DistMax": null,
    "DistMin": null,
    "SizeMax": null,
    "SizeMin": null,
    "enabled": false
  }
}
iron_field MultipoleMeshThreshold | null

This dictionary contains the gmsh Field information for the iron yoke region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
collar MultipoleMeshThresholdCollar | null

This dictionary contains the gmsh Field information for the collar region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null,
  "Enforce_TSA_mapping": false
}
poles MultipoleMeshThreshold | null

This dictionary contains the mesh information for the poles region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
bore_field MultipoleMeshThreshold | null

This dictionary contains the gmsh Field information for the bore region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
thermal object

Level 2: Class for FiQuS Multipole

10 nested properties
create boolean

It determines whether the mesh is built or not.

Default: true
conductors MultipoleMeshTransfiniteOrField | null

This dictionary contains the mesh information for the conductor regions.

Default:
{
  "transfinite": {
    "curve_target_size_height": 1.0,
    "curve_target_size_width": 1.0,
    "enabled_for": null
  },
  "field": {
    "DistMax": null,
    "DistMin": null,
    "SizeMax": null,
    "SizeMin": null,
    "enabled": false
  }
}
wedges MultipoleMeshTransfiniteOrField | null

This dictionary contains the mesh information for the wedge regions.

Default:
{
  "transfinite": {
    "curve_target_size_height": 1.0,
    "curve_target_size_width": 1.0,
    "enabled_for": null
  },
  "field": {
    "DistMax": null,
    "DistMin": null,
    "SizeMax": null,
    "SizeMin": null,
    "enabled": false
  }
}
iron_field MultipoleMeshThreshold | null

This dictionary contains the gmsh Field information for the iron yoke region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
collar MultipoleMeshThresholdCollar | null

This dictionary contains the gmsh Field information for the collar region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null,
  "Enforce_TSA_mapping": false
}
poles MultipoleMeshThreshold | null

This dictionary contains the mesh information for the poles region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
reference MultipoleMeshThreshold | null

It determines whether the reference mesh is built or not. If True, an additional layer between the insulation and collar is meshed

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
insulation MultipoleThermalInsulationMesh | null

This dictionary contains the mesh information for the insulation regions.

Default:
{
  "global_size": 0.0001,
  "TSA": {
    "global_size_COL": 0.0001,
    "global_size_QH": 0.0001,
    "minimum_discretizations": 1,
    "minimum_discretizations_COL": 1,
    "minimum_discretizations_QH": 1,
    "scale_factor_azimuthal": -1.0,
    "scale_factor_radial": -1.0
  }
}
isothermal_conductors boolean | null

It determines whether the conductors are considered isothermal or not using getDP constraints.

Default: false
isothermal_wedges boolean | null

It determines whether the wedges are considered isothermal or not using getDP Link constraints.

Default: false
MultipoleMeshElectromagnetics object

Level 2: Class for FiQuS Multipole

create boolean

It determines whether the mesh is built or not.

Default: true
conductors MultipoleMeshTransfiniteOrField | null

This dictionary contains the mesh information for the conductor regions.

Default:
{
  "transfinite": {
    "curve_target_size_height": 1.0,
    "curve_target_size_width": 1.0,
    "enabled_for": null
  },
  "field": {
    "DistMax": null,
    "DistMin": null,
    "SizeMax": null,
    "SizeMin": null,
    "enabled": false
  }
}
wedges MultipoleMeshTransfiniteOrField | null

This dictionary contains the mesh information for the wedge regions.

Default:
{
  "transfinite": {
    "curve_target_size_height": 1.0,
    "curve_target_size_width": 1.0,
    "enabled_for": null
  },
  "field": {
    "DistMax": null,
    "DistMin": null,
    "SizeMax": null,
    "SizeMin": null,
    "enabled": false
  }
}
iron_field MultipoleMeshThreshold | null

This dictionary contains the gmsh Field information for the iron yoke region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
collar MultipoleMeshThresholdCollar | null

This dictionary contains the gmsh Field information for the collar region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null,
  "Enforce_TSA_mapping": false
}
poles MultipoleMeshThreshold | null

This dictionary contains the mesh information for the poles region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
bore_field MultipoleMeshThreshold | null

This dictionary contains the gmsh Field information for the bore region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
MultipoleMeshThermal object

Level 2: Class for FiQuS Multipole

create boolean

It determines whether the mesh is built or not.

Default: true
conductors MultipoleMeshTransfiniteOrField | null

This dictionary contains the mesh information for the conductor regions.

Default:
{
  "transfinite": {
    "curve_target_size_height": 1.0,
    "curve_target_size_width": 1.0,
    "enabled_for": null
  },
  "field": {
    "DistMax": null,
    "DistMin": null,
    "SizeMax": null,
    "SizeMin": null,
    "enabled": false
  }
}
wedges MultipoleMeshTransfiniteOrField | null

This dictionary contains the mesh information for the wedge regions.

Default:
{
  "transfinite": {
    "curve_target_size_height": 1.0,
    "curve_target_size_width": 1.0,
    "enabled_for": null
  },
  "field": {
    "DistMax": null,
    "DistMin": null,
    "SizeMax": null,
    "SizeMin": null,
    "enabled": false
  }
}
iron_field MultipoleMeshThreshold | null

This dictionary contains the gmsh Field information for the iron yoke region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
collar MultipoleMeshThresholdCollar | null

This dictionary contains the gmsh Field information for the collar region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null,
  "Enforce_TSA_mapping": false
}
poles MultipoleMeshThreshold | null

This dictionary contains the mesh information for the poles region.

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
reference MultipoleMeshThreshold | null

It determines whether the reference mesh is built or not. If True, an additional layer between the insulation and collar is meshed

Default:
{
  "enabled": false,
  "SizeMin": null,
  "SizeMax": null,
  "DistMin": null,
  "DistMax": null
}
insulation MultipoleThermalInsulationMesh | null

This dictionary contains the mesh information for the insulation regions.

Default:
{
  "global_size": 0.0001,
  "TSA": {
    "global_size_COL": 0.0001,
    "global_size_QH": 0.0001,
    "minimum_discretizations": 1,
    "minimum_discretizations_COL": 1,
    "minimum_discretizations_QH": 1,
    "scale_factor_azimuthal": -1.0,
    "scale_factor_radial": -1.0
  }
}
isothermal_conductors boolean | null

It determines whether the conductors are considered isothermal or not using getDP constraints.

Default: false
isothermal_wedges boolean | null

It determines whether the wedges are considered isothermal or not using getDP Link constraints.

Default: false
MultipoleMeshThinShellApproximationParameters object

Level 4: Class for FiQuS Multipole

minimum_discretizations integer | null

It specifies the number of minimum spacial discretizations across a thin-shell.

Default: 1
global_size_QH number | null

The thickness of the quench heater region is divided by this parameter to determine the number of spacial discretizations across the thin-shell.

Default: 0.0001
minimum_discretizations_QH integer | null

It specifies the number of minimum spacial discretizations across a thin-shell.

Default: 1
global_size_COL number | null

The thickness of the region between ht and collar is divided by this parameter to determine the number of spacial discretizations across the thin-shell.

Default: 0.0001
minimum_discretizations_COL integer | null

It specifies the number of minimum spacial discretizations across a thin-shell.

Default: 1
scale_factor_radial number | null

Scaling factor for radially directed thin-shells (e.g. halfturns to collar). Set to -1.0 to use default scaling. Wedge scalings are always ignored.

Default: -1.0
scale_factor_azimuthal number | null

Scaling factor for azimuthally directed thin-shells (e.g. halfturns to pole). Set to -1.0 to use default scaling. Wedge scalings are always ignored.

Default: -1.0
MultipoleMeshThreshold object

Level 3: Class for FiQuS Multipole

enabled boolean | null

It determines whether the gmsh Field is enabled or not.

Default: false
SizeMin number | null

It sets gmsh Mesh.MeshSizeMin.

Default: null
SizeMax number | null

It sets gmsh Mesh.MeshSizeMax.

Default: null
DistMin number | null

It sets gmsh Mesh.MeshDistMin.

Default: null
DistMax number | null

It sets gmsh Mesh.MeshDistMax.

Default: null
MultipoleMeshThresholdCollar object

Level 3: Class for FiQuS Multipole

enabled boolean | null

It determines whether the gmsh Field is enabled or not.

Default: false
SizeMin number | null

It sets gmsh Mesh.MeshSizeMin.

Default: null
SizeMax number | null

It sets gmsh Mesh.MeshSizeMax.

Default: null
DistMin number | null

It sets gmsh Mesh.MeshDistMin.

Default: null
DistMax number | null

It sets gmsh Mesh.MeshDistMax.

Default: null
Enforce_TSA_mapping boolean | null

Enfocres matching nodes for the TSA layer. Uses SizeMin to determine the size of the nodes.

Default: false
MultipoleMeshTransfinite object

Level 3: Class for FiQuS Multipole

enabled_for enum

It determines on what entities the transfinite algorithm is applied.

Default: null
Values: null "curves" "curves_and_surfaces"
curve_target_size_height number | null

The height of the region (short side) is divided by this parameter to determine the number of elements to apply via transfinite curves.

Default: 1.0
curve_target_size_width number | null

The width of the region (long side) is divided by this parameter to determine the number of elements to apply via transfinite curves.

Default: 1.0
MultipoleMeshTransfiniteOrField object

Level 3: Class for FiQuS Multipole

transfinite object

Level 3: Class for FiQuS Multipole

3 nested properties
enabled_for enum

It determines on what entities the transfinite algorithm is applied.

Default: null
Values: null "curves" "curves_and_surfaces"
curve_target_size_height number | null

The height of the region (short side) is divided by this parameter to determine the number of elements to apply via transfinite curves.

Default: 1.0
curve_target_size_width number | null

The width of the region (long side) is divided by this parameter to determine the number of elements to apply via transfinite curves.

Default: 1.0
field object

Level 3: Class for FiQuS Multipole

5 nested properties
enabled boolean | null

It determines whether the gmsh Field is enabled or not.

Default: false
SizeMin number | null

It sets gmsh Mesh.MeshSizeMin.

Default: null
SizeMax number | null

It sets gmsh Mesh.MeshSizeMax.

Default: null
DistMin number | null

It sets gmsh Mesh.MeshDistMin.

Default: null
DistMax number | null

It sets gmsh Mesh.MeshDistMax.

Default: null
MultipolePostProc object

Level 2: Class for FiQuS Multipole

electromagnetics object

Level 2: Class for FiQuS Multipole

8 nested properties
output_time_steps_pos boolean | integer | null

It determines whether the solution for the .pos file is saved for all time steps (True), none (False), or equidistant time steps (int).

Default: true
output_time_steps_txt boolean | integer | null

It determines whether the solution for the .txt file is saved for all time steps (True), none (False), or equidistant time steps (int).

Default: true
save_pos_at_the_end boolean | null

It determines whether the solution for the .pos file is saved at the end of the simulation or during run time.

Default: true
save_txt_at_the_end boolean | null

It determines whether the solution for the .txt file is saved at the end of the simulation or during run time.

Default: false
plot_all boolean | null

It determines whether the figures are generated and shown (true), generated only (null), or not generated (false). Useful for tests.

Default: false
compare_to_ROXIE string | null

It contains the absolute path to a reference ROXIE map2d file. If provided, comparative plots with respect to the reference are generated.

Default: null
variables string[] | null

It specifies the physical quantity to be output.

Default:
[]
volumes string[] | null

It specifies the regions associated with the physical quantity to be output.

Default:
[]
thermal object

Level 2: Class for FiQuS Multipole

8 nested properties
output_time_steps_pos boolean | integer | null

It determines whether the solution for the .pos file is saved for all time steps (True), none (False), or equidistant time steps (int).

Default: true
output_time_steps_txt boolean | integer | null

It determines whether the solution for the .txt file is saved for all time steps (True), none (False), or equidistant time steps (int).

Default: true
save_pos_at_the_end boolean | null

It determines whether the solution for the .pos file is saved at the end of the simulation or during run time.

Default: true
save_txt_at_the_end boolean | null

It determines whether the solution for the .txt file is saved at the end of the simulation or during run time.

Default: false
plot_all boolean | null

It determines whether the figures are generated and shown (true), generated only (null), or not generated (false). Useful for tests.

Default: false
take_average_conductor_temperature boolean | null

It determines whether the output files are based on the average conductor temperature or not (map2d).

Default: true
variables string[] | null

It specifies the physical quantity to be output.

Default:
[
  "T"
]
volumes string[] | null

It specifies the regions associated with the physical quantity to be output.

Default:
[
  "powered"
]
circuit_coupling object
3 nested properties
variables_I string[] | null

Currents from the circuit that will be exported as csv

Default:
[]
variables_U string[] | null

Voltages from the circuit that will be exported as csv

Default:
[]
assemble_veusz boolean | null

It determines whether the post-processing data is assembled in a veusz file.

Default: false
MultipolePostProcElectromagnetics object

Level 2: Class for FiQuS Multipole

output_time_steps_pos boolean | integer | null

It determines whether the solution for the .pos file is saved for all time steps (True), none (False), or equidistant time steps (int).

Default: true
output_time_steps_txt boolean | integer | null

It determines whether the solution for the .txt file is saved for all time steps (True), none (False), or equidistant time steps (int).

Default: true
save_pos_at_the_end boolean | null

It determines whether the solution for the .pos file is saved at the end of the simulation or during run time.

Default: true
save_txt_at_the_end boolean | null

It determines whether the solution for the .txt file is saved at the end of the simulation or during run time.

Default: false
plot_all boolean | null

It determines whether the figures are generated and shown (true), generated only (null), or not generated (false). Useful for tests.

Default: false
compare_to_ROXIE string | null

It contains the absolute path to a reference ROXIE map2d file. If provided, comparative plots with respect to the reference are generated.

Default: null
variables string[] | null

It specifies the physical quantity to be output.

Default:
[]
volumes string[] | null

It specifies the regions associated with the physical quantity to be output.

Default:
[]
MultipolePostProcThermal object

Level 2: Class for FiQuS Multipole

output_time_steps_pos boolean | integer | null

It determines whether the solution for the .pos file is saved for all time steps (True), none (False), or equidistant time steps (int).

Default: true
output_time_steps_txt boolean | integer | null

It determines whether the solution for the .txt file is saved for all time steps (True), none (False), or equidistant time steps (int).

Default: true
save_pos_at_the_end boolean | null

It determines whether the solution for the .pos file is saved at the end of the simulation or during run time.

Default: true
save_txt_at_the_end boolean | null

It determines whether the solution for the .txt file is saved at the end of the simulation or during run time.

Default: false
plot_all boolean | null

It determines whether the figures are generated and shown (true), generated only (null), or not generated (false). Useful for tests.

Default: false
take_average_conductor_temperature boolean | null

It determines whether the output files are based on the average conductor temperature or not (map2d).

Default: true
variables string[] | null

It specifies the physical quantity to be output.

Default:
[
  "T"
]
volumes string[] | null

It specifies the regions associated with the physical quantity to be output.

Default:
[
  "powered"
]
MultipoleSolve object

Level 2: Class for FiQuS Multipole

coil_windings MultipoleSolveCoilWindings | null

This dictionary contains the information pertaining the number of coils and electrical order necessary to generate the associated electrical circuit

Default:
{
  "conductor_to_group": [],
  "group_to_coil_section": [],
  "polarities_in_group": [],
  "half_turn_length": [],
  "electrical_pairs": {
    "group_together": [],
    "overwrite_electrical_order": [],
    "reversed": []
  }
}
electromagnetics object

Level 3: Class for FiQuS Multipole

3 nested properties
non_linear_solver object

Level 4: Class for FiQuS Multipole

5 nested properties
rel_tolerance number | null

It specifies the relative tolerance.

Default: 0.0001
abs_tolerance number | null

It specifies the absolute tolerance.

Default: 0.1
relaxation_factor number | null

It specifies the relaxation factor.

Default: 0.7
max_iterations integer | null

It specifies the maximum number of iterations if no convergence is reached.

Default: 20
norm_type string

It specifies the type of norm to be calculated for convergence assessment.

Default: "LinfNorm"
Values: "L1Norm" "MeanL1Norm" "L2Norm" "MeanL2Norm" "LinfNorm"
solve_type enum | null

It determines whether the magneto-static problem is solved ('stationary') or not ('null').

Default: null
time_stepping MultipoleSolveTransientElectromagnetics | null

This dictionary contains the information about the parameters for the transient solver.

Default:
{
  "initial_time": 0.0,
  "final_time": 0.0,
  "initial_time_step": 1e-10,
  "min_time_step": 1e-12,
  "max_time_step": 10.0,
  "breakpoints": [],
  "integration_method": "Euler",
  "rel_tol_time": 0.0001,
  "abs_tol_time": 0.0001,
  "norm_type": "LinfNorm",
  "T_sim": 1.9
}
thermal object

Level 3: Class for FiQuS Multipole

10 nested properties
non_linear_solver object

Level 4: Class for FiQuS Multipole

5 nested properties
rel_tolerance number | null

It specifies the relative tolerance.

Default: 0.0001
abs_tolerance number | null

It specifies the absolute tolerance.

Default: 0.1
relaxation_factor number | null

It specifies the relaxation factor.

Default: 0.7
max_iterations integer | null

It specifies the maximum number of iterations if no convergence is reached.

Default: 20
norm_type string

It specifies the type of norm to be calculated for convergence assessment.

Default: "LinfNorm"
Values: "L1Norm" "MeanL1Norm" "L2Norm" "MeanL2Norm" "LinfNorm"
solve_type enum | null

It determines whether the thermal transient problem is solved ('transient') or not ('null').

Default: null
insulation_TSA MultipoleSolveInsulationTSA | null

This dictionary contains the information about the materials and thicknesses of the insulation regions modeled via thin-shell approximation.

Default:
{
  "block_to_block": {
    "blocks_connection_overwrite": [],
    "material": null,
    "materials_overwrite": [],
    "thicknesses_overwrite": []
  },
  "exterior": {
    "blocks": [],
    "materials_append": [],
    "thicknesses_append": []
  },
  "between_collar": {
    "material": null
  }
}
He_cooling object

Level 4: Class for FiQuS Multipole

3 nested properties
enabled boolean | null

It determines whether the helium cooling is enabled or not (adiabatic conditions).

Default: false
sides string | null

It specifies the general grouping of the boundaries where to apply cooling:'external': all external boundaries; 'inner': only inner boundaries; 'outer': only outer boundaries; 'inner_outer': inner and outer boundaries.

Default: "outer"
heat_transfer_coefficient string | number | null

It specifies the value or name of the function of the constant heat transfer coefficient.

Default: 0.0
collar_cooling object
5 nested properties
enabled boolean | null

It determines whether the helium cooling is enabled or not (adiabatic conditions).

Default: false
which string | array | null

It specifies the boundaries where the collar cooling is applied. If 'all', it applies to all boundaries. If a list, it applies to the specified boundaries numbered counter-clockwise.

Default: "all"
heat_transfer_coefficient string | number | null

It specifies the value or name of the function of the constant heat transfer coefficient.

Default: "CFUN_hHe_T_THe"
ref_temperature number | null

It specifies the reference temperature for the collar cooling. If not specified, it takes the value of the initial temperature.

Default: 0.0
move_cooling_holes string | integer | number[][] | null

It specifies if and how cooling holes are to be moved. Either choose '1' or '2' for predefined positions or a list [[dx,dy], [dx2,dy2]].. to shift each hole manually

Default: null
overwrite_boundary_conditions MultipoleSolveBoundaryConditionsThermal | null

This dictionary contains the information about boundary conditions for explicitly specified boundaries.

Default:
{
  "temperature": {},
  "heat_flux": {},
  "cooling": {}
}
time_stepping object

Level 4: Class for FiQuS Multipole

11 nested properties
initial_time number | null

It specifies the initial time of the simulation.

Default: 0.0
final_time number | null

It specifies the final time of the simulation.

Default: 0.0
initial_time_step number | null

It specifies the initial time step used at the beginning of the transient simulation.

Default: 1e-10
min_time_step number | null

It specifies the minimum possible value of the time step.

Default: 1e-12
max_time_step number | null

It specifies the maximum possible value of the time step.

Default: 10
breakpoints number[] | null

It forces the transient simulation to hit the time instants contained in this list.

Default:
[]
integration_method string | null

It specifies the type of integration method to be used.

Default: "Euler"
rel_tol_time number | null

It specifies the relative tolerance.

Default: 0.0001
abs_tol_time number | null

It specifies the absolute tolerance.

Default: 0.0001
norm_type string | null

It specifies the type of norm to be calculated for convergence assessment.

Default: "LinfNorm"
stop_temperature number | null

If one half turn reaches this temperature, the simulation is stopped.

Default: 300
jc_degradation_to_zero MultipoleSolveQuenchInitiation | null

This dictionary contains the information about half turns with zero critical current.

Default:
{
  "turns": [],
  "t_trigger": []
}
init_temperature number | null

It specifies the initial temperature of the simulation.

Default: 1.9
enforce_init_temperature_as_minimum boolean | null

It determines whether the initial temperature is enforced as the minimum temperature of the simulation.

Default: false
wedges object

Level 3: Class for FiQuS Multipole

4 nested properties
material string | null

It specifies the material of the region.

Default: null
RRR number | null

It specifies the RRR of the region.

Default: null
T_ref_RRR_high number | null

It specifies the reference temperature associated with the RRR.

Default: null
transient_effects_enabled boolean | null

It determines whether the transient effects are enabled or not.

Default: false
collar object

Level 3: Class for FiQuS Multipole

4 nested properties
material string | null

It specifies the material of the region.

Default: null
RRR number | null

It specifies the RRR of the region.

Default: null
T_ref_RRR_high number | null

It specifies the reference temperature associated with the RRR.

Default: null
transient_effects_enabled boolean | null

It determines whether the transient effects are enabled or not.

Default: false
iron_yoke object

Level 3: Class for FiQuS Multipole

4 nested properties
material string | null

It specifies the material of the region.

Default: null
RRR number | null

It specifies the RRR of the region.

Default: null
T_ref_RRR_high number | null

It specifies the reference temperature associated with the RRR.

Default: null
transient_effects_enabled boolean | null

It determines whether the transient effects are enabled or not.

Default: false
poles object

Level 3: Class for FiQuS Multipole

4 nested properties
material string | null

It specifies the material of the region.

Default: null
RRR number | null

It specifies the RRR of the region.

Default: null
T_ref_RRR_high number | null

It specifies the reference temperature associated with the RRR.

Default: null
transient_effects_enabled boolean | null

It determines whether the transient effects are enabled or not.

Default: false
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
time_stepping MultipoleSolveTransientCoupled | null

This dictionary contains the information about the parameters for the transient solver.

Default:
{
  "initial_time": 0.0,
  "final_time": 0.0,
  "initial_time_step": 1e-10,
  "min_time_step": 1e-12,
  "max_time_step": 10.0,
  "breakpoints": [],
  "integration_method": "Euler",
  "rel_tol_time": [
    0.0001,
    0.0001
  ],
  "abs_tol_time": [
    0.0001,
    0.0001
  ],
  "norm_type": [
    "LinfNorm",
    "LinfNorm"
  ],
  "stop_temperature": 300.0,
  "seq_NL": true
}
cable_homogenization fiqus__data__DataFiQuSMultipole__HomogenizedConductor | null

This dictionary contains the information about the homogenized conductor properties.

Default:
{
  "enabled": false,
  "run_type": {
    "mode": "ramp",
    "ramp_file": null
  },
  "rohm": {
    "enabled": false,
    "gather_cell_systems": false,
    "parameter_csv_file": null,
    "tau_scaling": 1.0,
    "weight_scaling": 1.0
  },
  "rohf": {
    "enabled": false,
    "gather_cell_systems": false,
    "parameter_csv_file": null
  }
}
MultipoleSolveBoundaryConditionsThermal object

Level 4: Class for FiQuS Multipole

temperature object | null

This dictionary contains the information about the Dirichlet boundary conditions.The keys are chosen names for each boundary condition.

Default:
{}
heat_flux object | null

This dictionary contains the information about the Neumann boundary conditions.The keys are chosen names for each boundary condition.

Default:
{}
cooling object | null

This dictionary contains the information about the Robin boundary conditions.The keys are chosen names for each boundary condition.

Default:
{}
MultipoleSolveCoilWindings object

Level 1: Class for winding information

conductor_to_group integer[] | null
Default:
[]
group_to_coil_section integer[] | null
Default:
[]
polarities_in_group integer[] | null
Default:
[]
half_turn_length number[] | null
Default:
[]
electrical_pairs MultipoleSolveCoilWindingsElectricalOrder | null
Default:
{
  "group_together": [],
  "reversed": [],
  "overwrite_electrical_order": []
}
MultipoleSolveCoilWindingsElectricalOrder object

Level 2: Class for the order of the electrical pairs

group_together integer[][] | null
Default:
[]
reversed integer[] | null
Default:
[]
overwrite_electrical_order integer[] | null
Default:
[]
MultipoleSolveConvectionBoundaryCondition object

Level 5: Class for FiQuS Multipole

boundaries string[] | null

It specifies the list of boundaries where the condition is applied.Each boundary is identified by a string of the form <half-turn/wedge reference number>,where the accepted sides are i, o, l, h which correspond respectively to inner, outer, lower (angle), higher (angle): e.g., 1o

Default:
[]
heat_transfer_coefficient string | number | null

It specifies the value or function name of the heat transfer coefficient for this boundary condition.

Default: null
MultipoleSolveElectromagnetics object

Level 3: Class for FiQuS Multipole

non_linear_solver object

Level 4: Class for FiQuS Multipole

5 nested properties
rel_tolerance number | null

It specifies the relative tolerance.

Default: 0.0001
abs_tolerance number | null

It specifies the absolute tolerance.

Default: 0.1
relaxation_factor number | null

It specifies the relaxation factor.

Default: 0.7
max_iterations integer | null

It specifies the maximum number of iterations if no convergence is reached.

Default: 20
norm_type string

It specifies the type of norm to be calculated for convergence assessment.

Default: "LinfNorm"
Values: "L1Norm" "MeanL1Norm" "L2Norm" "MeanL2Norm" "LinfNorm"
solve_type enum | null

It determines whether the magneto-static problem is solved ('stationary') or not ('null').

Default: null
time_stepping MultipoleSolveTransientElectromagnetics | null

This dictionary contains the information about the parameters for the transient solver.

Default:
{
  "initial_time": 0.0,
  "final_time": 0.0,
  "initial_time_step": 1e-10,
  "min_time_step": 1e-12,
  "max_time_step": 10.0,
  "breakpoints": [],
  "integration_method": "Euler",
  "rel_tol_time": 0.0001,
  "abs_tol_time": 0.0001,
  "norm_type": "LinfNorm",
  "T_sim": 1.9
}
MultipoleSolveHeCooling object

Level 4: Class for FiQuS Multipole

enabled boolean | null

It determines whether the helium cooling is enabled or not (adiabatic conditions).

Default: false
sides string | null

It specifies the general grouping of the boundaries where to apply cooling:'external': all external boundaries; 'inner': only inner boundaries; 'outer': only outer boundaries; 'inner_outer': inner and outer boundaries.

Default: "outer"
heat_transfer_coefficient string | number | null

It specifies the value or name of the function of the constant heat transfer coefficient.

Default: 0.0
MultipoleSolveHeatFluxBoundaryCondition object

Level 5: Class for FiQuS Multipole

boundaries string[] | null

It specifies the list of boundaries where the condition is applied.Each boundary is identified by a string of the form <half-turn/wedge reference number>,where the accepted sides are i, o, l, h which correspond respectively to inner, outer, lower (angle), higher (angle): e.g., 1o

Default:
[]
const_heat_flux number | null

It specifies the value of the heat flux for this boundary condition.

Default: null
MultipoleSolveInsulationBlockToBlock object

Level 4: Class for FiQuS Multipole It contains the information about the materials and thicknesses of the inner insulation regions (between blocks) modeled via thin-shell approximation.

material string | null

It specifies the default material of the insulation regions between the blocks insulation regions.

Default: null
blocks_connection_overwrite array[]

It specifies the blocks couples adjacent to the insulation region.The blocks must be ordered from inner to outer block for mid-layer insulation regions and from lower to higher angle block for mid-pole and mid-winding insulation regions.

Default:
[]
materials_overwrite string[][] | null

It specifies the list of materials making up the layered insulation region to be placed between the specified blocks.The materials must be ordered from inner to outer layers and lower to higher angle layers.

Default:
[]
thicknesses_overwrite number | null[][] | null

It specifies the list of thicknesses of the specified insulation layers. The order must match the one of the materials list.

Default:
[]
MultipoleSolveInsulationExterior object

Level 4: Class for FiQuS Multipole It contains the information about the materials and thicknesses of the outer insulation regions (exterior boundaries) modeled via thin-shell approximation.

blocks string[] | null

It specifies the reference numbers of the blocks adjacent to the exterior insulation regions to modify.

Default:
[]
materials_append string[][] | null

It specifies the list of materials making up the layered insulation region to be appended to the block insulation.The materials must be ordered from the block outward.

Default:
[]
thicknesses_append number[][] | null

It specifies the list of thicknesses of the specified insulation layers. The order must match the one of the materials list.

Default:
[]
MultipoleSolveInsulationTSA object

Level 3: Class for FiQuS Multipole

block_to_block object

Level 4: Class for FiQuS Multipole It contains the information about the materials and thicknesses of the inner insulation regions (between blocks) modeled via thin-shell approximation.

4 nested properties
material string | null

It specifies the default material of the insulation regions between the blocks insulation regions.

Default: null
blocks_connection_overwrite array[]

It specifies the blocks couples adjacent to the insulation region.The blocks must be ordered from inner to outer block for mid-layer insulation regions and from lower to higher angle block for mid-pole and mid-winding insulation regions.

Default:
[]
materials_overwrite string[][] | null

It specifies the list of materials making up the layered insulation region to be placed between the specified blocks.The materials must be ordered from inner to outer layers and lower to higher angle layers.

Default:
[]
thicknesses_overwrite number | null[][] | null

It specifies the list of thicknesses of the specified insulation layers. The order must match the one of the materials list.

Default:
[]
exterior MultipoleSolveInsulationExterior | null

This dictionary contains the information about the materials and thicknesses of the outer insulation regions (exterior boundaries) modeled via thin-shell approximation.

Default:
{
  "blocks": [],
  "materials_append": [],
  "thicknesses_append": []
}
between_collar MultipoleSolveInsulationBlockToBlock | null

This dictionary contains the information about the materials and thicknesses of the insulation regions between the collar and the outer insulation regions for thin-shell approximation.

Default:
{
  "material": null
}
MultipoleSolveNonLinearSolver object

Level 4: Class for FiQuS Multipole

rel_tolerance number | null

It specifies the relative tolerance.

Default: 0.0001
abs_tolerance number | null

It specifies the absolute tolerance.

Default: 0.1
relaxation_factor number | null

It specifies the relaxation factor.

Default: 0.7
max_iterations integer | null

It specifies the maximum number of iterations if no convergence is reached.

Default: 20
norm_type string

It specifies the type of norm to be calculated for convergence assessment.

Default: "LinfNorm"
Values: "L1Norm" "MeanL1Norm" "L2Norm" "MeanL2Norm" "LinfNorm"
MultipoleSolveQuenchInitiation object

Level 4: Class for FiQuS Multipole

turns integer[] | null

It specifies the list of reference numbers of half-turns whose critical currents are set to zero.

Default:
[]
t_trigger number[] | null

It specifies the list of time instants at which the critical current is set to zero.

Default:
[]
MultipoleSolveSpecificMaterial object

Level 3: Class for FiQuS Multipole

material string | null

It specifies the material of the region.

Default: null
RRR number | null

It specifies the RRR of the region.

Default: null
T_ref_RRR_high number | null

It specifies the reference temperature associated with the RRR.

Default: null
transient_effects_enabled boolean | null

It determines whether the transient effects are enabled or not.

Default: false
MultipoleSolveTemperatureBoundaryCondition object

Level 5: Class for FiQuS Multipole

boundaries string[] | null

It specifies the list of boundaries where the condition is applied.Each boundary is identified by a string of the form <half-turn/wedge reference number>,where the accepted sides are i, o, l, h which correspond respectively to inner, outer, lower (angle), higher (angle): e.g., 1o

Default:
[]
const_temperature number | null

It specifies the value of the temperature for this boundary condition.

Default: null
MultipoleSolveThermal object

Level 3: Class for FiQuS Multipole

non_linear_solver object

Level 4: Class for FiQuS Multipole

5 nested properties
rel_tolerance number | null

It specifies the relative tolerance.

Default: 0.0001
abs_tolerance number | null

It specifies the absolute tolerance.

Default: 0.1
relaxation_factor number | null

It specifies the relaxation factor.

Default: 0.7
max_iterations integer | null

It specifies the maximum number of iterations if no convergence is reached.

Default: 20
norm_type string

It specifies the type of norm to be calculated for convergence assessment.

Default: "LinfNorm"
Values: "L1Norm" "MeanL1Norm" "L2Norm" "MeanL2Norm" "LinfNorm"
solve_type enum | null

It determines whether the thermal transient problem is solved ('transient') or not ('null').

Default: null
insulation_TSA MultipoleSolveInsulationTSA | null

This dictionary contains the information about the materials and thicknesses of the insulation regions modeled via thin-shell approximation.

Default:
{
  "block_to_block": {
    "blocks_connection_overwrite": [],
    "material": null,
    "materials_overwrite": [],
    "thicknesses_overwrite": []
  },
  "exterior": {
    "blocks": [],
    "materials_append": [],
    "thicknesses_append": []
  },
  "between_collar": {
    "material": null
  }
}
He_cooling object

Level 4: Class for FiQuS Multipole

3 nested properties
enabled boolean | null

It determines whether the helium cooling is enabled or not (adiabatic conditions).

Default: false
sides string | null

It specifies the general grouping of the boundaries where to apply cooling:'external': all external boundaries; 'inner': only inner boundaries; 'outer': only outer boundaries; 'inner_outer': inner and outer boundaries.

Default: "outer"
heat_transfer_coefficient string | number | null

It specifies the value or name of the function of the constant heat transfer coefficient.

Default: 0.0
collar_cooling object
5 nested properties
enabled boolean | null

It determines whether the helium cooling is enabled or not (adiabatic conditions).

Default: false
which string | array | null

It specifies the boundaries where the collar cooling is applied. If 'all', it applies to all boundaries. If a list, it applies to the specified boundaries numbered counter-clockwise.

Default: "all"
heat_transfer_coefficient string | number | null

It specifies the value or name of the function of the constant heat transfer coefficient.

Default: "CFUN_hHe_T_THe"
ref_temperature number | null

It specifies the reference temperature for the collar cooling. If not specified, it takes the value of the initial temperature.

Default: 0.0
move_cooling_holes string | integer | number[][] | null

It specifies if and how cooling holes are to be moved. Either choose '1' or '2' for predefined positions or a list [[dx,dy], [dx2,dy2]].. to shift each hole manually

Default: null
overwrite_boundary_conditions MultipoleSolveBoundaryConditionsThermal | null

This dictionary contains the information about boundary conditions for explicitly specified boundaries.

Default:
{
  "temperature": {},
  "heat_flux": {},
  "cooling": {}
}
time_stepping object

Level 4: Class for FiQuS Multipole

11 nested properties
initial_time number | null

It specifies the initial time of the simulation.

Default: 0.0
final_time number | null

It specifies the final time of the simulation.

Default: 0.0
initial_time_step number | null

It specifies the initial time step used at the beginning of the transient simulation.

Default: 1e-10
min_time_step number | null

It specifies the minimum possible value of the time step.

Default: 1e-12
max_time_step number | null

It specifies the maximum possible value of the time step.

Default: 10
breakpoints number[] | null

It forces the transient simulation to hit the time instants contained in this list.

Default:
[]
integration_method string | null

It specifies the type of integration method to be used.

Default: "Euler"
rel_tol_time number | null

It specifies the relative tolerance.

Default: 0.0001
abs_tol_time number | null

It specifies the absolute tolerance.

Default: 0.0001
norm_type string | null

It specifies the type of norm to be calculated for convergence assessment.

Default: "LinfNorm"
stop_temperature number | null

If one half turn reaches this temperature, the simulation is stopped.

Default: 300
jc_degradation_to_zero MultipoleSolveQuenchInitiation | null

This dictionary contains the information about half turns with zero critical current.

Default:
{
  "turns": [],
  "t_trigger": []
}
init_temperature number | null

It specifies the initial temperature of the simulation.

Default: 1.9
enforce_init_temperature_as_minimum boolean | null

It determines whether the initial temperature is enforced as the minimum temperature of the simulation.

Default: false
MultipoleSolveTransientCoupled object

Level 4: Class for FiQuS Multipole

initial_time number | null

It specifies the initial time of the simulation.

Default: 0.0
final_time number | null

It specifies the final time of the simulation.

Default: 0.0
initial_time_step number | null

It specifies the initial time step used at the beginning of the transient simulation.

Default: 1e-10
min_time_step number | null

It specifies the minimum possible value of the time step.

Default: 1e-12
max_time_step number | null

It specifies the maximum possible value of the time step.

Default: 10
breakpoints number[] | null

It forces the transient simulation to hit the time instants contained in this list.

Default:
[]
integration_method string | null

It specifies the type of integration method to be used.

Default: "Euler"
rel_tol_time number[] | null

It specifies the relative tolerance.

Default:
[
  0.0001,
  0.0001
]
abs_tol_time number[] | null

It specifies the absolute tolerance.

Default:
[
  0.0001,
  0.0001
]
norm_type string[]

It specifies the type of norm to be calculated for convergence assessment.

Default:
[
  "LinfNorm",
  "LinfNorm"
]
stop_temperature number | null

If one half turn reaches this temperature, the simulation is stopped.

Default: 300
seq_NL boolean | null

The non-linear solver is sequential Mag->Thermal, or its fully coupled.

Default: true
MultipoleSolveTransientElectromagnetics object

Level 4: Class for FiQuS Multipole

initial_time number | null

It specifies the initial time of the simulation.

Default: 0.0
final_time number | null

It specifies the final time of the simulation.

Default: 0.0
initial_time_step number | null

It specifies the initial time step used at the beginning of the transient simulation.

Default: 1e-10
min_time_step number | null

It specifies the minimum possible value of the time step.

Default: 1e-12
max_time_step number | null

It specifies the maximum possible value of the time step.

Default: 10
breakpoints number[] | null

It forces the transient simulation to hit the time instants contained in this list.

Default:
[]
integration_method string | null

It specifies the type of integration method to be used.

Default: "Euler"
rel_tol_time number | null

It specifies the relative tolerance.

Default: 0.0001
abs_tol_time number | null

It specifies the absolute tolerance.

Default: 0.0001
norm_type string | null

It specifies the type of norm to be calculated for convergence assessment.

Default: "LinfNorm"
T_sim number | null

It specifies the temperature used to calculate the resistivity of the superconductor during the transient sim.

Default: 1.9
MultipoleSolveTransientThermal object

Level 4: Class for FiQuS Multipole

initial_time number | null

It specifies the initial time of the simulation.

Default: 0.0
final_time number | null

It specifies the final time of the simulation.

Default: 0.0
initial_time_step number | null

It specifies the initial time step used at the beginning of the transient simulation.

Default: 1e-10
min_time_step number | null

It specifies the minimum possible value of the time step.

Default: 1e-12
max_time_step number | null

It specifies the maximum possible value of the time step.

Default: 10
breakpoints number[] | null

It forces the transient simulation to hit the time instants contained in this list.

Default:
[]
integration_method string | null

It specifies the type of integration method to be used.

Default: "Euler"
rel_tol_time number | null

It specifies the relative tolerance.

Default: 0.0001
abs_tol_time number | null

It specifies the absolute tolerance.

Default: 0.0001
norm_type string | null

It specifies the type of norm to be calculated for convergence assessment.

Default: "LinfNorm"
stop_temperature number | null

If one half turn reaches this temperature, the simulation is stopped.

Default: 300
MultipoleThermalInsulationMesh object

Level 3: Class for FiQuS Multipole

global_size number

It specifies the global size of the mesh for the insulation regions. It is enforced as a constant mesh field for surface insulation and by fixing the number of TSA layers for thin-shell approximation.

Default: 0.0001
TSA MultipoleMeshThinShellApproximationParameters | null

This dictionary contains the mesh information for thin-shells.

Default:
{
  "minimum_discretizations": 1,
  "global_size_QH": 0.0001,
  "minimum_discretizations_QH": 1,
  "global_size_COL": 0.0001,
  "minimum_discretizations_COL": 1,
  "scale_factor_radial": -1.0,
  "scale_factor_azimuthal": -1.0
}
Nb3Sn_HFM object

Level 3: Class for cable HFM Nb3Sn fit

type string required
Constant: "Nb3Sn_HFM"
Tc0_Nb3Sn_HFM number | null
Default: null
Bc20_Nb3Sn_HFM number | null
Default: null
C0_Nb3Sn_HFM number | null
Default: null
alpha_Nb3Sn_HFM number | null
Default: null
nu_Nb3Sn_HFM number | null
Default: null
p_Nb3Sn_HFM number | null
Default: null
q_Nb3Sn_HFM number | null
Default: null
Pancake3D object

Level 1: Class for FiQuS Pancake3D

type string required
Constant: "Pancake3D"
geometry object
10 nested properties
numberOfPancakes integer required

Number of pancake coils stacked on top of each other.

min=1exclusiveMin=0
gapBetweenPancakes number required

Gap distance between the pancake coils.

exclusiveMin=0
winding object required
6 nested properties
innerRadius number required

Inner radius of the winding.

exclusiveMin=0
thickness number required

Thickness of the winding.

exclusiveMin=0
numberOfTurns number required

Number of turns of the winding.

min=3
height number required

Height/width of the winding.

exclusiveMin=0
name string

The The name to be used in the mesh..

Default: "winding"
Examples: "winding", "myWinding"
numberOfVolumesPerTurn integer

The number of volumes per turn (CAD related, not physical).

Default: 2
min=2
contactLayer object required
3 nested properties
thinShellApproximation boolean required

If True, the contact layer will be modeled with 2D shell elements (thin shell approximation), and if False, the contact layer will be modeled with 3D elements.

thickness number required

Thickness of the contact layer.It is the total thickness of the contact or insulation layer.In particular, for perfect insulation this would be the sum of the insulation layer of the two adjacent CC with an insulation layer of thickness t/2 on each side.

exclusiveMin=0
name string

The name to be used in the mesh.

Default: "contactLayer"
Examples: "myContactLayer"
terminals object required
4 nested properties
inner object required
outer object required
firstName string

name of the first terminal

Default: "firstTerminal"
lastName string

name of the last terminal

Default: "lastTerminal"
air Pancake3DGeometryAirCylinder | Pancake3DGeometryAirCuboid required

This dictionary contains the air geometry information.

conductorWrite boolean

To Write the Conductor File

Default: false
dimensionTolerance number

dimension tolerance (CAD related, not physical)

Default: 1e-8
exclusiveMin=0
pancakeBoundaryName string

name of the pancake's curves that touches the air to be used in the mesh

Default: "PancakeBoundary"
contactLayerBoundaryName string

name of the contact layers's curves that touches the air to be used in the mesh (only for TSA)

Default: "contactLayerBoundary"
mesh object
7 nested properties
winding object required
5 nested properties
axialNumberOfElements integer[] | integer required

The number of axial elements for the whole height of the coil. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil.

azimuthalNumberOfElementsPerTurn integer[] | integer required

The number of azimuthal elements per turn of the coil. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil.

radialNumberOfElementsPerTurn integer[] | integer required

The number of radial elements per tape of the winding. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil.

axialDistributionCoefficient number[] | number

If 1, it won't affect anything. If smaller than 1, elements will get finer in the axial direction at the ends of the coil. If greater than 1, elements will get coarser in the axial direction at the ends of the coil. It can be either a list of floats to specify the value for each pancake coil separately or a float to use the same setting for each pancake coil.

Default:
[
  1
]
elementType string[] | string

The element type of windings and contact layers. It can be either a tetrahedron, hexahedron, or a prism. It can be either a list of strings to specify the value for each pancake coil separately or a string to use the same setting for each pancake coil.

Default:
[
  "tetrahedron"
]
contactLayer object required
1 nested properties
radialNumberOfElementsPerTurn integer[] required

The number of radial elements per tape of the contact layer. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil.

minimumElementSize number required

The minimum mesh element size in terms of the largest mesh size in the winding. This mesh size will be used in the regions close the the winding, and then the mesh size will increate to maximum mesh element size as it gets away from the winding.

exclusiveMin=0
maximumElementSize number required

The maximum mesh element size in terms of the largest mesh size in the winding. This mesh size will be used in the regions close the the winding, and then the mesh size will increate to maximum mesh element size as it gets away from the winding.

exclusiveMin=0
terminals object
2 nested properties
structured boolean

If True, the mesh will be structured. If False, the mesh will be unstructured.

Default: false
radialElementSize number

If structured mesh is used, the radial element size can be set. It is the radial element size in terms of the winding's radial element size.

Default: 1
exclusiveMin=0
air object
2 nested properties
structured boolean

If True, the mesh will be structured. If False, the mesh will be unstructured.

Default: false
radialElementSize number

If structured mesh is used, the radial element size can be set. It is the radial element size in terms of the winding's radial element size.

Default: 1
exclusiveMin=0
computeCohomologyForInsulating boolean

Expert option only. If False, the cohomology regions needed for simulating an insulating coilwill not be computed. This will reduce the time spent for the meshing or more accurately the cohomology computing phase. BEWARE: The simulation will fail if set to False and a perfectlyInsulating coil is simulated.

Default: true
solve object
24 nested properties
time Pancake3DSolveTimeAdaptive | Pancake3DSolveTimeFixed required

All the time related settings for transient analysis.

nonlinearSolver Pancake3DSolveNonlinearSolverSettings | null required

All the nonlinear solver related settings.

winding object required
8 nested properties
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveHTSNormalMaterial | Pancake3DSolveHTSSuperconductingMaterial[] | null

List of materials of HTS CC.

Default: null
shuntLayer object
isotropic boolean | null

If True, resistivity and thermal conductivity are isotropic. If False, they are anisotropic. The default is anisotropic material.

Default: false
minimumPossibleResistivity number

The resistivity of the winding won't be lower than this value, no matter what.

Default: 1e-20
min=0
maximumPossibleResistivity number

The resistivity of the winding won't be higher than this value, no matter what.

Default: 0.01
exclusiveMin=0
contactLayer object required
5 nested properties
resistivity number | string

A scalar value or "perfectlyInsulating". If "perfectlyInsulating" is given, the contact layer will be perfectly insulating. If this value is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveNormalMaterial | null

Material from STEAM material library.

Default: null
numberOfThinShellElements integer

Number of thin shell elements in the FE formulation (GetDP related, not physical and only used when TSA is set to True)

Default: 1
exclusiveMin=0
terminals object required
8 nested properties
transitionNotch object required
terminalContactLayer object required
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveNormalMaterial | null

Material from STEAM material library.

Default: null
cooling string

Cooling condition of the terminal. It can be either adiabatic, fixed temperature, or cryocooler.

Default: "fixedTemperature"
Values: "adiabatic" "fixedTemperature" "cryocooler"
cryocoolerOptions Pancake3DTerminalCryocoolerBoundaryCondition | null

Additional inputs for the cryocooler boundary condition.

Default:
{
  "coolingPowerMultiplier": 1.0,
  "staticHeatLoadPower": 0.0,
  "lumpedMass": {
    "material": {
      "RRR": 295.0,
      "RRRRefTemp": 295.0,
      "getdpNormalMaterialGetDPName": "Copper",
      "getdpTSAMassHeatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_TSAMass_T",
      "getdpTSAMassResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAMass_T",
      "getdpTSAMassThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAMass_T",
      "getdpTSAOnlyResistivityFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
      "getdpTSARHSFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
      "getdpTSAStiffnessResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAStiffness_T",
      "getdpTSAStiffnessThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAStiffness_T",
      "getdpTSATripleFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
      "heatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_T",
      "name": "Copper",
      "resistivityMacroName": "MATERIAL_Resistivity_Copper_T_B",
      "thermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_T_B"
    },
    "numberOfThinShellElements": 1,
    "resistivity": null,
    "specificHeatCapacity": null,
    "thermalConductivity": null,
    "volume": 0.0
  }
}
air object required
1 nested properties
permeability number required

Permeability of air.

exclusiveMin=0
initialConditions object required
1 nested properties
temperature number required

Initial temperature of the pancake coils.

exclusiveMin=0
type string required

FiQuS/Pancake3D can solve only electromagnetic and thermal or electromagnetic and thermal coupled. In the weaklyCoupled setting, thermal and electromagnetics systems will be put into different matrices, whereas in the stronglyCoupled setting, they all will be combined into the same matrix. The solution should remain the same.

Values: "electromagnetic" "thermal" "weaklyCoupled" "stronglyCoupled"
boundaryConditions string | Pancake3DSolveImposedField

Boundary conditions of the problem.

Default: "vanishingTangentialElectricField"
quantitiesToBeSaved Pancake3DSolveSaveQuantity[]

List of quantities to be saved.

Default: null
proTemplate string

file name of the .pro template file

Default: "Pancake3D_template.pro"
localDefects object
1 nested properties
criticalCurrentDensity Pancake3DSolveLocalDefect | null

Set critical current density locally.

Default: null
initFromPrevious string

The simulation is continued from an existing .res file. The .res file is from a previous computation on the same geometry and mesh. The .res file is taken from the folder Solution_<>. IMPORTANT: When the option is used, the start time should be identical to the last time value for the <> simulation.

Default: ""
isothermalInAxialDirection boolean

If True, the DoF along the axial direction will be equated. This means that the temperature will be the same along the axial direction reducing the number of DoF. This is only valid for the thermal analysis.

Default: false
voltageTapPositions Pancake3DPositionInCoordinates | Pancake3DPositionInTurnNumbers[] | null

List of voltage tap positions. The position can be given in the form of a list of [x, y, z] coordinates or as turnNumber and number of pancake coil.

Default:
[]
EECircuit Pancake3DSolveEECircuit | null

This dictionary contains the detection circuit settings.

Default:
{
  "inductanceInSeriesWithPancakeCoil": 0.0,
  "enable": false,
  "ResistanceEnergyExtractionOpenSwitch": 1000000.0,
  "ResistanceEnergyExtractionClosedSwitch": 1e-6,
  "ResistanceCrowbarOpenSwitch": 1000000.0,
  "ResistanceCrowbarClosedSwitch": 1e-6,
  "stopSimulationAtCurrent": 0.0,
  "stopSimulationWaitingTime": 0.0,
  "TurnOffDeltaTimePowerSupply": 0.0
}
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
resistiveHeatingTerminals boolean

If True, terminals are subject to Joule heating. If False, terminal regions are not subject to Joule heating. In both cases, heat conduction through the terminal is considered.

Default: true
solveHeatEquationTerminalsTransitionNotch boolean

If True, the heat equation is solved in the terminals and transition notch.If False, the heat equation is not solved in the terminals and transition notches.In the latter case, neither heat conduction nor generation are considered.In other words, the temperature is not an unknown of the problem in the terminals.

Default: true
heatFlowBetweenTurns boolean

If True, heat flow between turns is considered. If False, it is not considered. In the latter case, heat conduction is only considered to the middle of the winding in the thin shell approximation in order to keep the thermal mass of the insulation included. In the middle between the turns, an adiabatic condition is applied. Between the turns refers to the region between the winding turns, NOT to the region between terminals and the first and last turn. This feature is only implemented for the thin shell approximation.

Default: true
convectiveCooling Pancake3DSolveConvectiveCooling | null

This dictionary contains the convective cooling settings.

Default:
{
  "heatTransferCoefficient": 0,
  "exteriorBathTemperature": 4.2
}
imposedPowerDensity Pancake3DSolvePowerDensity | null

The power density for an imposed power density in the winding.

Default: null
materialParametersUseCoilField boolean

If True, the total field (i.e., coil field plus potentially imposed field)will be used for the material (default).If False, only the imposed field (can be zero) will be used.

Default: true
stopWhenTemperatureReaches number | null

If the maximum temperature reaches this value, the simulation will be stopped.

Default: 0
postproc object

TO BE UPDATED

2 nested properties
timeSeriesPlots Pancake3DPostprocessTimeSeriesPlotPositionRequired | Pancake3DPostprocessTimeSeriesPlotPositionNotRequired | null[] | null

Values can be plotted with respect to time.

Default: null
magneticFieldOnCutPlane Pancake3DPostprocessMagneticFieldOnPlane | null

Color map of the magnetic field on the YZ plane can be plotted with streamlines.

Default: null
input_file_path string

path of the input file (calculated by FiQuS)

Default: null
Pancake3DGeometry object
numberOfPancakes integer required

Number of pancake coils stacked on top of each other.

min=1exclusiveMin=0
gapBetweenPancakes number required

Gap distance between the pancake coils.

exclusiveMin=0
winding object required
6 nested properties
innerRadius number required

Inner radius of the winding.

exclusiveMin=0
thickness number required

Thickness of the winding.

exclusiveMin=0
numberOfTurns number required

Number of turns of the winding.

min=3
height number required

Height/width of the winding.

exclusiveMin=0
name string

The The name to be used in the mesh..

Default: "winding"
Examples: "winding", "myWinding"
numberOfVolumesPerTurn integer

The number of volumes per turn (CAD related, not physical).

Default: 2
min=2
contactLayer object required
3 nested properties
thinShellApproximation boolean required

If True, the contact layer will be modeled with 2D shell elements (thin shell approximation), and if False, the contact layer will be modeled with 3D elements.

thickness number required

Thickness of the contact layer.It is the total thickness of the contact or insulation layer.In particular, for perfect insulation this would be the sum of the insulation layer of the two adjacent CC with an insulation layer of thickness t/2 on each side.

exclusiveMin=0
name string

The name to be used in the mesh.

Default: "contactLayer"
Examples: "myContactLayer"
terminals object required
4 nested properties
inner object required
2 nested properties
thickness number required

Thickness of the terminal's tube.

exclusiveMin=0
name string

The name to be used in the mesh.

Default: "innerTerminal"
Examples: "innerTerminal", "outerTeminal"
outer object required
2 nested properties
thickness number required

Thickness of the terminal's tube.

exclusiveMin=0
name string

The name to be used in the mesh.

Default: "outerTerminal"
Examples: "innerTerminal", "outerTeminal"
firstName string

name of the first terminal

Default: "firstTerminal"
lastName string

name of the last terminal

Default: "lastTerminal"
air Pancake3DGeometryAirCylinder | Pancake3DGeometryAirCuboid required

This dictionary contains the air geometry information.

conductorWrite boolean

To Write the Conductor File

Default: false
dimensionTolerance number

dimension tolerance (CAD related, not physical)

Default: 1e-8
exclusiveMin=0
pancakeBoundaryName string

name of the pancake's curves that touches the air to be used in the mesh

Default: "PancakeBoundary"
contactLayerBoundaryName string

name of the contact layers's curves that touches the air to be used in the mesh (only for TSA)

Default: "contactLayerBoundary"
Pancake3DGeometryAirCuboid object
axialMargin number required

Axial margin between the ends of the air and first/last pancake coils.

exclusiveMin=0
name string

The name to be used in the mesh.

Default: "air"
Examples: "air", "myAir"
shellTransformation boolean

Generate outer shell air to apply shell transformation if True (GetDP related, not physical)

Default: false
shellTransformationMultiplier number

multiply the air's outer dimension by this value to get the shell's outer dimension

Default: 1.2
exclusiveMin=1.1
cutName string

name of the cut (cochain) to be used in the mesh

Default: "Air-Cut"
Examples: "Air-Cut", "myAirCut"
shellVolumeName string

name of the shell volume to be used in the mesh

Default: "air-Shell"
Examples: "air-Shell", "myAirShell"
generateGapAirWithFragment boolean

generate the gap air with gmsh/model/occ/fragment if true (CAD related, not physical)

Default: false
type string
Default: "cuboid"
Constant: "cuboid"
sideLength number

Side length of the air (for cuboid type air).

Default: null
exclusiveMin=0
Pancake3DGeometryAirCylinder object
axialMargin number required

Axial margin between the ends of the air and first/last pancake coils.

exclusiveMin=0
name string

The name to be used in the mesh.

Default: "air"
Examples: "air", "myAir"
shellTransformation boolean

Generate outer shell air to apply shell transformation if True (GetDP related, not physical)

Default: false
shellTransformationMultiplier number

multiply the air's outer dimension by this value to get the shell's outer dimension

Default: 1.2
exclusiveMin=1.1
cutName string

name of the cut (cochain) to be used in the mesh

Default: "Air-Cut"
Examples: "Air-Cut", "myAirCut"
shellVolumeName string

name of the shell volume to be used in the mesh

Default: "air-Shell"
Examples: "air-Shell", "myAirShell"
generateGapAirWithFragment boolean

generate the gap air with gmsh/model/occ/fragment if true (CAD related, not physical)

Default: false
type string
Default: "cylinder"
Constant: "cylinder"
radius number

Radius of the air (for cylinder type air).

Default: null
exclusiveMin=0
Pancake3DGeometryContactLayer object
thinShellApproximation boolean required

If True, the contact layer will be modeled with 2D shell elements (thin shell approximation), and if False, the contact layer will be modeled with 3D elements.

thickness number required

Thickness of the contact layer.It is the total thickness of the contact or insulation layer.In particular, for perfect insulation this would be the sum of the insulation layer of the two adjacent CC with an insulation layer of thickness t/2 on each side.

exclusiveMin=0
name string

The name to be used in the mesh.

Default: "contactLayer"
Examples: "myContactLayer"
Pancake3DGeometryInnerTerminal object
thickness number required

Thickness of the terminal's tube.

exclusiveMin=0
name string

The name to be used in the mesh.

Default: "innerTerminal"
Examples: "innerTerminal", "outerTeminal"
Pancake3DGeometryOuterTerminal object
thickness number required

Thickness of the terminal's tube.

exclusiveMin=0
name string

The name to be used in the mesh.

Default: "outerTerminal"
Examples: "innerTerminal", "outerTeminal"
Pancake3DGeometryTerminals object
inner object required
2 nested properties
thickness number required

Thickness of the terminal's tube.

exclusiveMin=0
name string

The name to be used in the mesh.

Default: "innerTerminal"
Examples: "innerTerminal", "outerTeminal"
outer object required
2 nested properties
thickness number required

Thickness of the terminal's tube.

exclusiveMin=0
name string

The name to be used in the mesh.

Default: "outerTerminal"
Examples: "innerTerminal", "outerTeminal"
firstName string

name of the first terminal

Default: "firstTerminal"
lastName string

name of the last terminal

Default: "lastTerminal"
Pancake3DGeometryWinding object
innerRadius number required

Inner radius of the winding.

exclusiveMin=0
thickness number required

Thickness of the winding.

exclusiveMin=0
numberOfTurns number required

Number of turns of the winding.

min=3
height number required

Height/width of the winding.

exclusiveMin=0
name string

The The name to be used in the mesh..

Default: "winding"
Examples: "winding", "myWinding"
numberOfVolumesPerTurn integer

The number of volumes per turn (CAD related, not physical).

Default: 2
min=2
Pancake3DMesh object
winding object required
5 nested properties
axialNumberOfElements integer[] | integer required

The number of axial elements for the whole height of the coil. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil.

azimuthalNumberOfElementsPerTurn integer[] | integer required

The number of azimuthal elements per turn of the coil. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil.

radialNumberOfElementsPerTurn integer[] | integer required

The number of radial elements per tape of the winding. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil.

axialDistributionCoefficient number[] | number

If 1, it won't affect anything. If smaller than 1, elements will get finer in the axial direction at the ends of the coil. If greater than 1, elements will get coarser in the axial direction at the ends of the coil. It can be either a list of floats to specify the value for each pancake coil separately or a float to use the same setting for each pancake coil.

Default:
[
  1
]
elementType string[] | string

The element type of windings and contact layers. It can be either a tetrahedron, hexahedron, or a prism. It can be either a list of strings to specify the value for each pancake coil separately or a string to use the same setting for each pancake coil.

Default:
[
  "tetrahedron"
]
contactLayer object required
1 nested properties
radialNumberOfElementsPerTurn integer[] required

The number of radial elements per tape of the contact layer. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil.

minimumElementSize number required

The minimum mesh element size in terms of the largest mesh size in the winding. This mesh size will be used in the regions close the the winding, and then the mesh size will increate to maximum mesh element size as it gets away from the winding.

exclusiveMin=0
maximumElementSize number required

The maximum mesh element size in terms of the largest mesh size in the winding. This mesh size will be used in the regions close the the winding, and then the mesh size will increate to maximum mesh element size as it gets away from the winding.

exclusiveMin=0
terminals object
2 nested properties
structured boolean

If True, the mesh will be structured. If False, the mesh will be unstructured.

Default: false
radialElementSize number

If structured mesh is used, the radial element size can be set. It is the radial element size in terms of the winding's radial element size.

Default: 1
exclusiveMin=0
air object
2 nested properties
structured boolean

If True, the mesh will be structured. If False, the mesh will be unstructured.

Default: false
radialElementSize number

If structured mesh is used, the radial element size can be set. It is the radial element size in terms of the winding's radial element size.

Default: 1
exclusiveMin=0
computeCohomologyForInsulating boolean

Expert option only. If False, the cohomology regions needed for simulating an insulating coilwill not be computed. This will reduce the time spent for the meshing or more accurately the cohomology computing phase. BEWARE: The simulation will fail if set to False and a perfectlyInsulating coil is simulated.

Default: true
Pancake3DMeshAirAndTerminals object
structured boolean

If True, the mesh will be structured. If False, the mesh will be unstructured.

Default: false
radialElementSize number

If structured mesh is used, the radial element size can be set. It is the radial element size in terms of the winding's radial element size.

Default: 1
exclusiveMin=0
Pancake3DMeshContactLayer object
radialNumberOfElementsPerTurn integer[] required

The number of radial elements per tape of the contact layer. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil.

Pancake3DMeshWinding object
axialNumberOfElements integer[] | integer required

The number of axial elements for the whole height of the coil. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil.

azimuthalNumberOfElementsPerTurn integer[] | integer required

The number of azimuthal elements per turn of the coil. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil.

radialNumberOfElementsPerTurn integer[] | integer required

The number of radial elements per tape of the winding. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil.

axialDistributionCoefficient number[] | number

If 1, it won't affect anything. If smaller than 1, elements will get finer in the axial direction at the ends of the coil. If greater than 1, elements will get coarser in the axial direction at the ends of the coil. It can be either a list of floats to specify the value for each pancake coil separately or a float to use the same setting for each pancake coil.

Default:
[
  1
]
elementType string[] | string

The element type of windings and contact layers. It can be either a tetrahedron, hexahedron, or a prism. It can be either a list of strings to specify the value for each pancake coil separately or a string to use the same setting for each pancake coil.

Default:
[
  "tetrahedron"
]
Pancake3DPositionInCoordinates object
x number required

x coordinate of the position.

y number required

y coordinate of the position.

z number required

z coordinate of the position.

Pancake3DPositionInTurnNumbers object
turnNumber number required

Winding turn number as a position input. It starts from 0 and it can be a float.

whichPancakeCoil integer | null

The first pancake coil is 1, the second is 2, etc.

Default: null
Pancake3DPostprocess object

TO BE UPDATED

timeSeriesPlots Pancake3DPostprocessTimeSeriesPlotPositionRequired | Pancake3DPostprocessTimeSeriesPlotPositionNotRequired | null[] | null

Values can be plotted with respect to time.

Default: null
magneticFieldOnCutPlane Pancake3DPostprocessMagneticFieldOnPlane | null

Color map of the magnetic field on the YZ plane can be plotted with streamlines.

Default: null
Pancake3DPostprocessMagneticFieldOnPlane object
colormap string

Colormap for the plot.

Default: "viridis"
streamLines boolean

If True, streamlines will be plotted. Note that magnetic field vectors may have components perpendicular to the plane, and streamlines will be drawn depending on the vectors' projection onto the plane.

Default: true
interpolationMethod string

Interpolation type for the plot.Because of the FEM basis function selections of FiQuS, each mesh element has a constant magnetic field vector. Therefore, for smooth 2D plots, interpolation can be used.Types:nearest: it will plot the nearest magnetic field value to the plotting point.linear: it will do linear interpolation to the magnetic field values.cubic: it will do cubic interpolation to the magnetic field values.

Default: "linear"
Values: "nearest" "linear" "cubic"
timesToBePlotted number[] | null

List of times that wanted to be plotted. If not given, all the time steps will be plotted.

Default: null
planeNormal number[]

Normal vector of the plane. The default is YZ-plane (1, 0, 0).

Default:
[
  1,
  0,
  0
]
minItems=3maxItems=3
planeXAxisUnitVector number[]

If an arbitrary plane is wanted to be plotted, the arbitrary plane's X axis unit vector must be specified. The dot product of the plane's X axis and the plane's normal vector must be zero.

Default:
[
  0,
  1,
  0
]
minItems=3maxItems=3
Pancake3DPostprocessTimeSeriesPlotPositionNotRequired object
quantity string required

Name of the quantity to be plotted.

Values: "currentThroughCoil" "voltageBetweenTerminals" "inductance" "timeConstant" "totalResistiveHeating" "magneticEnergy" "maximumTemperature" "cryocoolerAveragePower" "cryocoolerAverageTemperature"
Pancake3DPostprocessTimeSeriesPlotPositionRequired object
quantity string required

Name of the quantity to be plotted.

Values: "magneticField" "magnitudeOfMagneticField" "currentDensity" "magnitudeOfCurrentDensity" "resistiveHeating" "temperature" "criticalCurrentDensity" "heatFlux" "resistivity" "thermalConductivity" "specificHeatCapacity" "jHTSOverjCritical" "criticalCurrent" "axialComponentOfTheMagneticField" "debug" "jHTS" "currentSharingIndex" "arcLength" "turnNumber"
position Pancake3DPositionInCoordinates | Pancake3DPositionInTurnNumbers required

Probing position of the quantity for time series plot.

Pancake3DSolve object
time Pancake3DSolveTimeAdaptive | Pancake3DSolveTimeFixed required

All the time related settings for transient analysis.

nonlinearSolver Pancake3DSolveNonlinearSolverSettings | null required

All the nonlinear solver related settings.

winding object required
8 nested properties
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveHTSNormalMaterial | Pancake3DSolveHTSSuperconductingMaterial[] | null

List of materials of HTS CC.

Default: null
shuntLayer object
4 nested properties
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveHTSShuntLayerMaterial | null

Material from STEAM material library.

Default:
{
  "name": "Copper",
  "RRR": 100.0,
  "RRRRefTemp": 295.0,
  "relativeHeight": 0.0,
  "resistivityMacroName": "MATERIAL_Resistivity_Copper_T_B",
  "thermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_T_B",
  "heatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_T",
  "getdpTSAOnlyResistivityFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpTSAMassResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAMass_T",
  "getdpTSAStiffnessResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAStiffness_T",
  "getdpTSAMassThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAMass_T",
  "getdpTSAStiffnessThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAStiffness_T",
  "getdpTSAMassHeatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_TSAMass_T",
  "getdpTSARHSFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpTSATripleFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpNormalMaterialGetDPName": "Copper"
}
isotropic boolean | null

If True, resistivity and thermal conductivity are isotropic. If False, they are anisotropic. The default is anisotropic material.

Default: false
minimumPossibleResistivity number

The resistivity of the winding won't be lower than this value, no matter what.

Default: 1e-20
min=0
maximumPossibleResistivity number

The resistivity of the winding won't be higher than this value, no matter what.

Default: 0.01
exclusiveMin=0
contactLayer object required
5 nested properties
resistivity number | string

A scalar value or "perfectlyInsulating". If "perfectlyInsulating" is given, the contact layer will be perfectly insulating. If this value is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveNormalMaterial | null

Material from STEAM material library.

Default: null
numberOfThinShellElements integer

Number of thin shell elements in the FE formulation (GetDP related, not physical and only used when TSA is set to True)

Default: 1
exclusiveMin=0
terminals object required
8 nested properties
transitionNotch object required
4 nested properties
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveNormalMaterial | null

Material from STEAM material library.

Default: null
terminalContactLayer object required
4 nested properties
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveNormalMaterial | null

Material from STEAM material library.

Default: null
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveNormalMaterial | null

Material from STEAM material library.

Default: null
cooling string

Cooling condition of the terminal. It can be either adiabatic, fixed temperature, or cryocooler.

Default: "fixedTemperature"
Values: "adiabatic" "fixedTemperature" "cryocooler"
cryocoolerOptions Pancake3DTerminalCryocoolerBoundaryCondition | null

Additional inputs for the cryocooler boundary condition.

Default:
{
  "coolingPowerMultiplier": 1.0,
  "staticHeatLoadPower": 0.0,
  "lumpedMass": {
    "material": {
      "RRR": 295.0,
      "RRRRefTemp": 295.0,
      "getdpNormalMaterialGetDPName": "Copper",
      "getdpTSAMassHeatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_TSAMass_T",
      "getdpTSAMassResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAMass_T",
      "getdpTSAMassThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAMass_T",
      "getdpTSAOnlyResistivityFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
      "getdpTSARHSFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
      "getdpTSAStiffnessResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAStiffness_T",
      "getdpTSAStiffnessThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAStiffness_T",
      "getdpTSATripleFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
      "heatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_T",
      "name": "Copper",
      "resistivityMacroName": "MATERIAL_Resistivity_Copper_T_B",
      "thermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_T_B"
    },
    "numberOfThinShellElements": 1,
    "resistivity": null,
    "specificHeatCapacity": null,
    "thermalConductivity": null,
    "volume": 0.0
  }
}
air object required
1 nested properties
permeability number required

Permeability of air.

exclusiveMin=0
initialConditions object required
1 nested properties
temperature number required

Initial temperature of the pancake coils.

exclusiveMin=0
type string required

FiQuS/Pancake3D can solve only electromagnetic and thermal or electromagnetic and thermal coupled. In the weaklyCoupled setting, thermal and electromagnetics systems will be put into different matrices, whereas in the stronglyCoupled setting, they all will be combined into the same matrix. The solution should remain the same.

Values: "electromagnetic" "thermal" "weaklyCoupled" "stronglyCoupled"
boundaryConditions string | Pancake3DSolveImposedField

Boundary conditions of the problem.

Default: "vanishingTangentialElectricField"
quantitiesToBeSaved Pancake3DSolveSaveQuantity[]

List of quantities to be saved.

Default: null
proTemplate string

file name of the .pro template file

Default: "Pancake3D_template.pro"
localDefects object
1 nested properties
criticalCurrentDensity Pancake3DSolveLocalDefect | null

Set critical current density locally.

Default: null
initFromPrevious string

The simulation is continued from an existing .res file. The .res file is from a previous computation on the same geometry and mesh. The .res file is taken from the folder Solution_<>. IMPORTANT: When the option is used, the start time should be identical to the last time value for the <> simulation.

Default: ""
isothermalInAxialDirection boolean

If True, the DoF along the axial direction will be equated. This means that the temperature will be the same along the axial direction reducing the number of DoF. This is only valid for the thermal analysis.

Default: false
voltageTapPositions Pancake3DPositionInCoordinates | Pancake3DPositionInTurnNumbers[] | null

List of voltage tap positions. The position can be given in the form of a list of [x, y, z] coordinates or as turnNumber and number of pancake coil.

Default:
[]
EECircuit Pancake3DSolveEECircuit | null

This dictionary contains the detection circuit settings.

Default:
{
  "inductanceInSeriesWithPancakeCoil": 0.0,
  "enable": false,
  "ResistanceEnergyExtractionOpenSwitch": 1000000.0,
  "ResistanceEnergyExtractionClosedSwitch": 1e-6,
  "ResistanceCrowbarOpenSwitch": 1000000.0,
  "ResistanceCrowbarClosedSwitch": 1e-6,
  "stopSimulationAtCurrent": 0.0,
  "stopSimulationWaitingTime": 0.0,
  "TurnOffDeltaTimePowerSupply": 0.0
}
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
resistiveHeatingTerminals boolean

If True, terminals are subject to Joule heating. If False, terminal regions are not subject to Joule heating. In both cases, heat conduction through the terminal is considered.

Default: true
solveHeatEquationTerminalsTransitionNotch boolean

If True, the heat equation is solved in the terminals and transition notch.If False, the heat equation is not solved in the terminals and transition notches.In the latter case, neither heat conduction nor generation are considered.In other words, the temperature is not an unknown of the problem in the terminals.

Default: true
heatFlowBetweenTurns boolean

If True, heat flow between turns is considered. If False, it is not considered. In the latter case, heat conduction is only considered to the middle of the winding in the thin shell approximation in order to keep the thermal mass of the insulation included. In the middle between the turns, an adiabatic condition is applied. Between the turns refers to the region between the winding turns, NOT to the region between terminals and the first and last turn. This feature is only implemented for the thin shell approximation.

Default: true
convectiveCooling Pancake3DSolveConvectiveCooling | null

This dictionary contains the convective cooling settings.

Default:
{
  "heatTransferCoefficient": 0,
  "exteriorBathTemperature": 4.2
}
imposedPowerDensity Pancake3DSolvePowerDensity | null

The power density for an imposed power density in the winding.

Default: null
materialParametersUseCoilField boolean

If True, the total field (i.e., coil field plus potentially imposed field)will be used for the material (default).If False, only the imposed field (can be zero) will be used.

Default: true
stopWhenTemperatureReaches number | null

If the maximum temperature reaches this value, the simulation will be stopped.

Default: 0
Pancake3DSolveAdaptiveTimeLoopSettings object
tolerances Pancake3DSolvePositionRequiredTolerance | Pancake3DSolvePositionNotRequiredTolerance[] required

Time steps or nonlinear iterations will be refined until the tolerances are satisfied.

initialStep number required

Initial step for adaptive time stepping

exclusiveMin=0
minimumStep number required

The simulation will be aborted if a finer time step is required than this minimum step value.

exclusiveMin=0
maximumStep number required

Bigger steps than this won't be allowed

exclusiveMin=0
integrationMethod string

Integration method for transient analysis

Default: "Euler"
Values: "Euler" "Gear_2" "Gear_3" "Gear_4" "Gear_5" "Gear_6"
breakPoints_input number[]

Make sure to solve the system for these times.

Default:
[
  0
]
Pancake3DSolveAir object
permeability number required

Permeability of air.

exclusiveMin=0
Pancake3DSolveContactLayerMaterial object
resistivity number | string

A scalar value or "perfectlyInsulating". If "perfectlyInsulating" is given, the contact layer will be perfectly insulating. If this value is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveNormalMaterial | null

Material from STEAM material library.

Default: null
numberOfThinShellElements integer

Number of thin shell elements in the FE formulation (GetDP related, not physical and only used when TSA is set to True)

Default: 1
exclusiveMin=0
Pancake3DSolveConvectiveCooling object
heatTransferCoefficient number | string | null

The heat transfer coefficient for the heat transfer between the winding and the air. If zero, no heat transfer to the air is considered.This feature is only implemented for the thin shell approximation.At the moment, only constant values are supported.

Default: 0
exteriorBathTemperature number | null

The temperature of the exterior bath for convective cooling boundary condition.

Default: 4.2
Pancake3DSolveEECircuit object
inductanceInSeriesWithPancakeCoil number | null

A lumped inductance in series with the pancake coil to model a bigger coil.

Default: 0
enable boolean

Enable the detection circuit for the pancake coil.

Default: false
ResistanceEnergyExtractionOpenSwitch number | null

The resistance of the energy extraction switch when modeled as open.

Default: 1000000.0
ResistanceEnergyExtractionClosedSwitch number | null

The resistance of the energy extraction switch when modeled as closed.

Default: 1e-6
ResistanceCrowbarOpenSwitch number | null

The resistance of the crowbar switch when modeled as open.

Default: 1000000.0
ResistanceCrowbarClosedSwitch number | null

The resistance of the crowbar switch when modeled as closed.

Default: 1e-6
stopSimulationAtCurrent number | null

If a quench is detected and the current reaches this value, the simulation will be stopped after. stopSimulationWaitingTime seconds.

Default: 0
stopSimulationWaitingTime number | null

The time to wait after a quench is detected and the current reaches stopSimulationAtCurrent before stopping the simulation.

Default: 0
TurnOffDeltaTimePowerSupply number | null

The time it takes for the power supply to be turned off after quench detection. A linear ramp-down is assumed between the time of quench detection and the time of power supply turn off.

Default: 0
Pancake3DSolveFixedLoopInterval object
startTime number required

Start time of the interval.

min=0
endTime number required

End time of the interval.

min=0
step number required

Time step for the interval

exclusiveMin=0
Pancake3DSolveFixedTimeLoopSettings object
step number required

Time step for fixed time stepping.

exclusiveMin=0
Pancake3DSolveHTSNormalMaterial object
name string required
Values: "Copper" "Hastelloy" "Silver" "Indium" "Stainless Steel" "Kapton" "G10"
relativeThickness number required

Winding tapes generally consist of more than one material. Therefore, when materials are given as a list in winding, their relative thickness, (thickness of the material) / (thickness of the bare conductor), should be specified.

max=1
RRR number

Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K.

Default: 100
exclusiveMin=0
RRRRefTemp number

Reference temperature for residual resistance ratio

Default: 295
exclusiveMin=0
Pancake3DSolveHTSShuntLayerMaterial object
name string
Default: "Copper"
Values: "Copper" "Hastelloy" "Silver" "Indium" "Stainless Steel" "Kapton" "G10"
RRR number

Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K.

Default: 100
exclusiveMin=0
RRRRefTemp number

Reference temperature for residual resistance ratio

Default: 295
exclusiveMin=0
relativeHeight number

HTS 2G coated conductor are typically plated, usually using copper. The relative height of the shunt layer is the width of the shunt layer divided by the width of the tape. 0 means no shunt layer.

Default: 0.0
min=0max=1
Pancake3DSolveHTSSuperconductingMaterial object
name string required
Values: "HTSSuperPower" "HTSFujikura" "HTSSucci"
IcAtTAndBref number | Pancake3DSolveIcVsLengthCSV | Pancake3DSolveIcVsLengthList required

Critical current in A at reference temperature and magnetic field.The critical current value will change with temperature depending on the superconductor material.Either 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 current for the entire tape, just use a scalar. To specify critical current with respect to the tape length: a CSV file can be used, or lengthValues and criticalCurrentValues can be given as lists. The data will be linearly interpolated.If a CSV file is to be used, the input should be the name of a CSV file (which is in the same folder as the input file) instead of a scalar. The first column of the CSV file will be the tape length in m, and the second column will be the critical current in A.

Examples: 230, "IcVSlength.csv"
relativeThickness number required

Winding tapes generally consist of more than one material. Therefore, when materials are given as a list in winding, their relative thickness, (thickness of the material) / (thickness of the bare conductor), should be specified.

max=1
RRR number

Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K.

Default: 100
exclusiveMin=0
RRRRefTemp number

Reference temperature for residual resistance ratio

Default: 295
exclusiveMin=0
nValue number

N-value for E-J power law.

Default: 30
exclusiveMin=0
electricFieldCriterion number

The electric field that defines the critical current density, i.e., the electric field at which the current density reaches the critical current density.

Default: 0.0001
exclusiveMin=0
jCriticalScalingNormalToWinding number

Critical current scaling normal to winding, i.e., along the c_axis. We have Jc_cAxis = scalingFactor * Jc_abPlane. A factor of 1 means no scaling such that the HTS layer is isotropic.

Default: 1
exclusiveMin=0
IcReferenceTemperature number

Critical current reference temperature in Kelvin.

Default: 77
exclusiveMin=0
IcReferenceBmagnitude number

Critical current reference magnetic field magnitude in Tesla.

Default: 0.0
min=0
IcReferenceBangle number

Critical current reference magnetic field angle in degrees.0 degrees means the magnetic field is normal to the tape's wide surfaceand 90 degrees means the magnetic field is parallel to the tape's widesurface.

Default: 90.0
min=0
Pancake3DSolveIcVsLengthCSV object
csvFile string required

The path of the CSV file that contains the critical current values.

lengthUnit string required

Unit of the critical current values. It can be either the arc length in meter or the number of turns.

Examples: "meter", "turnNumber"
Pancake3DSolveIcVsLengthList object
lengthValues number[] required

Tape length values that corresponds to criticalCurrentValues.

criticalCurrentValues number[] required

Critical current values that corresponds to lengthValues.

lengthUnit string required

Unit of the critical current values. It can be either the arc length in meter or the number of turns.

Examples: "meter", "turnNumber"
Pancake3DSolveImposedField object
imposedAxialField number required

Imposed axial magnetic field in Tesla. Only constant, purely axial magnetic fields are supported at the moment.

Pancake3DSolveInitialConditions object
temperature number required

Initial temperature of the pancake coils.

exclusiveMin=0
Pancake3DSolveLocalDefect object
value number required

Value of the local defect.

min=0
startTurn number required

Start turn of the local defect.

min=0
endTurn number required

End turn of the local defect.

exclusiveMin=0
startTime number required

Start time of the local defect.

min=0
transitionDuration number

Transition duration of the local defect. If not given, the transition will be instantly.

Default: 0
min=0
whichPancakeCoil integer | null

The first pancake coil is 1, the second is 2, etc.

Default: null
Pancake3DSolveLocalDefects object
criticalCurrentDensity Pancake3DSolveLocalDefect | null

Set critical current density locally.

Default: null
Pancake3DSolveMaterial object
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveNormalMaterial | null

Material from STEAM material library.

Default: null
Pancake3DSolveNonlinearSolverSettings object
tolerances Pancake3DSolvePositionRequiredTolerance | Pancake3DSolvePositionNotRequiredTolerance[] required

Time steps or nonlinear iterations will be refined until the tolerances are satisfied.

maximumNumberOfIterations integer

Maximum number of iterations allowed for the nonlinear solver.

Default: 100
exclusiveMin=0
relaxationFactor number

Calculated step changes of the solution vector will be multiplied with this value for better convergence.

Default: 0.7
exclusiveMin=0
Pancake3DSolveNormalMaterial object
name string required
Values: "Copper" "Hastelloy" "Silver" "Indium" "Stainless Steel" "Kapton" "G10"
RRR number

Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K.

Default: 100
exclusiveMin=0
RRRRefTemp number

Reference temperature for residual resistance ratio

Default: 295
exclusiveMin=0
Pancake3DSolvePositionNotRequiredTolerance object
quantity string | string required

Name of the quantity for tolerance.

relative number required

Relative tolerance for the quantity.

min=0
absolute number required

Absolute tolerance for the quantity

min=0
normType string

Sometimes, tolerances return a vector instead of a scalar (ex, solutionVector). Then, the magnitude of the tolerance should be calculated with a method. Norm type selects this method.

Default: "L2Norm"
Values: "L1Norm" "MeanL1Norm" "L2Norm" "MeanL2Norm" "LinfNorm"
Pancake3DSolvePositionRequiredTolerance object
quantity string required

Name of the quantity for tolerance.

Values: "magneticField" "magnitudeOfMagneticField" "currentDensity" "magnitudeOfCurrentDensity" "resistiveHeating" "temperature" "criticalCurrentDensity" "heatFlux" "resistivity" "thermalConductivity" "specificHeatCapacity" "jHTSOverjCritical" "criticalCurrent" "axialComponentOfTheMagneticField" "debug" "jHTS" "currentSharingIndex" "arcLength" "turnNumber"
relative number required

Relative tolerance for the quantity.

min=0
absolute number required

Absolute tolerance for the quantity

min=0
position Pancake3DPositionInCoordinates | Pancake3DPositionInTurnNumbers required

Probing position of the quantity for tolerance.

normType string

Sometimes, tolerances return a vector instead of a scalar (ex, solutionVector). Then, the magnitude of the tolerance should be calculated with a method. Norm type selects this method.

Default: "L2Norm"
Values: "L1Norm" "MeanL1Norm" "L2Norm" "MeanL2Norm" "LinfNorm"
Pancake3DSolvePowerDensity object
power number | null

The power in W for an imposed power density in the winding. 'startTime', 'endTime', 'startTurn', and 'endTurn' are also required to be set.

Default: 0
startTime number | null

The start time for the imposed power density in the winding. 'power', 'endTime', 'startTurn', and 'endTurn' are also required to be set.

Default: 0
endTime number | null

The end time for the imposed power density in the winding. 'power', 'startTime', 'startTurn', and 'endTurn' are also required to be set.

Default: 0
startArcLength number | null

The start arc length in m for the imposed power density in the winding. 'power', 'startTime', 'endTime', and 'endArcLength' are also required to be set.

Default: 0
endArcLength number | null

The end arc length in m for the imposed power density in the winding. 'power', 'startTime', 'endTime', and 'startArcLength' are also required to be set.

Default: 0
Pancake3DSolveSaveQuantity object
quantity string | string required

Name of the quantity to be saved.

timesToBeSaved number[] | null

List of times that wanted to be saved. If not given, all the time steps will be saved.

Default: null
Pancake3DSolveShuntLayerMaterial object
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveHTSShuntLayerMaterial | null

Material from STEAM material library.

Default:
{
  "name": "Copper",
  "RRR": 100.0,
  "RRRRefTemp": 295.0,
  "relativeHeight": 0.0,
  "resistivityMacroName": "MATERIAL_Resistivity_Copper_T_B",
  "thermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_T_B",
  "heatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_T",
  "getdpTSAOnlyResistivityFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpTSAMassResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAMass_T",
  "getdpTSAStiffnessResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAStiffness_T",
  "getdpTSAMassThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAMass_T",
  "getdpTSAStiffnessThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAStiffness_T",
  "getdpTSAMassHeatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_TSAMass_T",
  "getdpTSARHSFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpTSATripleFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpNormalMaterialGetDPName": "Copper"
}
Pancake3DSolveTerminalMaterialAndBoundaryCondition object
transitionNotch object required
4 nested properties
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveNormalMaterial | null

Material from STEAM material library.

Default: null
terminalContactLayer object required
4 nested properties
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveNormalMaterial | null

Material from STEAM material library.

Default: null
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveNormalMaterial | null

Material from STEAM material library.

Default: null
cooling string

Cooling condition of the terminal. It can be either adiabatic, fixed temperature, or cryocooler.

Default: "fixedTemperature"
Values: "adiabatic" "fixedTemperature" "cryocooler"
cryocoolerOptions Pancake3DTerminalCryocoolerBoundaryCondition | null

Additional inputs for the cryocooler boundary condition.

Default:
{
  "coolingPowerMultiplier": 1.0,
  "staticHeatLoadPower": 0.0,
  "lumpedMass": {
    "material": {
      "RRR": 295.0,
      "RRRRefTemp": 295.0,
      "getdpNormalMaterialGetDPName": "Copper",
      "getdpTSAMassHeatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_TSAMass_T",
      "getdpTSAMassResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAMass_T",
      "getdpTSAMassThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAMass_T",
      "getdpTSAOnlyResistivityFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
      "getdpTSARHSFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
      "getdpTSAStiffnessResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAStiffness_T",
      "getdpTSAStiffnessThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAStiffness_T",
      "getdpTSATripleFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
      "heatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_T",
      "name": "Copper",
      "resistivityMacroName": "MATERIAL_Resistivity_Copper_T_B",
      "thermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_T_B"
    },
    "numberOfThinShellElements": 1,
    "resistivity": null,
    "specificHeatCapacity": null,
    "thermalConductivity": null,
    "volume": 0.0
  }
}
Pancake3DSolveTimeAdaptive object
start number required

Start time of the simulation.

end number required

End time of the simulation.

adaptiveSteppingSettings object required
6 nested properties
tolerances Pancake3DSolvePositionRequiredTolerance | Pancake3DSolvePositionNotRequiredTolerance[] required

Time steps or nonlinear iterations will be refined until the tolerances are satisfied.

initialStep number required

Initial step for adaptive time stepping

exclusiveMin=0
minimumStep number required

The simulation will be aborted if a finer time step is required than this minimum step value.

exclusiveMin=0
maximumStep number required

Bigger steps than this won't be allowed

exclusiveMin=0
integrationMethod string

Integration method for transient analysis

Default: "Euler"
Values: "Euler" "Gear_2" "Gear_3" "Gear_4" "Gear_5" "Gear_6"
breakPoints_input number[]

Make sure to solve the system for these times.

Default:
[
  0
]
extrapolationOrder integer

Before solving for the next time steps, the previous solutions can be extrapolated for better convergence.

Default: 1
Values: 0 1 2 3
timeSteppingType string
Default: "adaptive"
Constant: "adaptive"
Pancake3DSolveTimeFixed object
start number required

Start time of the simulation.

end number required

End time of the simulation.

fixedSteppingSettings Pancake3DSolveFixedLoopInterval[] | Pancake3DSolveFixedTimeLoopSettings required

Fixed time loop settings (only used if stepping type is fixed).

extrapolationOrder integer

Before solving for the next time steps, the previous solutions can be extrapolated for better convergence.

Default: 1
Values: 0 1 2 3
timeSteppingType string
Default: "fixed"
Constant: "fixed"
Pancake3DSolveWindingMaterial object
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveHTSNormalMaterial | Pancake3DSolveHTSSuperconductingMaterial[] | null

List of materials of HTS CC.

Default: null
shuntLayer object
4 nested properties
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveHTSShuntLayerMaterial | null

Material from STEAM material library.

Default:
{
  "name": "Copper",
  "RRR": 100.0,
  "RRRRefTemp": 295.0,
  "relativeHeight": 0.0,
  "resistivityMacroName": "MATERIAL_Resistivity_Copper_T_B",
  "thermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_T_B",
  "heatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_T",
  "getdpTSAOnlyResistivityFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpTSAMassResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAMass_T",
  "getdpTSAStiffnessResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAStiffness_T",
  "getdpTSAMassThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAMass_T",
  "getdpTSAStiffnessThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAStiffness_T",
  "getdpTSAMassHeatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_TSAMass_T",
  "getdpTSARHSFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpTSATripleFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpNormalMaterialGetDPName": "Copper"
}
isotropic boolean | null

If True, resistivity and thermal conductivity are isotropic. If False, they are anisotropic. The default is anisotropic material.

Default: false
minimumPossibleResistivity number

The resistivity of the winding won't be lower than this value, no matter what.

Default: 1e-20
min=0
maximumPossibleResistivity number

The resistivity of the winding won't be higher than this value, no matter what.

Default: 0.01
exclusiveMin=0
Pancake3DTerminalCryocoolerBoundaryCondition object
coolingPowerMultiplier number

Multiplier for the cooling power. It can be used to scale the cooling power given by the coldhead capacity map by a non-negative float factor.

Default: 1
min=0
staticHeatLoadPower number

Static heat load power in W. It can be used to add a static heat load to the cryocooler, i.e., decrease the power available for cooling. The actual cooling power is P(t) = P_cryocooler(T) - P_staticLoad.

Default: 0
min=0
lumpedMass object
6 nested properties
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveNormalMaterial | null

Material from STEAM material library.

Default:
{
  "name": "Copper",
  "RRR": 295.0,
  "RRRRefTemp": 295.0,
  "resistivityMacroName": "MATERIAL_Resistivity_Copper_T_B",
  "thermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_T_B",
  "heatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_T",
  "getdpTSAOnlyResistivityFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpTSAMassResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAMass_T",
  "getdpTSAStiffnessResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAStiffness_T",
  "getdpTSAMassThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAMass_T",
  "getdpTSAStiffnessThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAStiffness_T",
  "getdpTSAMassHeatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_TSAMass_T",
  "getdpTSARHSFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpTSATripleFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpNormalMaterialGetDPName": "Copper"
}
volume number

Volume of the lumped thermal mass between second stage of the cryocooler and pancake coil in m^3. A zero value effectively disables the lumped thermal mass between second stage of the cryocooler and pancake coil.

Default: 0
min=0
numberOfThinShellElements integer

Number of thin shell elements in the FE formulation (GetDP related, not physical and only used when TSA is set to True)

Default: 1
exclusiveMin=0
Pancake3DTerminalCryocoolerLumpedMass object
resistivity number | null

A scalar value. If this is given, material properties won't be used for resistivity.

Default: null
thermalConductivity number | null

A scalar value. If this is given, material properties won't be used for thermal conductivity.

Default: null
specificHeatCapacity number | null

A scalar value. If this is given, material properties won't be used for specific heat capacity.

Default: null
material Pancake3DSolveNormalMaterial | null

Material from STEAM material library.

Default:
{
  "name": "Copper",
  "RRR": 295.0,
  "RRRRefTemp": 295.0,
  "resistivityMacroName": "MATERIAL_Resistivity_Copper_T_B",
  "thermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_T_B",
  "heatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_T",
  "getdpTSAOnlyResistivityFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpTSAMassResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAMass_T",
  "getdpTSAStiffnessResistivityMacroName": "MATERIAL_Resistivity_Copper_TSAStiffness_T",
  "getdpTSAMassThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAMass_T",
  "getdpTSAStiffnessThermalConductivityMacroName": "MATERIAL_ThermalConductivity_Copper_TSAStiffness_T",
  "getdpTSAMassHeatCapacityMacroName": "MATERIAL_SpecificHeatCapacity_Copper_TSAMass_T",
  "getdpTSARHSFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpTSATripleFunction": "NOT_DEFINED_IN_DATA_FIQUS_PANCAKE3D",
  "getdpNormalMaterialGetDPName": "Copper"
}
volume number

Volume of the lumped thermal mass between second stage of the cryocooler and pancake coil in m^3. A zero value effectively disables the lumped thermal mass between second stage of the cryocooler and pancake coil.

Default: 0
min=0
numberOfThinShellElements integer

Number of thin shell elements in the FE formulation (GetDP related, not physical and only used when TSA is set to True)

Default: 1
exclusiveMin=0
PostprocCCTFiQuS object

Class for FiQuS CCT input file

windings_wwns integer[] | null
Default: null
windings_whns integer[] | null
Default: null
additional_outputs string[] | null
Default: null
winding_order integer[] | null
Default: null
fqpl_export_trim_tol number[] | null
Default: null
variables string[] | null
Default: null
volumes string[] | null
Default: null
file_exts string[] | null
Default: null
PowerSupplyClass object

Level 1: Class for the power supply (aka power converter)

I_initial number | null

Initial current in the magnet. Propagated differently in various tools and obsolete # I00 (LEDET), I_0 (SIGMA), I0 (BBQ)

Default: null
t_off number | null

Time of switching off the switch next to current controlled source. t_PC (LEDET)

Default: null
t_control_LUT number[]

List of time values [s] for linear piece wise time function of current controlled source. t_PC_LUT (LEDET)

Default:
[]
I_control_LUT number[]

List of current values [A] for linear piece wise time function of current controlled source. I_PC_LUT (LEDET)

Default:
[]
R_crowbar number | null

Crowbar resistance in forward direction [Ohm]. Rcrow (SIGMA), RCrowbar (ProteCCT)

Default: 0
L_crowbar number | null

Crowbar inductance in forward direction [H].

Default: 0
Ud_crowbar number | null

Crowbar diode voltage in forward direction [V].

Default: 0
R_c_r number | null

Crowbar resistance in reverse direction [Ohm].

Default: 0
L_c_r number | null

Crowbar inductance in reverse direction [H].

Default: 0
Ud_c_r number | null

Crowbar diode voltage in reverse direction [V].

Default: 0
R_1 number | null

Resistance R1 [Ohm].

Default: 0
L_1 number | null

Inductance L1 [H].

Default: 0
R_2 number | null

Resistance R2 [Ohm].

Default: 0
L_2 number | null

Inductance L2 [H].

Default: 0
C number | null

Capacitance C [F].

Default: 0
R_3 number | null

Resistance R3 [Ohm].

Default: 0
L_3 number | null

Inductance L3 [H].

Default: 0
ProDefined object

Level 3: Class for cable Bordini's Nb3Sn fit

type string required
Constant: "ProDefined"
Tc0 number | null
Default: null
Bc20 number | null
Default: null
C0 number | null
Default: null
alpha number | null
Default: null
p number | null
Default: null
q number | null
Default: null
v number | null
Default: null
B0 number | null
Default: null
QuenchDetection object

Level 2: Class for FiQuS

voltage_thresholds number[] | 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.

Default: null
discrimination_times number[] | 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.

Default: null
voltage_tap_pairs integer[][] | null

Voltage tap pairs for quench detection. The voltage difference between these pairs will be used for quench detection.

Default: null
QuenchHeater object

Level 2: Class for the quench heater parameters

N_strips integer | null

Number of quench heater traces (typically 2 traces make one pad)

Default: null
t_trigger number[]

Trigger times list of of quench heaters [s]

Default:
[]
U0 number[]

Initial charging voltages list of capacitor for the trance (not full pad!) [V]

Default:
[]
C number[]

Capacitances list of quench heater power supply for the trance (not full pad!) [H]

Default:
[]
R_warm number[]

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]

Default:
[]
w number[]

Widths list of quench heater trance stainless steel part [m]

Default:
[]
h number[]

Thickness list of quench heater trance stainless steel part [m]

Default:
[]
s_ins number[] | number[][]

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

Default:
[]
type_ins string[] | string[][]

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

Default:
[]
s_ins_He number[] | number[][]

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

Default:
[]
type_ins_He string[] | string[][]

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

Default:
[]
l number[]

Lengths list of quench heaters [m]. Typically equal to magnet length.

Default:
[]
l_copper number[]

Lengths list of copper laminations of quench heaters [m].

Default:
[]
l_stainless_steel number[]

Lengths list of stainless steel only sections of quench heaters [m].

Default:
[]
f_cover number[]

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 [-].

Default:
[]
iQH_toHalfTurn_From integer[]

List of heater numbers (1 based) equal to the length of turns that are covered by (i.e. thermally connected to) quench heaters.

Default:
[]
iQH_toHalfTurn_To integer[]

List of turn numbers (1 based) that are covered by (i.e. thermally connected to) quench heaters.

Default:
[]
turns_sides string[]

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.

Default:
[]
quench_propagation string | null

Enables to have a variable length for the quench heater, different from the full magnet length.

Default: "full"
quench_prop_model string | null

Selects the model used for the material properties of the quench propagation. "Wilson" uses a scaled cv and Ts uses the cv at Ts.

Default: "Ts"
NZPV_multiplier number | null

Factor that multiplies the Normal Zone Propagation Velocity

Default: 1.0
L_QH_offset number[] | null

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).

Default:
[]
QuenchProtection object

Level 2: Class for FiQuS

energy_extraction object

Level 2: Class for the energy extraction parameters

22 nested properties
t_trigger number | null

Trigger time on the positive lead [s]. tEE (LEDET), tSwitchDelay (ProteCCT)

Default: 99999.0
R_EE number | null

Energy extraction resistance on the positive lead [Ohm]. R_EE_triggered (ProteCCT)

Default: 0
power_R_EE number | null

Varistor power component, R(I) = R_EE*abs(I)^power_R_EE on the positive lead [-]. RDumpPower (ProteCCT)

Default: 0.0
L number | null

Inductance in series with resistor on the positive lead [H].

Default: 0
C number | null

Snubber capacitance in parallel to the EE switch on the positive lead [F].

Default: 0
L_c number | null

Inductance in the snubber capacitance branch in parallel to the EE switch on the positive lead [H].

Default: 0
R_c number | null

Resistance in the snubber capacitance branch in parallel to the EE switch on the positive lead [Ohm].

Default: 0
Ud_snubber number | null

Forward voltage of diode in the snubber capacitance branch in parallel to the EE switch on the positive lead [V].

Default: 0
L_s number | null

Inductance in the EE switch branch on the positive lead [H].

Default: 0
R_s number | null

Resistance in the EE switch branch on the positive lead [Ohm].

Default: 0
Ud_switch number | null

Forward voltage of diode in the EE switch branch on the positive lead [V].

Default: 0
t_trigger_n number | null

Trigger time on the negative lead [s]. tEE (LEDET), tSwitchDelay (ProteCCT)

Default: 99999.0
R_EE_n number | null

Energy extraction resistance on the negative lead [Ohm]. R_EE_triggered (ProteCCT)

Default: 0
power_R_EE_n number | null

Varistor power component, R(I) = R_EE*abs(I)^power_R_EE on the negative lead [-]. RDumpPower (ProteCCT)

Default: 0.0
L_n number | null

Inductance in series with resistor on the negative lead [H].

Default: 0
C_n number | null

Snubber capacitance in parallel to the EE switch on the negative lead [F].

Default: 0
L_c_n number | null

Inductance in the snubber capacitance branch in parallel to the EE switch on the negative lead [H].

Default: 0
R_c_n number | null

Resistance in the snubber capacitance branch in parallel to the EE switch on the negative lead [Ohm].

Default: 0
Ud_snubber_n number | null

Forward voltage of diode in the snubber capacitance branch in parallel to the EE switch on the negative lead [V].

Default: 0
L_s_n number | null

Inductance in the EE switch branch on the negative lead [H].

Default: 0
R_s_n number | null

Resistance in the EE switch branch on the negative lead [Ohm].

Default: 0
Ud_switch_n number | null

Forward voltage of diode in the EE switch branch on the negative lead [V].

Default: 0
quench_heaters object

Level 2: Class for the quench heater parameters

22 nested properties
N_strips integer | null

Number of quench heater traces (typically 2 traces make one pad)

Default: null
t_trigger number[]

Trigger times list of of quench heaters [s]

Default:
[]
U0 number[]

Initial charging voltages list of capacitor for the trance (not full pad!) [V]

Default:
[]
C number[]

Capacitances list of quench heater power supply for the trance (not full pad!) [H]

Default:
[]
R_warm number[]

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]

Default:
[]
w number[]

Widths list of quench heater trance stainless steel part [m]

Default:
[]
h number[]

Thickness list of quench heater trance stainless steel part [m]

Default:
[]
s_ins number[] | number[][]

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

Default:
[]
type_ins string[] | string[][]

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

Default:
[]
s_ins_He number[] | number[][]

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

Default:
[]
type_ins_He string[] | string[][]

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

Default:
[]
l number[]

Lengths list of quench heaters [m]. Typically equal to magnet length.

Default:
[]
l_copper number[]

Lengths list of copper laminations of quench heaters [m].

Default:
[]
l_stainless_steel number[]

Lengths list of stainless steel only sections of quench heaters [m].

Default:
[]
f_cover number[]

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 [-].

Default:
[]
iQH_toHalfTurn_From integer[]

List of heater numbers (1 based) equal to the length of turns that are covered by (i.e. thermally connected to) quench heaters.

Default:
[]
iQH_toHalfTurn_To integer[]

List of turn numbers (1 based) that are covered by (i.e. thermally connected to) quench heaters.

Default:
[]
turns_sides string[]

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.

Default:
[]
quench_propagation string | null

Enables to have a variable length for the quench heater, different from the full magnet length.

Default: "full"
quench_prop_model string | null

Selects the model used for the material properties of the quench propagation. "Wilson" uses a scaled cv and Ts uses the cv at Ts.

Default: "Ts"
NZPV_multiplier number | null

Factor that multiplies the Normal Zone Propagation Velocity

Default: 1.0
L_QH_offset number[] | null

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).

Default:
[]
cliq object

Level 2: Class for the CLIQ parameters

9 nested properties
t_trigger number | null

Trigger time of CLIQ unit [s].

Default: 99999.0
current_direction integer[]

Polarity of current in groups specified as a list with length equal to the number of groups [-].

Default:
[]
sym_factor number | null

Obsolete.

Default: null
N_units integer | null

Obsolete.

Default: null
U0 number | null

Initial charging voltage of CLIQ unit [V].

Default: 0
C number | null

Capacitance of CLIQ unit [F].

Default: 0
R number | null

Resistance of CLIQ unit [Ohm].

Default: 0
L number | null

Inductance of CLIQ unit [H].

Default: 0
I0 number | null

Obsolete.

Default: null
esc object

Level 2: Class for the ESC parameters

8 nested properties
t_trigger number[]

Trigger time of ESC units [s] given as a list with length corresponding to the number of ESC units.

Default:
[]
U0 number[]

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

Default:
[]
C number[]

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

Default:
[]
L number[]

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

Default:
[]
R_unit number[]

Internal resistance of ESC units [Ohm] given as a list with length corresponding to the number of ESC units.

Default:
[]
R_leads number[]

Resistance of leads from ESC coil to ESC diode connections [Ohm] given as a list with length corresponding to the number of ESC units.

Default:
[]
Ud_Diode number[]

Forward diodes voltage across ESC coils [V] given as a list with length corresponding to the number of ESC units.

Default:
[]
L_Diode number[]

Inductance in series with diodes across ESC coils [V] given as a list with length corresponding to the number of ESC units.

Default:
[]
e_cliq object

Level 2: Class for the E-CLIQ parameters for protection

15 nested properties
t_trigger number[] | null

Trigger time of E-CLIQ current sources [s] given as a list with length corresponding to the number of E-CLIQ units.

Default:
[]
R_leads number[] | null

List of E-CLIQ unit lead resistances [Ohm]. List length corresponding to the number of E-CLIQ units.

Default: null
L_leads number[] | null

List of E-CLIQ unit lead inductances [H]. List length corresponding to the number of E-CLIQ units.

Default: null
source_type enum

Time evolution of applied current. Supported options are: sine, piecewise.

Default: null
Values: "sine" "piecewise" null
sine object

Level 3: Class for Sine source parameters for E-CLIQ

4 nested properties
frequency number | null

Frequency of the sine source [Hz].

Default: null
current_amplitude number | null

Amplitude of the sine current (A/turn).

Default: null
number_of_periods number | null

Number of periods of ECLIQ power supply [-].

Default: null
number_of_turns integer | null

Number of turns that conform ECLIQ [-].

Default: null
piecewise object

Level 3 Class for piecewise (linear) source parameters for E-CLIQ

5 nested properties
csv_file string | 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.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.

Default: null
currents number[] | null

E-CLIQ coil currents relative to current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.

Default: null
current_multiplier number | null

Multiplier for the E-CLIQ coil currents in currents. Also used for the values in the source_csv_file.

Default: null
quench_propagation string | null

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.

Default: "full"
quench_prop_model string | null

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.

Default: "Ts"
NZPV_multiplier number | null

Factor that multiplies the Normal Zone Propagation Velocity

Default: 1.0
N_units integer[] | null

Number of E-CLIQ units along the magnet length per ecliq coil. It must be an odd number for symmetry reasons.

Default:
[]
h_ecliq number[] | null

Spacing between the ecliq coils along the magnet length (m).

Default:
[]
l_ecliq number[] | null

length of the ecliq coils along the magnet length (m).

Default:
[]
L_ecliq_offset number[] | null

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).

Default:
[]
iECLIQ_toHalfTurn_From integer[] | null

List of coils to which the ECLIQ units are connected from, to which half turns they are in direct contact with.

Default:
[]
iECLIQ_toHalfTurn_To integer[] | null

List of half turns to whom the ECLIQ Units are in direct contact with.

Default:
[]
Rectangle object

Level 2: Class for Input/Output settings for the cable geometry

center_position number[] | null

Center position in two dimensional plane (x, y).

Default: null
width number | null

Width of the region (m).

Default: null
height number | null

Height of the region (m).

Default: null
Rectangular object

Level 2: Class for strand parameters

type string required
Constant: "Rectangular"
bare_width number | null
Default: null
bare_height number | null
Default: null
Cu_noCu_in_strand number | null
Default: null
filament_diameter number | null
Default: null
f_Rho_effective number | null
Default: null
fil_twist_pitch number | null
Default: null
bare_corner_radius number | null
Default: null
material_superconductor string | null

Material of the superconductor. E.g. NbTi, Nb3Sn, etc.

Default: null
n_value_superconductor number | null

n value of the superconductor (for power law fit).

Default: null
ec_superconductor number | null

Critical electric field of the superconductor.

Default: null
minimum_jc_fraction number | 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

Default: null
minimum_jc_field number | 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

Default: null
k_material_superconductor string | number | null

Thermal conductivity of the superconductor.

Default: null
Cv_material_superconductor string | number | null

Material function for specific heat of the superconductor.

Default: null
k_material_stabilizer string | number | null

Thermal conductivity of the stabilizer.

Default: null
Cv_material_stabilizer string | number | null

Material function for specific heat of the stabilizer.

Default: null
rho_material_stabilizer string | number | null

Material function for resistivity of the stabilizer. Constant resistivity can be given as float.

Default: null
RRR number | number[] | 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)

Default: null
T_ref_RRR_high number | null

Upper reference temperature for RRR measurements.

Default: null
T_ref_RRR_low number | null

Lower reference temperature for RRR measurements.

Default: null
Ribbon object

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

type string required
Constant: "Ribbon"
n_strands integer | null
Default: null
bare_cable_width number | null
Default: null
bare_cable_height_low number | null
Default: null
bare_cable_height_high number | null
Default: null
bare_cable_height_mean number | null
Default: null
th_insulation_along_width number | null
Default: null
th_insulation_along_height number | null
Default: null
f_superconductor number | null
Default: null
f_stabilizer number | null
Default: null
f_insulation number | null
Default: null
f_inner_voids number | null
Default: null
f_outer_voids number | null
Default: null
f_core number | null
Default: null
material_insulation string | null
Default: null
material_inner_voids string | null
Default: null
material_outer_voids string | null
Default: null
material_core string | null
Default: null
Round object

Level 2: Class for strand parameters

type string required
Constant: "Round"
fil_twist_pitch number | null
Default: null
diameter number | null
Default: null
diameter_core number | null
Default: null
diameter_filamentary number | null
Default: null
filament_diameter number | null
Default: null
filament_hole_diameter number | null

Specifies round or hexagonal hole diameter inside the filament. If None or 0.0, no hole is created.

Default: null
number_of_filaments integer | null
Default: null
f_Rho_effective number | null
Default: null
Cu_noCu_in_strand number | null
Default: null
material_superconductor string | null

Material of the superconductor. E.g. Nb-Ti, Nb3Sn, etc.

Default: null
n_value_superconductor number | null

n value of the superconductor (for power law fit).

Default: null
ec_superconductor number | null

Critical electric field of the superconductor in V/m.

Default: null
minimum_jc_fraction number | 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

Default: null
minimum_jc_field number | 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

Default: null
k_material_superconductor string | number | null

Thermal conductivity of the superconductor.

Default: null
Cv_material_superconductor string | number | null

Material function for specific heat of the superconductor.

Default: null
rho_material_stabilizer string | number | null

Material function for resistivity of the stabilizer. Constant resistivity can be given as float.

Default: null
rho_material_holes string | number | 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.

Default: null
RRR number | number[] | 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)

Default: null
T_ref_RRR_high number | null

Upper reference temperature for RRR measurements.

Default: null
T_ref_RRR_low number | null

Lower reference temperature for RRR measurements.

Default: null
k_material_stabilizer string | number | null

Thermal conductivity of the stabilizer.

Default: null
Cv_material_stabilizer string | number | null

Material function for specific heat of the stabilizer.

Default: null
RunFiQuS object

Class for FiQuS run

type string

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.

Default: "start_from_yaml"
Values: "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" "plot_python" "batch_post_process_python" "only_create_pro_file_from_mesh" "postprocess_veusz"
geometry integer | string | null

This key will be appended to the geometry folder.

Default: null
mesh integer | string | null

This key will be appended to the mesh folder.

Default: null
solution integer | string | null

This key will be appended to the solution folder.

Default: null
launch_gui boolean

If True, the GUI will be launched after the run.

Default: false
overwrite boolean

If True, the existing folders will be overwritten, otherwise new folders will be created. NOTE: This setting has no effect for HTCondor runs.

Default: false
comments string

Comments for the run. These comments will be saved in the run_log.csv file.

Default: ""
verbosity_Gmsh integer

Level of information printed on the terminal and the message console (0: silent except for fatal errors, 1: +errors, 2: +warnings, 3: +direct, 4: +information, 5: +status, 99: +debug)

Default: 5
verbosity_GetDP integer

Level of information printed on the terminal and the message console. Higher number prints more, good options are 5 or 6.

Default: 5
verbosity_FiQuS boolean

Level of information printed on the terminal and the message console by FiQuS. Only True of False for now.

Default: true
Rutherford object

Rutherford cable type: for example LHC MB magnet cable

type string required
Constant: "Rutherford"
n_strands integer | null
Default: null
n_strand_layers integer | null
Default: null
n_strands_per_layers integer | null
Default: null
bare_cable_width number | null
Default: null
bare_cable_height_low number | null
Default: null
bare_cable_height_high number | null
Default: null
bare_cable_height_mean number | null
Default: null
th_insulation_along_width number | null
Default: null
th_insulation_along_height number | null
Default: null
width_core number | null
Default: null
height_core number | null
Default: null
strand_twist_pitch number | null
Default: null
strand_twist_pitch_angle number | null
Default: null
Rc number | null
Default: null
Ra number | null
Default: null
f_superconductor number | null
Default: null
f_stabilizer number | null
Default: null
f_insulation number | null
Default: null
f_inner_voids number | null
Default: null
f_outer_voids number | null
Default: null
f_core number | null
Default: null
material_insulation string | null
Default: null
material_inner_voids string | null
Default: null
material_outer_voids string | null
Default: null
material_core string | null
Default: null
gamma_c number | null

parameter for DISCC cable homogenization

Default: 0.0
Silver_thickness object
top number | null

On the top side.

Default: null
bottom number | null

On the bottom side.

Default: null
SolveCCT object

Level 2: Class for FiQuS CCT

windings object

Level 2: Class for FiQuS CCT

3 nested properties
currents number[] | null
Default: null
sigmas number[] | null
Default: null
mu_rs number[] | null
Default: null
fqpls object

Level 2: Class for FiQuS CCT

3 nested properties
currents number[]
Default:
[]
sigmas number[]
Default:
[]
mu_rs number[]
Default:
[]
formers object

Level 2: Class for FiQuS CCT

2 nested properties
sigmas number[] | null
Default: null
mu_rs number[] | null
Default: null
air object

Level 2: Class for FiQuS CCT

2 nested properties
sigma number | null
Default: null
mu_r number | null
Default: null
pro_template string | null
Default: null
variables string[] | null
Default: null
volumes string[] | null
Default: null
file_exts string[] | null
Default: null
SolveExcitationCoils object

Level 5: Class for superimposed DC field or current parameters for the sine source

enable boolean | null

Solve with excitation coils acting as sources.

Default: false
SolvePiecewiseSource object

Level 4: Class for piecewise (linear) source parameters

source_csv_file string | null

File name for the from_file source type defining the time evolution of current and field (in-phase). Multipliers are used for each of them. The file should contain two columns: 'time' (s) and 'value' (field/current (T/A)), with these headers. If this field is set, times, applied_fields_relative and transport_currents_relative are ignored.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.

Default: null
applied_fields_relative number[] | null

Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
transport_currents_relative number[] | null

Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.

Default: null
applied_field_multiplier number | null

Multiplier for the applied fields in applied_fields_relative. Also used for the values in the source_csv_file.

Default: null
transport_current_multiplier number | null

Multiplier for the transport currents in transport_currents_relative. Also used for the values in the source_csv_file.

Default: null
SolveSineSource object

Level 4: Class for Sine source parameters

frequency number | null

Frequency of the sine source (Hz).

Default: null
field_amplitude number | null

Amplitude of the sine field (T).

Default: null
current_amplitude number | null

Amplitude of the sine current (A).

Default: null
superimposed_DC object

Level 5: Class for superimposed DC field or current parameters for the sine source

2 nested properties
field_magnitude number | null

DC field magnitude (T) (direction along y-axis). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC field is used.

Default: 0.0
current_magnitude number | null

DC current magnitude (A). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC current is used.

Default: 0.0
SolveSineSourceSuperimposedDC object

Level 5: Class for superimposed DC field or current parameters for the sine source

field_magnitude number | null

DC field magnitude (T) (direction along y-axis). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC field is used.

Default: 0.0
current_magnitude number | null

DC current magnitude (A). Solution must be initialized with a non-zero field solution stored in a .pos file if non-zero DC current is used.

Default: 0.0
SourcePiecewise object

Level 3 Class for piecewise (linear) source parameters for E-CLIQ

csv_file string | 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.

Default: null
times number[] | null

Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.

Default: null
currents number[] | null

E-CLIQ coil currents relative to current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.

Default: null
time_multiplier number | null

Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.

Default: null
current_multiplier number | null

Multiplier for the E-CLIQ coil currents in currents. Also used for the values in the source_csv_file.

Default: null
SourceSine object

Level 3: Class for Sine source parameters for E-CLIQ

frequency number | null

Frequency of the sine source [Hz].

Default: null
current_amplitude number | null

Amplitude of the sine current (A/turn).

Default: null
number_of_periods number | null

Number of periods of ECLIQ power supply [-].

Default: null
number_of_turns integer | null

Number of turns that conform ECLIQ [-].

Default: null
Succi_fixed object

Level 3: Class for cable Succi's YBCO fit

type string required
Constant: "Succi_fixed"
Jc_factor number | null

This factor multiplies the Jc returned by the function.

Default: 1.0
Summers object

Level 3: Class for cable Summer's Nb3Sn fit

type string required
Constant: "Summers"
Tc0_Summers number | null
Default: null
Bc20_Summers number | null
Default: null
Jc0_Summers number | null
Default: null
TSTC object

Twisted Stacked-Tape Cable (TSTC) type:

type string required
Constant: "TSTC"
stack_layout integer[] | null

2D: Tape stack layout ordered TOP->BOTTOM. The numbers represent: 1 = a CC tape, -1 = a flipped CC tape, 0 = a shunt.

Default: null
nb_tapes integer | null

3D: Number of tapes in the stack

Default: null
tape_width number | null

3D and 2D: Width of each tape

Default: null
tape_thickness number | null

3D and 2D: Thickness of each tape

Default: null
twist_pitch number | null

3D: Length over which tapes are twisted by full rotation

Default: null
pitch_fraction number | null

3D: Fraction of the twist pitch to be modelled (1.0 = full pitch, 0.5 = half pitch, etc.)

Default: 1.0
bare_cable_width number | null

Cable width, typically the same as CC width

Default: null
bare_cable_height_low number | null

Narrow end (if applicable) cable height (thickness), typically the same as (CC thickness + Cu stabilizer thickness) * number of tapes.

Default: null
bare_cable_height_high number | null

Wide end (if applicable) cable height (thickness), typically the same as (CC thickness + Cu stabilizer thickness) * number of tapes.

Default: null
bare_cable_height_mean number | null

Average (if applicable) cable height (thickness), typically the same as (CC thickness + Cu stabilizer thickness) * number of tapes.

Default: null
th_insulation_along_width number | null

Insulation thickness along the width

Default: null
th_insulation_along_height number | null

Insulation thickness along the height

Default: null
f_superconductor number | null

Fraction of superconductor related to the total area of the cable (winding cell)

Default: null
f_stabilizer number | null

Fraction of stabilizer related to the total area of the cable (winding cell)

Default: null
f_silver number | null

Fraction of silver related to the total area of the cable (winding cell)

Default: null
f_substrate number | null

Fraction of substrate (including buffer layers and silver overlay) related to the total area of the cable (winding cell)

Default: null
f_shunt number | null

Fraction of substrate (including buffer layers and silver overlay) related to the total area of the cable (winding cell)

Default: null
f_insulation number | null

Fraction of cable insulation related to the total area of the cable (winding cell)

Default: null
f_inner_voids number | null

Fraction of additional material (typically insulation) related to the total area of the cable (winding cell)

Default: null
f_outer_voids number | null

Fraction of additional material (typically helium impregnating the windings) related to the total area of the cable (winding cell)

Default: null
Winding_gFiQuS object

Level 2: Class for FiQuS CCT

names string[] | null
Default: null
r_wms number[] | null
Default: null
n_turnss number[] | null
Default: null
ndpts integer[] | null
Default: null
ndpt_ins integer[] | null
Default: null
ndpt_outs integer[] | null
Default: null
lps number[] | null
Default: null
alphas number[] | null
Default: null
wwws number[] | null
Default: null
wwhs number[] | null
Default: null
Winding_s object

Level 2: Class for FiQuS CCT

currents number[] | null
Default: null
sigmas number[] | null
Default: null
mu_rs number[] | null
Default: null
fiqus__data__DataFiQuSHomogenizedConductor__HomogenizedConductor object

Level 1: Class for FiQuS ConductorAC

type string required
Constant: "HomogenizedConductor"
geometry object

Level 2: Class for strand geometry parameters

5 nested properties
cables_definition Rectangle[]
Default:
{
  "center_position": null,
  "width": null,
  "height": null
}
excitation_coils Rectangle[] | null

List of excitation coils

Default:
[]
air object

Level 2: Class for Input/Output settings for the cable geometry

2 nested properties
center_position number[] | null

Center position in two dimensional plane (x, y).

Default: null
radius number | null

Radius of the circle (m).

Default: null
air_form string

Type of model geometry which will be generated. Supported options are only circle for now

Default: "circle"
Constant: "circle"
io_settings object

Level 2: Class for Input/Output settings for the cable geometry

2 nested properties
load object

Level 3: Class for Input/Output settings for the cable geometry

save object

Level 3: Class for Input/Output settings for the cable geometry

mesh object

Level 2: Class for FiQuS ConductorAC

3 nested properties
scaling_global number | null

Global scaling factor for mesh size.

Default: 1
air_boundary_mesh_size_ratio number | null

Ratio within the air region from boundary to inner elements.

Default: 1
cable_mesh_size_ratio number | null

Scaling factor within the cable regions.

Default: 1
solve object

Level 2: Class for FiQuS HomogenizedConductor solver settings

11 nested properties
pro_template string | null

Name of the .pro template file.

Default: "HomogenizedConductor_template.pro"
general_parameters object

Level 3: Class for general parameters

6 nested properties
superconductor_linear boolean | null

For debugging: replace LTS by normal conductor.

Default: false
noOfMPITasks boolean | integer | null

If integer, GetDP will be run in parallel using MPI. This is only valid if MPI is installed on the system and an MPI-enabled GetDP is used. If False, GetDP will be run in serial without invoking mpiexec.

Default: false
rho_cables number | null

Resistance for cables when modelled as linear conductors (no current sharing with power law) [Ohm*m].

Default: 1
strand_transposition_length number | null

Transposition length of the strands in the Rutherford cable (m).

Default: 0.1
n_strands integer | null

Number of strands in the cable (-).

Default: 36
strand_filling_factor number | null

Filling factor of the strands in the rectangular cable envelope (-).

Default: 0.8617
formulation_parameters object

Level 3: Class for finite element formulation parameters

1 nested properties
hphia boolean | null

Use hphia formulation.

Default: false
discc object

Level 4: Class for DISCC model parameters

5 nested properties
gamma_c number | null

Main crossing scaling parameter (-) that quantifies crossing coupling due to field perpendicular to cable wide face.

Default: 0.43
gamma_a number | null

Main adjacent scaling parameter (-) that quantifies adjacent coupling due to field parallel to cable wide face.

Default: 0.53
lambda_a number | null

Mixing scaling parameter (-) that quantifies adjacent coupling due to field perpendicular to cable wide face.

Default: 0.006
crossing_coupling_resistance number | null

Resistance (Ohm) of the contact between crossing strands.

Default: 0.00002
adjacent_coupling_resistance number | null

Resistance (Ohm) of the contact between adjacent strands over one periodicity length (strand twist pitch divided by the number of strands).

Default: 0.00001
rohf object

Level 4: Class for ROHF model parameters

2 nested properties
enable boolean | null

Use ROHF to homogenize the internal flux hysteresis in the cables.

Default: false
parameter_csv_file string | null

Name of the csv file containing the ROHF parameters within the inputs folder with expected row structure: [alpha,kappa,tau].

Default: null
rohm object

Level 4: Class for ROHM model parameters

4 nested properties
enable boolean | null

Use ROHM to homogenize the magnetization hysteresis in the cables.

Default: false
parameter_csv_file string | null

Name of the csv file containing the ROHM parameters within the inputs folder with expected row structure: [alpha,kappa,chi,gamma,lambda].

Default: null
weight_scaling number | null

Downscaling factor (s<1.0) which is applied to all weights except the first, which is scaled up to compensate.

Default: 1.0
tau_scaling number | null

Scaling factor which is applied uniformly to all coupling time constants.

Default: 1.0
current_sharing object

Level 4: Class for Current Sharing (CS) model parameters

3 nested properties
superconductor_n_value number | null

n value for the power law (-), used in current sharing law.

Default: 30
superconductor_Ic number | null

Critical current of the strands (A) (e.g., typical value at T=1.9K and B=10T). Will be taken as a constant as in this model the field dependence is not included (the main purpose of the model is to verify the more efficient Homogenized Conductor model). Including field-dependence could be done but is not trivial because is mixes global and local quantities in this Rutherford model with strand discretized individually as stranded conductors.

Default: 350
matrix_resistance number | null

Resistance of the matrix (per unit length) (Ohm/m) for the current sharing law. Kept constant in this model (for simplicity).

Default: 0.0006536208
initial_conditions object

Level 3: Class for initial conditions

2 nested properties
init_from_pos_file boolean

This field is used to initialize the solution from a non-zero field solution stored in a .pos file.

Default: false
pos_file_to_init_from string | null

Name of .pos file for magnetic field (A/m) from which the solution should be initialized. Should be in the Geometry_xxx/Mesh_xxx/ folder in which the Solution_xxx will be saved.

Default: null
source_parameters object

Level 3: Class for material properties

8 nested properties
boundary_condition_type string

Type of boundary condition applied at the outer domain boundary.

Default: "Natural"
Values: "Natural" "Essential"
source_type string

Time evolution of applied current and magnetic field. Supported options are: sine, sine_with_DC, piecewise_linear, from_list.

Default: "sine"
Values: "sine" "piecewise"
parallel_resistor boolean | number | null

If False, no parallel resistor and the current source directly and only feeds the cable. If True, a resistor is placed in parallel with the cable, with a default resistance of 1 Ohm. If float (cannot be zero), this defines the value of the resistance. If more than one cable is modelled, they are all connected in series (and carry the same current).

Default: false
excitation_coils object

Level 5: Class for superimposed DC field or current parameters for the sine source

sine object

Level 4: Class for Sine source parameters

piecewise object

Level 4: Class for piecewise (linear) source parameters

field_angle number | null

Angle of the source magnetic field, with respect to the x-axis (degrees).

Default: 90
cable_current_multipliers number[] | null

Individual multipliers applied to the transport current imposed in each cable. factors are applied according to the cable declarations in the geometry section of the yaml.

Default: null
numerical_parameters object

Level 3: Class for numerical parameters

2 nested properties
sine object

Level 4: Numerical parameters corresponding to the sine source

piecewise object

Level 4: Numerical parameters corresponding to the piecewise source

frequency_domain_solver object

Level 3: Class for frequency domain solver parameters

2 nested properties
enable boolean | null

Enable frequency solver functionality in the solve step.

Default: false
frequency_sweep object

Level 4: Class for the frequency sweep definition within a frequency domain solver.

postproc object

Level 2: Class for FiQuS ConductorAC

7 nested properties
generate_pos_files boolean

Set True to generate .pos-files during post-processing

Default: true
output_folder string | null

Batch post-processing creates a folder with the given name in the output directory, where all the plots are saved.

Default: null
generate_report boolean | null

Generates a PDF report including all postprocessing graphs. File is saved in the output_folder.

Default: false
save_last_current_density string | null

Saves the last current density field solution (out-of-plane) in the file given as a string. The '.pos' extension will be appended to it. Nothing is done if None. This can be for using the current density as an initial condition (but not implemented yet).

Default: null
save_last_magnetic_field string | null

Saves the last magnetic field solution (in-plane) in the file given as a string. The '.pos' extension will be appended to it. Nothing is done if None. This is for using the magnetic field as an initial condition for another resolution.

Default: null
cleanup object

Level 3: Class for cleanup settings

3 nested properties
remove_pre_file boolean

Set True to remove the .pre-file after post-processing, to save disk space.

Default: false
remove_res_file boolean

Set True to remove the .res-file after post-processing, to save disk space.

Default: false
remove_msh_file boolean

Set True to remove the .msh-file after post-processing, to save disk space.

Default: false
sample_line object

Level 3: Class for sampling along a predefined line within the model

3 nested properties
start_point number[] | null

Start point of the line in cartesian coordinates: [x,y,z].

Default: null
end_point number[] | null

End point of the line in cartesian coordinates: [x,y,z].

Default: null
samples integer | null

Integer number of evenly spaced sample points along the line including start and end point.

Default: null
fiqus__data__DataFiQuSHomogenizedConductor__HomogenizedConductorFormulationparametersROHF object

Level 4: Class for ROHF model parameters

enable boolean | null

Use ROHF to homogenize the internal flux hysteresis in the cables.

Default: false
parameter_csv_file string | null

Name of the csv file containing the ROHF parameters within the inputs folder with expected row structure: [alpha,kappa,tau].

Default: null
fiqus__data__DataFiQuSHomogenizedConductor__HomogenizedConductorFormulationparametersROHM object

Level 4: Class for ROHM model parameters

enable boolean | null

Use ROHM to homogenize the magnetization hysteresis in the cables.

Default: false
parameter_csv_file string | null

Name of the csv file containing the ROHM parameters within the inputs folder with expected row structure: [alpha,kappa,chi,gamma,lambda].

Default: null
weight_scaling number | null

Downscaling factor (s<1.0) which is applied to all weights except the first, which is scaled up to compensate.

Default: 1.0
tau_scaling number | null

Scaling factor which is applied uniformly to all coupling time constants.

Default: 1.0
fiqus__data__DataFiQuSMultipole__HomogenizedConductor object

Level 3: Class for FiQuS Multipole

enabled boolean | null

It determines whether the homogenized conductor model is enabled or not.

Default: false
run_type object

Level 4: Class for runtype parameters

2 nested properties
mode string | null

Type of simulation to run with homogenized conductors (ramp - real cooling conditions, isothermal_ramp - unlimited cooling, quench - non-zero initial conditions)

Default: "ramp"
ramp_file string | null

Name of the ramp model from which to start the simulation

Default: null
rohm object

Level 4: Class for finite element formulation parameters

5 nested properties
enabled boolean | null

Use ROHM to homogenize the magnetization hysteresis in the cables.

Default: false
parameter_csv_file string | null

Name of the csv file containing the ROHM parameters within the inputs folder with expected row structure: [alpha,kappa,chi,gamma,lambda].

Default: null
gather_cell_systems boolean | null

when true, it generates a single system to solve the ROHM cells instead of one system per cell to decrease generation time.

Default: false
weight_scaling number | null

Downscaling factor (s<1.0) which is applied to all weights except the first, which is scaled up to compensate.

Default: 1.0
tau_scaling number | null

Scaling factor which is applied uniformly to all coupling time constants.

Default: 1.0
rohf object

Level 4: Class for finite element formulation parameters

3 nested properties
enabled boolean | null

Use ROHF to homogenize the internal flux hysteresis in the cables.

Default: false
parameter_csv_file string | null

Name of the csv file containing the ROHF parameters within the inputs folder with expected row structure: [alpha,kappa,tau].

Default: null
gather_cell_systems boolean | null

when true, it generates a single system to solve the ROHF cells instead of one system per cell to decrease generation time.

Default: false
fiqus__data__DataFiQuSMultipole__HomogenizedConductorFormulationparametersROHF object

Level 4: Class for finite element formulation parameters

enabled boolean | null

Use ROHF to homogenize the internal flux hysteresis in the cables.

Default: false
parameter_csv_file string | null

Name of the csv file containing the ROHF parameters within the inputs folder with expected row structure: [alpha,kappa,tau].

Default: null
gather_cell_systems boolean | null

when true, it generates a single system to solve the ROHF cells instead of one system per cell to decrease generation time.

Default: false
fiqus__data__DataFiQuSMultipole__HomogenizedConductorFormulationparametersROHM object

Level 4: Class for finite element formulation parameters

enabled boolean | null

Use ROHM to homogenize the magnetization hysteresis in the cables.

Default: false
parameter_csv_file string | null

Name of the csv file containing the ROHM parameters within the inputs folder with expected row structure: [alpha,kappa,chi,gamma,lambda].

Default: null
gather_cell_systems boolean | null

when true, it generates a single system to solve the ROHM cells instead of one system per cell to decrease generation time.

Default: false
weight_scaling number | null

Downscaling factor (s<1.0) which is applied to all weights except the first, which is scaled up to compensate.

Default: 1.0
tau_scaling number | null

Scaling factor which is applied uniformly to all coupling time constants.

Default: 1.0