Skip to content

DataFiQuSHomogenizedConductor

Auto-generated documentation for DataFiQuSHomogenizedConductor.

Classes

Circle

Module: DataFiQuSHomogenizedConductor

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

Fields

Field Type Default Description
center_position Optional[list] null Center position in two dimensional plane (x, y).
radius Optional[float] null Radius of the circle (m).

HomogenizedConductor

Module: DataFiQuSHomogenizedConductor

Description: Level 1: Class for FiQuS ConductorAC

Fields

Field Type Default Description
type str Required
geometry HomogenizedConductorGeometry HomogenizedConductorGeometry()
mesh HomogenizedConductorMesh HomogenizedConductorMesh()
solve HomogenizedConductorSolve HomogenizedConductorSolve()
postproc HomogenizedConductorPostproc HomogenizedConductorPostproc()

Nested Models

Circle

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

Field Type Default Description
center_position Optional[list] null Center position in two dimensional plane (x, y).
radius Optional[float] null Radius of the circle (m).

HomogenizedConductorFormulationparameters

Description: Level 3: Class for finite element formulation parameters

Field Type Default Description
hphia Optional[bool] False Use hphia formulation.

HomogenizedConductorFormulationparametersCS

Description: Level 4: Class for Current Sharing (CS) model parameters

Field Type Default Description
superconductor_n_value Optional[float] 30 n value for the power law (-), used in current sharing law.
superconductor_Ic Optional[float] 350 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.
matrix_resistance Optional[float] 0.0006536208 Resistance of the matrix (per unit length) (Ohm/m) for the current sharing law. Kept constant in this model (for simplicity).

HomogenizedConductorFormulationparametersDISCC

Description: Level 4: Class for DISCC model parameters

Field Type Default Description
gamma_c Optional[float] 0.43 Main crossing scaling parameter (-) that quantifies crossing coupling due to field perpendicular to cable wide face.
gamma_a Optional[float] 0.53 Main adjacent scaling parameter (-) that quantifies adjacent coupling due to field parallel to cable wide face.
lambda_a Optional[float] 0.006 Mixing scaling parameter (-) that quantifies adjacent coupling due to field perpendicular to cable wide face.
crossing_coupling_resistance Optional[float] 2e-05 Resistance (Ohm) of the contact between crossing strands.
adjacent_coupling_resistance Optional[float] 1e-05 Resistance (Ohm) of the contact between adjacent strands over one periodicity length (strand twist pitch divided by the number of strands).

HomogenizedConductorFormulationparametersSampleLine

Description: Level 3: Class for sampling along a predefined line within the model

Field Type Default Description
start_point Optional[list] null Start point of the line in cartesian coordinates: [x,y,z].
end_point Optional[list] null End point of the line in cartesian coordinates: [x,y,z].
samples Optional[int] null Integer number of evenly spaced sample points along the line including start and end point.

HomogenizedConductorGeometry

Description: Level 2: Class for strand geometry parameters

Field Type Default Description
cables_definition list {...} (3 fields)
excitation_coils Optional[list] [] List of excitation coils
air Circle Circle()
air_form str "circle" Type of model geometry which will be generated. Supported options are only circle for now
io_settings HomogenizedConductorGeometryIOsettings HomogenizedConductorGeometryIOsettings()

HomogenizedConductorGeometryIOsettings

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

Field Type Default Description
load HomogenizedConductorIOsettingsLoad HomogenizedConductorIOsettingsLoad()
save HomogenizedConductorIOsettingsSave HomogenizedConductorIOsettingsSave()

HomogenizedConductorIOsettingsLoad

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

Field Type Default Description
load_from_yaml Optional[bool] False True to load the geometry from a YAML file, false to generate the geometry.
filename Optional[str] null Name of the YAML file from which to load the geometry.

HomogenizedConductorIOsettingsSave

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

Field Type Default Description
save_to_yaml Optional[bool] False True to save the geometry to a YAML-file, false to not save the geometry.
filename Optional[str] null Name of the output geometry YAML file.

HomogenizedConductorMesh

Description: Level 2: Class for FiQuS ConductorAC

Field Type Default Description
scaling_global Optional[float] 1 Global scaling factor for mesh size.
air_boundary_mesh_size_ratio Optional[float] 1 Ratio within the air region from boundary to inner elements.
cable_mesh_size_ratio Optional[float] 1 Scaling factor within the cable regions.

HomogenizedConductorNumericalparametersPiecewise

Description: Level 4: Numerical parameters corresponding to the piecewise source

Field Type Default Description
time_to_simulate Optional[float] null Total time to simulate (s). Used for the piecewise source.
timesteps_per_time_to_simulate Optional[float] null If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.
force_stepping_at_times_piecewise_linear bool False 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).
variable_max_timestep bool False If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.
times_max_timestep_piecewise_linear Optional[list] null Time instants (s) defining the piecewise linear maximum time step.
max_timestep_piecewise_linear Optional[list] null Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

HomogenizedConductorNumericalparametersSine

Description: Level 4: Numerical parameters corresponding to the sine source

Field Type Default Description
timesteps_per_period Optional[float] null Initial value for number of time steps (-) per period for the sine source. Determines the initial time step size.
number_of_periods_to_simulate Optional[float] null Number of periods (-) to simulate for the sine source.

HomogenizedConductorPostproc

Description: Level 2: Class for FiQuS ConductorAC

Field Type Default Description
generate_pos_files bool True Set True to generate .pos-files during post-processing
output_folder Optional[str] null Batch post-processing creates a folder with the given name in the output directory, where all the plots are saved.
generate_report Optional[bool] False Generates a PDF report including all postprocessing graphs. File is saved in the output_folder.
save_last_current_density Optional[str] 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).
save_last_magnetic_field Optional[str] 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.
cleanup HomogenizedConductorPostprocCleanup HomogenizedConductorPostprocCleanup()
sample_line HomogenizedConductorFormulationparametersSampleLine HomogenizedConductorFormulationparametersSampleLine()

HomogenizedConductorPostprocCleanup

Description: Level 3: Class for cleanup settings

Field Type Default Description
remove_pre_file bool False Set True to remove the .pre-file after post-processing, to save disk space.
remove_res_file bool False Set True to remove the .res-file after post-processing, to save disk space.
remove_msh_file bool False Set True to remove the .msh-file after post-processing, to save disk space.

HomogenizedConductorSolve

Description: Level 2: Class for FiQuS HomogenizedConductor solver settings

Field Type Default Description
pro_template Optional[str] "HomogenizedConductor_template.pro" Name of the .pro template file.
general_parameters HomogenizedConductorSolveGeneralparameters HomogenizedConductorSolveGeneralparameters()
formulation_parameters HomogenizedConductorFormulationparameters HomogenizedConductorFormulationparameters()
discc HomogenizedConductorFormulationparametersDISCC HomogenizedConductorFormulationparametersDISCC()
rohf HomogenizedConductorFormulationparametersROHF HomogenizedConductorFormulationparametersROHF()
rohm HomogenizedConductorFormulationparametersROHM HomogenizedConductorFormulationparametersROHM()
current_sharing HomogenizedConductorFormulationparametersCS HomogenizedConductorFormulationparametersCS()
initial_conditions HomogenizedConductorSolveInitialconditions HomogenizedConductorSolveInitialconditions()
source_parameters HomogenizedConductorSolveSourceparameters HomogenizedConductorSolveSourceparameters()
numerical_parameters HomogenizedConductorSolveNumericalparameters HomogenizedConductorSolveNumericalparameters()
frequency_domain_solver HomogenizedConductorSolveFrequencyDomain HomogenizedConductorSolveFrequencyDomain()

HomogenizedConductorSolveFrequencyDomain

Description: Level 3: Class for frequency domain solver parameters

Field Type Default Description
enable Optional[bool] False Enable frequency solver functionality in the solve step.
frequency_sweep HomogenizedConductorSolveFrequencyDomainSweep HomogenizedConductorSolveFrequencyDomainSweep()

HomogenizedConductorSolveFrequencyDomainSweep

Description: Level 4: Class for the frequency sweep definition within a frequency domain solver.

Field Type Default Description
run_sweep Optional[bool] False Enabling a frequency sweep.
start_frequency Optional[float] 1 Start frequency of the sweep in Hz.
end_frequency Optional[float] 100 End frequency of the sweep in Hz.
number_of_frequencies Optional[int] 3 Total number of frequencies in the sweep (logspaced)

HomogenizedConductorSolveGeneralparameters

Description: Level 3: Class for general parameters

Field Type Default Description
superconductor_linear Optional[bool] False For debugging: replace LTS by normal conductor.
noOfMPITasks Optional[bool | int] False 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.
rho_cables Optional[float] 1 Resistance for cables when modelled as linear conductors (no current sharing with power law) [Ohm*m].
strand_transposition_length Optional[float] 0.1 Transposition length of the strands in the Rutherford cable (m).
n_strands Optional[int] 36 Number of strands in the cable (-).
strand_filling_factor Optional[float] 0.8617 Filling factor of the strands in the rectangular cable envelope (-).

HomogenizedConductorSolveInitialconditions

Description: Level 3: Class for initial conditions

Field Type Default Description
init_from_pos_file bool False This field is used to initialize the solution from a non-zero field solution stored in a .pos file.
pos_file_to_init_from Optional[str] 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.

HomogenizedConductorSolveNumericalparameters

Description: Level 3: Class for numerical parameters

Field Type Default Description
sine HomogenizedConductorNumericalparametersSine HomogenizedConductorNumericalparametersSine()
piecewise HomogenizedConductorNumericalparametersPiecewise HomogenizedConductorNumericalparametersPiecewise()

HomogenizedConductorSolveSourceparameters

Description: Level 3: Class for material properties

Field Type Default Description
boundary_condition_type Literal[str] "Natural" Type of boundary condition applied at the outer domain boundary.

Available inputs: "Natural", "Essential"
source_type Literal[str] "sine" Time evolution of applied current and magnetic field. Supported options are: sine, sine_with_DC, piecewise_linear, from_list.

Available inputs: "sine", "piecewise"
parallel_resistor Optional[bool | float] False 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).
excitation_coils SolveExcitationCoils SolveExcitationCoils()
sine SolveSineSource SolveSineSource()
piecewise SolvePiecewiseSource SolvePiecewiseSource()
field_angle Optional[float] 90 Angle of the source magnetic field, with respect to the x-axis (degrees).
cable_current_multipliers Optional[list] 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.

Rectangle

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

Field Type Default Description
center_position Optional[list] null Center position in two dimensional plane (x, y).
width Optional[float] null Width of the region (m).
height Optional[float] null Height of the region (m).

SolveExcitationCoils

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

Field Type Default Description
enable Optional[bool] False Solve with excitation coils acting as sources.

SolvePiecewiseSource

Description: Level 4: Class for piecewise (linear) source parameters

Field Type Default Description
source_csv_file Optional[str] 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.
times Optional[list] null Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.
applied_fields_relative Optional[list] null Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'. Used only if source_csv_file is not set.
transport_currents_relative Optional[list] null Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.
time_multiplier Optional[float] null Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.
applied_field_multiplier Optional[float] null Multiplier for the applied fields in applied_fields_relative. Also used for the values in the source_csv_file.
transport_current_multiplier Optional[float] null Multiplier for the transport currents in transport_currents_relative. Also used for the values in the source_csv_file.

SolveSineSource

Description: Level 4: Class for Sine source parameters

Field Type Default Description
frequency Optional[float] null Frequency of the sine source (Hz).
field_amplitude Optional[float] null Amplitude of the sine field (T).
current_amplitude Optional[float] null Amplitude of the sine current (A).
superimposed_DC SolveSineSourceSuperimposedDC SolveSineSourceSuperimposedDC()

SolveSineSourceSuperimposedDC

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

Field Type Default Description
field_magnitude Optional[float] 0.0 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.
current_magnitude Optional[float] 0.0 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.

HomogenizedConductorFormulationparameters

Module: DataFiQuSHomogenizedConductor

Description: Level 3: Class for finite element formulation parameters

Fields

Field Type Default Description
hphia Optional[bool] False Use hphia formulation.

HomogenizedConductorFormulationparametersCS

Module: DataFiQuSHomogenizedConductor

Description: Level 4: Class for Current Sharing (CS) model parameters

Fields

Field Type Default Description
superconductor_n_value Optional[float] 30 n value for the power law (-), used in current sharing law.
superconductor_Ic Optional[float] 350 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.
matrix_resistance Optional[float] 0.0006536208 Resistance of the matrix (per unit length) (Ohm/m) for the current sharing law. Kept constant in this model (for simplicity).

HomogenizedConductorFormulationparametersDISCC

Module: DataFiQuSHomogenizedConductor

Description: Level 4: Class for DISCC model parameters

Fields

Field Type Default Description
gamma_c Optional[float] 0.43 Main crossing scaling parameter (-) that quantifies crossing coupling due to field perpendicular to cable wide face.
gamma_a Optional[float] 0.53 Main adjacent scaling parameter (-) that quantifies adjacent coupling due to field parallel to cable wide face.
lambda_a Optional[float] 0.006 Mixing scaling parameter (-) that quantifies adjacent coupling due to field perpendicular to cable wide face.
crossing_coupling_resistance Optional[float] 2e-05 Resistance (Ohm) of the contact between crossing strands.
adjacent_coupling_resistance Optional[float] 1e-05 Resistance (Ohm) of the contact between adjacent strands over one periodicity length (strand twist pitch divided by the number of strands).

HomogenizedConductorFormulationparametersROHF

Module: DataFiQuSHomogenizedConductor

Description: Level 4: Class for ROHF model parameters

Fields

Field Type Default Description
enable Optional[bool] False Use ROHF to homogenize the internal flux hysteresis in the cables.
parameter_csv_file Optional[str] null Name of the csv file containing the ROHF parameters within the inputs folder with expected row structure: [alpha,kappa,tau].

HomogenizedConductorFormulationparametersROHM

Module: DataFiQuSHomogenizedConductor

Description: Level 4: Class for ROHM model parameters

Fields

Field Type Default Description
enable Optional[bool] False Use ROHM to homogenize the magnetization hysteresis in the cables.
parameter_csv_file Optional[str] null Name of the csv file containing the ROHM parameters within the inputs folder with expected row structure: [alpha,kappa,chi,gamma,lambda].
weight_scaling Optional[float] 1.0 Downscaling factor (s<1.0) which is applied to all weights except the first, which is scaled up to compensate.
tau_scaling Optional[float] 1.0 Scaling factor which is applied uniformly to all coupling time constants.

HomogenizedConductorFormulationparametersSampleLine

Module: DataFiQuSHomogenizedConductor

Description: Level 3: Class for sampling along a predefined line within the model

Fields

Field Type Default Description
start_point Optional[list] null Start point of the line in cartesian coordinates: [x,y,z].
end_point Optional[list] null End point of the line in cartesian coordinates: [x,y,z].
samples Optional[int] null Integer number of evenly spaced sample points along the line including start and end point.

HomogenizedConductorGeometry

Module: DataFiQuSHomogenizedConductor

Description: Level 2: Class for strand geometry parameters

Fields

Field Type Default Description
cables_definition list {...} (3 fields)
excitation_coils Optional[list] [] List of excitation coils
air Circle Circle()
air_form str "circle" Type of model geometry which will be generated. Supported options are only circle for now
io_settings HomogenizedConductorGeometryIOsettings HomogenizedConductorGeometryIOsettings()

Nested Models

Circle

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

Field Type Default Description
center_position Optional[list] null Center position in two dimensional plane (x, y).
radius Optional[float] null Radius of the circle (m).

HomogenizedConductorGeometryIOsettings

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

Field Type Default Description
load HomogenizedConductorIOsettingsLoad HomogenizedConductorIOsettingsLoad()
save HomogenizedConductorIOsettingsSave HomogenizedConductorIOsettingsSave()

HomogenizedConductorIOsettingsLoad

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

Field Type Default Description
load_from_yaml Optional[bool] False True to load the geometry from a YAML file, false to generate the geometry.
filename Optional[str] null Name of the YAML file from which to load the geometry.

HomogenizedConductorIOsettingsSave

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

Field Type Default Description
save_to_yaml Optional[bool] False True to save the geometry to a YAML-file, false to not save the geometry.
filename Optional[str] null Name of the output geometry YAML file.

Rectangle

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

Field Type Default Description
center_position Optional[list] null Center position in two dimensional plane (x, y).
width Optional[float] null Width of the region (m).
height Optional[float] null Height of the region (m).

HomogenizedConductorGeometryIOsettings

Module: DataFiQuSHomogenizedConductor

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

Fields

Field Type Default Description
load HomogenizedConductorIOsettingsLoad HomogenizedConductorIOsettingsLoad()
save HomogenizedConductorIOsettingsSave HomogenizedConductorIOsettingsSave()

Nested Models

HomogenizedConductorIOsettingsLoad

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

Field Type Default Description
load_from_yaml Optional[bool] False True to load the geometry from a YAML file, false to generate the geometry.
filename Optional[str] null Name of the YAML file from which to load the geometry.

HomogenizedConductorIOsettingsSave

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

Field Type Default Description
save_to_yaml Optional[bool] False True to save the geometry to a YAML-file, false to not save the geometry.
filename Optional[str] null Name of the output geometry YAML file.

HomogenizedConductorIOsettingsLoad

Module: DataFiQuSHomogenizedConductor

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

Fields

Field Type Default Description
load_from_yaml Optional[bool] False True to load the geometry from a YAML file, false to generate the geometry.
filename Optional[str] null Name of the YAML file from which to load the geometry.

HomogenizedConductorIOsettingsSave

Module: DataFiQuSHomogenizedConductor

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

Fields

Field Type Default Description
save_to_yaml Optional[bool] False True to save the geometry to a YAML-file, false to not save the geometry.
filename Optional[str] null Name of the output geometry YAML file.

HomogenizedConductorMesh

Module: DataFiQuSHomogenizedConductor

Description: Level 2: Class for FiQuS ConductorAC

Fields

Field Type Default Description
scaling_global Optional[float] 1 Global scaling factor for mesh size.
air_boundary_mesh_size_ratio Optional[float] 1 Ratio within the air region from boundary to inner elements.
cable_mesh_size_ratio Optional[float] 1 Scaling factor within the cable regions.

HomogenizedConductorNumericalparametersPiecewise

Module: DataFiQuSHomogenizedConductor

Description: Level 4: Numerical parameters corresponding to the piecewise source

Fields

Field Type Default Description
time_to_simulate Optional[float] null Total time to simulate (s). Used for the piecewise source.
timesteps_per_time_to_simulate Optional[float] null If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.
force_stepping_at_times_piecewise_linear bool False 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).
variable_max_timestep bool False If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.
times_max_timestep_piecewise_linear Optional[list] null Time instants (s) defining the piecewise linear maximum time step.
max_timestep_piecewise_linear Optional[list] null Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

HomogenizedConductorNumericalparametersSine

Module: DataFiQuSHomogenizedConductor

Description: Level 4: Numerical parameters corresponding to the sine source

Fields

Field Type Default Description
timesteps_per_period Optional[float] null Initial value for number of time steps (-) per period for the sine source. Determines the initial time step size.
number_of_periods_to_simulate Optional[float] null Number of periods (-) to simulate for the sine source.

HomogenizedConductorPostproc

Module: DataFiQuSHomogenizedConductor

Description: Level 2: Class for FiQuS ConductorAC

Fields

Field Type Default Description
generate_pos_files bool True Set True to generate .pos-files during post-processing
output_folder Optional[str] null Batch post-processing creates a folder with the given name in the output directory, where all the plots are saved.
generate_report Optional[bool] False Generates a PDF report including all postprocessing graphs. File is saved in the output_folder.
save_last_current_density Optional[str] 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).
save_last_magnetic_field Optional[str] 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.
cleanup HomogenizedConductorPostprocCleanup HomogenizedConductorPostprocCleanup()
sample_line HomogenizedConductorFormulationparametersSampleLine HomogenizedConductorFormulationparametersSampleLine()

Nested Models

HomogenizedConductorFormulationparametersSampleLine

Description: Level 3: Class for sampling along a predefined line within the model

Field Type Default Description
start_point Optional[list] null Start point of the line in cartesian coordinates: [x,y,z].
end_point Optional[list] null End point of the line in cartesian coordinates: [x,y,z].
samples Optional[int] null Integer number of evenly spaced sample points along the line including start and end point.

HomogenizedConductorPostprocCleanup

Description: Level 3: Class for cleanup settings

Field Type Default Description
remove_pre_file bool False Set True to remove the .pre-file after post-processing, to save disk space.
remove_res_file bool False Set True to remove the .res-file after post-processing, to save disk space.
remove_msh_file bool False Set True to remove the .msh-file after post-processing, to save disk space.

HomogenizedConductorPostprocCleanup

Module: DataFiQuSHomogenizedConductor

Description: Level 3: Class for cleanup settings

Fields

Field Type Default Description
remove_pre_file bool False Set True to remove the .pre-file after post-processing, to save disk space.
remove_res_file bool False Set True to remove the .res-file after post-processing, to save disk space.
remove_msh_file bool False Set True to remove the .msh-file after post-processing, to save disk space.

HomogenizedConductorSolve

Module: DataFiQuSHomogenizedConductor

Description: Level 2: Class for FiQuS HomogenizedConductor solver settings

Fields

Field Type Default Description
pro_template Optional[str] "HomogenizedConductor_template.pro" Name of the .pro template file.
general_parameters HomogenizedConductorSolveGeneralparameters HomogenizedConductorSolveGeneralparameters()
formulation_parameters HomogenizedConductorFormulationparameters HomogenizedConductorFormulationparameters()
discc HomogenizedConductorFormulationparametersDISCC HomogenizedConductorFormulationparametersDISCC()
rohf HomogenizedConductorFormulationparametersROHF HomogenizedConductorFormulationparametersROHF()
rohm HomogenizedConductorFormulationparametersROHM HomogenizedConductorFormulationparametersROHM()
current_sharing HomogenizedConductorFormulationparametersCS HomogenizedConductorFormulationparametersCS()
initial_conditions HomogenizedConductorSolveInitialconditions HomogenizedConductorSolveInitialconditions()
source_parameters HomogenizedConductorSolveSourceparameters HomogenizedConductorSolveSourceparameters()
numerical_parameters HomogenizedConductorSolveNumericalparameters HomogenizedConductorSolveNumericalparameters()
frequency_domain_solver HomogenizedConductorSolveFrequencyDomain HomogenizedConductorSolveFrequencyDomain()

Nested Models

HomogenizedConductorFormulationparameters

Description: Level 3: Class for finite element formulation parameters

Field Type Default Description
hphia Optional[bool] False Use hphia formulation.

HomogenizedConductorFormulationparametersCS

Description: Level 4: Class for Current Sharing (CS) model parameters

Field Type Default Description
superconductor_n_value Optional[float] 30 n value for the power law (-), used in current sharing law.
superconductor_Ic Optional[float] 350 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.
matrix_resistance Optional[float] 0.0006536208 Resistance of the matrix (per unit length) (Ohm/m) for the current sharing law. Kept constant in this model (for simplicity).

HomogenizedConductorFormulationparametersDISCC

Description: Level 4: Class for DISCC model parameters

Field Type Default Description
gamma_c Optional[float] 0.43 Main crossing scaling parameter (-) that quantifies crossing coupling due to field perpendicular to cable wide face.
gamma_a Optional[float] 0.53 Main adjacent scaling parameter (-) that quantifies adjacent coupling due to field parallel to cable wide face.
lambda_a Optional[float] 0.006 Mixing scaling parameter (-) that quantifies adjacent coupling due to field perpendicular to cable wide face.
crossing_coupling_resistance Optional[float] 2e-05 Resistance (Ohm) of the contact between crossing strands.
adjacent_coupling_resistance Optional[float] 1e-05 Resistance (Ohm) of the contact between adjacent strands over one periodicity length (strand twist pitch divided by the number of strands).

HomogenizedConductorNumericalparametersPiecewise

Description: Level 4: Numerical parameters corresponding to the piecewise source

Field Type Default Description
time_to_simulate Optional[float] null Total time to simulate (s). Used for the piecewise source.
timesteps_per_time_to_simulate Optional[float] null If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.
force_stepping_at_times_piecewise_linear bool False 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).
variable_max_timestep bool False If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.
times_max_timestep_piecewise_linear Optional[list] null Time instants (s) defining the piecewise linear maximum time step.
max_timestep_piecewise_linear Optional[list] null Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

HomogenizedConductorNumericalparametersSine

Description: Level 4: Numerical parameters corresponding to the sine source

Field Type Default Description
timesteps_per_period Optional[float] null Initial value for number of time steps (-) per period for the sine source. Determines the initial time step size.
number_of_periods_to_simulate Optional[float] null Number of periods (-) to simulate for the sine source.

HomogenizedConductorSolveFrequencyDomain

Description: Level 3: Class for frequency domain solver parameters

Field Type Default Description
enable Optional[bool] False Enable frequency solver functionality in the solve step.
frequency_sweep HomogenizedConductorSolveFrequencyDomainSweep HomogenizedConductorSolveFrequencyDomainSweep()

HomogenizedConductorSolveFrequencyDomainSweep

Description: Level 4: Class for the frequency sweep definition within a frequency domain solver.

Field Type Default Description
run_sweep Optional[bool] False Enabling a frequency sweep.
start_frequency Optional[float] 1 Start frequency of the sweep in Hz.
end_frequency Optional[float] 100 End frequency of the sweep in Hz.
number_of_frequencies Optional[int] 3 Total number of frequencies in the sweep (logspaced)

HomogenizedConductorSolveGeneralparameters

Description: Level 3: Class for general parameters

Field Type Default Description
superconductor_linear Optional[bool] False For debugging: replace LTS by normal conductor.
noOfMPITasks Optional[bool | int] False 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.
rho_cables Optional[float] 1 Resistance for cables when modelled as linear conductors (no current sharing with power law) [Ohm*m].
strand_transposition_length Optional[float] 0.1 Transposition length of the strands in the Rutherford cable (m).
n_strands Optional[int] 36 Number of strands in the cable (-).
strand_filling_factor Optional[float] 0.8617 Filling factor of the strands in the rectangular cable envelope (-).

HomogenizedConductorSolveInitialconditions

Description: Level 3: Class for initial conditions

Field Type Default Description
init_from_pos_file bool False This field is used to initialize the solution from a non-zero field solution stored in a .pos file.
pos_file_to_init_from Optional[str] 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.

HomogenizedConductorSolveNumericalparameters

Description: Level 3: Class for numerical parameters

Field Type Default Description
sine HomogenizedConductorNumericalparametersSine HomogenizedConductorNumericalparametersSine()
piecewise HomogenizedConductorNumericalparametersPiecewise HomogenizedConductorNumericalparametersPiecewise()

HomogenizedConductorSolveSourceparameters

Description: Level 3: Class for material properties

Field Type Default Description
boundary_condition_type Literal[str] "Natural" Type of boundary condition applied at the outer domain boundary.

Available inputs: "Natural", "Essential"
source_type Literal[str] "sine" Time evolution of applied current and magnetic field. Supported options are: sine, sine_with_DC, piecewise_linear, from_list.

Available inputs: "sine", "piecewise"
parallel_resistor Optional[bool | float] False 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).
excitation_coils SolveExcitationCoils SolveExcitationCoils()
sine SolveSineSource SolveSineSource()
piecewise SolvePiecewiseSource SolvePiecewiseSource()
field_angle Optional[float] 90 Angle of the source magnetic field, with respect to the x-axis (degrees).
cable_current_multipliers Optional[list] 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.

SolveExcitationCoils

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

Field Type Default Description
enable Optional[bool] False Solve with excitation coils acting as sources.

SolvePiecewiseSource

Description: Level 4: Class for piecewise (linear) source parameters

Field Type Default Description
source_csv_file Optional[str] 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.
times Optional[list] null Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.
applied_fields_relative Optional[list] null Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'. Used only if source_csv_file is not set.
transport_currents_relative Optional[list] null Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.
time_multiplier Optional[float] null Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.
applied_field_multiplier Optional[float] null Multiplier for the applied fields in applied_fields_relative. Also used for the values in the source_csv_file.
transport_current_multiplier Optional[float] null Multiplier for the transport currents in transport_currents_relative. Also used for the values in the source_csv_file.

SolveSineSource

Description: Level 4: Class for Sine source parameters

Field Type Default Description
frequency Optional[float] null Frequency of the sine source (Hz).
field_amplitude Optional[float] null Amplitude of the sine field (T).
current_amplitude Optional[float] null Amplitude of the sine current (A).
superimposed_DC SolveSineSourceSuperimposedDC SolveSineSourceSuperimposedDC()

SolveSineSourceSuperimposedDC

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

Field Type Default Description
field_magnitude Optional[float] 0.0 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.
current_magnitude Optional[float] 0.0 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.

HomogenizedConductorSolveFrequencyDomain

Module: DataFiQuSHomogenizedConductor

Description: Level 3: Class for frequency domain solver parameters

Fields

Field Type Default Description
enable Optional[bool] False Enable frequency solver functionality in the solve step.
frequency_sweep HomogenizedConductorSolveFrequencyDomainSweep HomogenizedConductorSolveFrequencyDomainSweep()

Nested Models

HomogenizedConductorSolveFrequencyDomainSweep

Description: Level 4: Class for the frequency sweep definition within a frequency domain solver.

Field Type Default Description
run_sweep Optional[bool] False Enabling a frequency sweep.
start_frequency Optional[float] 1 Start frequency of the sweep in Hz.
end_frequency Optional[float] 100 End frequency of the sweep in Hz.
number_of_frequencies Optional[int] 3 Total number of frequencies in the sweep (logspaced)

HomogenizedConductorSolveFrequencyDomainSweep

Module: DataFiQuSHomogenizedConductor

Description: Level 4: Class for the frequency sweep definition within a frequency domain solver.

Fields

Field Type Default Description
run_sweep Optional[bool] False Enabling a frequency sweep.
start_frequency Optional[float] 1 Start frequency of the sweep in Hz.
end_frequency Optional[float] 100 End frequency of the sweep in Hz.
number_of_frequencies Optional[int] 3 Total number of frequencies in the sweep (logspaced)

HomogenizedConductorSolveGeneralparameters

Module: DataFiQuSHomogenizedConductor

Description: Level 3: Class for general parameters

Fields

Field Type Default Description
superconductor_linear Optional[bool] False For debugging: replace LTS by normal conductor.
noOfMPITasks Optional[bool | int] False 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.
rho_cables Optional[float] 1 Resistance for cables when modelled as linear conductors (no current sharing with power law) [Ohm*m].
strand_transposition_length Optional[float] 0.1 Transposition length of the strands in the Rutherford cable (m).
n_strands Optional[int] 36 Number of strands in the cable (-).
strand_filling_factor Optional[float] 0.8617 Filling factor of the strands in the rectangular cable envelope (-).

HomogenizedConductorSolveInitialconditions

Module: DataFiQuSHomogenizedConductor

Description: Level 3: Class for initial conditions

Fields

Field Type Default Description
init_from_pos_file bool False This field is used to initialize the solution from a non-zero field solution stored in a .pos file.
pos_file_to_init_from Optional[str] 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.

HomogenizedConductorSolveNumericalparameters

Module: DataFiQuSHomogenizedConductor

Description: Level 3: Class for numerical parameters

Fields

Field Type Default Description
sine HomogenizedConductorNumericalparametersSine HomogenizedConductorNumericalparametersSine()
piecewise HomogenizedConductorNumericalparametersPiecewise HomogenizedConductorNumericalparametersPiecewise()

Nested Models

HomogenizedConductorNumericalparametersPiecewise

Description: Level 4: Numerical parameters corresponding to the piecewise source

Field Type Default Description
time_to_simulate Optional[float] null Total time to simulate (s). Used for the piecewise source.
timesteps_per_time_to_simulate Optional[float] null If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.
force_stepping_at_times_piecewise_linear bool False 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).
variable_max_timestep bool False If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.
times_max_timestep_piecewise_linear Optional[list] null Time instants (s) defining the piecewise linear maximum time step.
max_timestep_piecewise_linear Optional[list] null Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.

HomogenizedConductorNumericalparametersSine

Description: Level 4: Numerical parameters corresponding to the sine source

Field Type Default Description
timesteps_per_period Optional[float] null Initial value for number of time steps (-) per period for the sine source. Determines the initial time step size.
number_of_periods_to_simulate Optional[float] null Number of periods (-) to simulate for the sine source.

HomogenizedConductorSolveSourceparameters

Module: DataFiQuSHomogenizedConductor

Description: Level 3: Class for material properties

Fields

Field Type Default Description
boundary_condition_type Literal[str] "Natural" Type of boundary condition applied at the outer domain boundary.

Available inputs: "Natural", "Essential"
source_type Literal[str] "sine" Time evolution of applied current and magnetic field. Supported options are: sine, sine_with_DC, piecewise_linear, from_list.

Available inputs: "sine", "piecewise"
parallel_resistor Optional[bool | float] False 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).
excitation_coils SolveExcitationCoils SolveExcitationCoils()
sine SolveSineSource SolveSineSource()
piecewise SolvePiecewiseSource SolvePiecewiseSource()
field_angle Optional[float] 90 Angle of the source magnetic field, with respect to the x-axis (degrees).
cable_current_multipliers Optional[list] 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.

Nested Models

SolveExcitationCoils

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

Field Type Default Description
enable Optional[bool] False Solve with excitation coils acting as sources.

SolvePiecewiseSource

Description: Level 4: Class for piecewise (linear) source parameters

Field Type Default Description
source_csv_file Optional[str] 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.
times Optional[list] null Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.
applied_fields_relative Optional[list] null Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'. Used only if source_csv_file is not set.
transport_currents_relative Optional[list] null Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.
time_multiplier Optional[float] null Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.
applied_field_multiplier Optional[float] null Multiplier for the applied fields in applied_fields_relative. Also used for the values in the source_csv_file.
transport_current_multiplier Optional[float] null Multiplier for the transport currents in transport_currents_relative. Also used for the values in the source_csv_file.

SolveSineSource

Description: Level 4: Class for Sine source parameters

Field Type Default Description
frequency Optional[float] null Frequency of the sine source (Hz).
field_amplitude Optional[float] null Amplitude of the sine field (T).
current_amplitude Optional[float] null Amplitude of the sine current (A).
superimposed_DC SolveSineSourceSuperimposedDC SolveSineSourceSuperimposedDC()

SolveSineSourceSuperimposedDC

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

Field Type Default Description
field_magnitude Optional[float] 0.0 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.
current_magnitude Optional[float] 0.0 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.

SolveExcitationCoils

Module: DataFiQuSHomogenizedConductor

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

Fields

Field Type Default Description
enable Optional[bool] False Solve with excitation coils acting as sources.

SolvePiecewiseSource

Module: DataFiQuSHomogenizedConductor

Description: Level 4: Class for piecewise (linear) source parameters

Fields

Field Type Default Description
source_csv_file Optional[str] 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.
times Optional[list] null Time instants (s) defining the piecewise linear sources. Used only if source_csv_file is not set. Can be scaled by time_multiplier.
applied_fields_relative Optional[list] null Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'. Used only if source_csv_file is not set.
transport_currents_relative Optional[list] null Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'. Used only if source_csv_file is not set.
time_multiplier Optional[float] null Multiplier for the time values in times (scales the time values). Also used for the time values in the source_csv_file.
applied_field_multiplier Optional[float] null Multiplier for the applied fields in applied_fields_relative. Also used for the values in the source_csv_file.
transport_current_multiplier Optional[float] null Multiplier for the transport currents in transport_currents_relative. Also used for the values in the source_csv_file.

SolveSineSource

Module: DataFiQuSHomogenizedConductor

Description: Level 4: Class for Sine source parameters

Fields

Field Type Default Description
frequency Optional[float] null Frequency of the sine source (Hz).
field_amplitude Optional[float] null Amplitude of the sine field (T).
current_amplitude Optional[float] null Amplitude of the sine current (A).
superimposed_DC SolveSineSourceSuperimposedDC SolveSineSourceSuperimposedDC()

Nested Models

SolveSineSourceSuperimposedDC

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

Field Type Default Description
field_magnitude Optional[float] 0.0 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.
current_magnitude Optional[float] 0.0 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.

SolveSineSourceSuperimposedDC

Module: DataFiQuSHomogenizedConductor

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

Fields

Field Type Default Description
field_magnitude Optional[float] 0.0 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.
current_magnitude Optional[float] 0.0 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.