DataFiQuSConductorAC_Rutherford

Auto-generated documentation for DataFiQuSConductorAC_Rutherford.

Classes

CACRutherford
CACRutherfordExcitationCoils
CACRutherfordGeometry
CACRutherfordIOsettings
CACRutherfordIOsettingsLoad
CACRutherfordIOsettingsSave
CACRutherfordMesh
CACRutherfordPostproc
CACRutherfordPostprocBatchpostproc
CACRutherfordPostprocBatchpostprocFilter
CACRutherfordPostprocBatchpostprocLossMap
CACRutherfordPostprocBatchpostprocLossMapCrossSection
CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep
CACRutherfordPostprocBatchpostprocPlot2d
CACRutherfordPostprocBatchpostprocSort
CACRutherfordPostprocCleanup
CACRutherfordPostprocPlotInstPower
CACRutherfordSolve
CACRutherfordSolveFormulationparameters
CACRutherfordSolveFrequencydomainsolver
CACRutherfordSolveFrequencydomainsolverFrequencysweep
CACRutherfordSolveGeneralparameters
CACRutherfordSolveInitialConditions
CACRutherfordSolveNumericalparameters
CACRutherfordSolveNumericalparametersPiecewise
CACRutherfordSolveNumericalparametersSine
CACRutherfordSolveSourceparameters
CACRutherfordSolveSourceparametersExcitationCoils
CACRutherfordSolveSourceparametersPiecewise
CACRutherfordSolveSourceparametersSine
CACRutherfordSolveSourceparametersSineSuperimposedDC

CACRutherford

Module: DataFiQuSConductorAC_Rutherford

Description: Level 1: Class for FiQuS ConductorAC

Fields

Field	Type	Default
`type`	`str`	Required
`geometry`	`CACRutherfordGeometry`	`CACRutherfordGeometry()`
`mesh`	`CACRutherfordMesh`	`CACRutherfordMesh()`
`solve`	`CACRutherfordSolve`	`CACRutherfordSolve()`
`postproc`	`CACRutherfordPostproc`	`CACRutherfordPostproc()`

Nested Models

CACRutherfordExcitationCoils

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

Field	Type	Default	Description
`centers`	`Optional[list]`	`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.
`widths`	`Optional[list]`	`null`	List of widths of the excitation coil regions.
`heights`	`Optional[list]`	`null`	List of heights of the excitation coil regions.

CACRutherfordGeometry

Description: Level 2: Class for cable geometry parameters

Field	Type	Default	Description
`io_settings`	`CACRutherfordIOsettings`	`CACRutherfordIOsettings()`
`point_snap_tolerance_relative_to_strand_diameter`	`Optional[float]`	`null`	The maximum distance between two points, relative to the strand diameter, where the points are considered equal (i.e. they 'snap' together).
`min_roundness_factor`	`Optional[float]`	`null`	Minimum roundness is the ratio between the min -and max radius for the corner circle-arcs.
`air_radius`	`Optional[float]`	`null`	Radius of the air region (m).
`coating_corner_arc_radius`	`Optional[float]`	`0`	Radius of the corner arcs of the coating (m).
`coating_thickness`	`Optional[float]`	`0`	Thickness of the coating (m).
`keep_strand_area`	`Optional[bool]`	`True`	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.
`excitation_coils`	`CACRutherfordExcitationCoils`	`CACRutherfordExcitationCoils()`

CACRutherfordIOsettings

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

Field	Type	Default	Description
`load`	`CACRutherfordIOsettingsLoad`	`CACRutherfordIOsettingsLoad()`
`save`	`CACRutherfordIOsettingsSave`	`CACRutherfordIOsettingsSave()`

CACRutherfordIOsettingsLoad

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

Field	Type	Default	Description
`load_from_yaml`	`Optional[bool]`	`null`	True to load cable geometry from yaml-file, false to create the geometry.
`filename`	`Optional[str]`	`null`	Name of the file from which to load the cable geometry.

CACRutherfordIOsettingsSave

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

Field	Type	Default	Description
`save_to_yaml`	`Optional[bool]`	`null`	True to save cable geometry to yaml-file, false to not save the geometry.
`filename`	`Optional[str]`	`null`	Name of the file to which to save the cable geometry.

CACRutherfordMesh

Description: Level 2: Class for FiQuS ConductorAC

Field	Type	Default	Description
`scaling_global`	`Optional[float]`	`1`	Global scaling factor for mesh size.
`strand_mesh_size_ratio`	`Optional[float]`	`1`	Mesh size ratio for the strand, relative to the strand diameter.
`coating_mesh_size_ratio`	`Optional[float]`	`1`	Mesh size ratio for the coating, relative to the strand diameter.
`air_boundary_mesh_size_ratio`	`Optional[float]`	`1`	Mesh size ratio for the air boundary, relative to the strand diameter.

CACRutherfordPostproc

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
`plot_instantaneous_power`	`CACRutherfordPostprocPlotInstPower`	`CACRutherfordPostprocPlotInstPower()`
`compute_current_per_filament`	`bool`	`False`	Computes current in every filament, with decomposition into magnetization and transport current.
`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`	`CACRutherfordPostprocCleanup`	`CACRutherfordPostprocCleanup()`
`batch_postproc`	`CACRutherfordPostprocBatchpostproc`	`CACRutherfordPostprocBatchpostproc()`

CACRutherfordPostprocBatchpostproc

Description: Level 3: Class for batch post-processing settings

Field	Type	Default	Description
`postProc_csv`	`Optional[str]`	`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.
`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.
`filter`	`CACRutherfordPostprocBatchpostprocFilter`	`CACRutherfordPostprocBatchpostprocFilter()`
`sort`	`CACRutherfordPostprocBatchpostprocSort`	`CACRutherfordPostprocBatchpostprocSort()`
`loss_map`	`CACRutherfordPostprocBatchpostprocLossMap`	`CACRutherfordPostprocBatchpostprocLossMap()`
`plot2d`	`CACRutherfordPostprocBatchpostprocPlot2d`	`CACRutherfordPostprocBatchpostprocPlot2d()`

CACRutherfordPostprocBatchpostprocFilter

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

Field	Type	Default	Description
`apply_filter`	`bool`	`False`	Set True to filter simulations by parameters from the input YAML-file.
`filter_criterion`	`Optional[str]`	`null`	Criterion used to filter simulations based on simulation parameters. For example will '<> > 100' disregard simulations done with frequencies lower than 100Hz.

CACRutherfordPostprocBatchpostprocLossMap

Description: Level 4: Class with settings for generating loss maps

Field	Type	Default	Description
`produce_loss_map`	`bool`	`False`	Set True to produce a loss map.
`save_plot`	`bool`	`False`	Set True to save the plot.
`filename`	`str`	`"loss_map"`	Name of the plot file.
`x_val`	`Optional[str]`	`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.
`y_val`	`Optional[str]`	`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.
`x_steps`	`int`	`20`	Number of steps on the x-axis.
`y_steps`	`int`	`20`	Number of steps on the y-axis.
`loss_type`	`Literal[str]`	`"TotalLoss"`	Type of loss to be plotted. Supported options are: TotalLoss, FilamentLoss, CouplingLoss, EddyLoss. Available inputs: "TotalLoss", "FilamentLoss", "CouplingLoss", "EddyLoss"
`x_log`	`bool`	`True`	Set True to plot x-axis in log-scale.
`y_log`	`bool`	`True`	Set True to plot y-axis in log-scale.
`loss_log`	`bool`	`True`	Set True to plot loss in log-scale.
`x_norm`	`float`	`1`	Normalization factor for x-axis.
`y_norm`	`float`	`1`	Normalization factor for y-axis.
`loss_norm`	`float`	`1`	Normalization factor for the AC-loss.
`show_datapoints`	`bool`	`True`	Set True to show markers for all the datapoints in the loss map.
`title`	`Optional[str]`	`null`	Title for the plot.
`xlabel`	`Optional[str]`	`null`	Label for the x-axis.
`ylabel`	`Optional[str]`	`null`	Label for the y-axis.
`show_loss_type_dominance_contour`	`bool`	`False`	Set True to plot a contour curve separating regions where different loss types dominate.
`cross_section`	`CACRutherfordPostprocBatchpostprocLossMapCrossSection`	`CACRutherfordPostprocBatchpostprocLossMapCrossSection()`
`cross_section_sweep`	`CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep`	`CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep()`

CACRutherfordPostprocBatchpostprocLossMapCrossSection

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

Field	Type	Default	Description
`plot_cross_section`	`bool`	`False`	Set True to plot a cross-section of the loss map.
`save_plot`	`bool`	`False`	Set True to save the plot.
`filename`	`str`	`"cross_section"`	Name of the plot file.
`axis_to_cut`	`str`	`"x"`	Axis to cut for the cross-section.
`cut_value`	`float`	`0`	Value of the axis to cut for the cross-section.
`ylabel`	`str`	`"Loss"`	Label of the y-axis.
`title`	`Optional[str]`	`null`	Title of the plot. The placeholder <> can be used to indicate the value of the cut axis.

CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep

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

Field	Type	Default	Description
`animate_cross_section_sweep`	`bool`	`False`	Set True to animate a cross-section sweep of the loss map along one axis.
`save_plot`	`bool`	`False`	Set True to save the animation.
`filename`	`str`	`"crossSectionSweep"`	Name of the animation file.
`axis_to_sweep`	`str`	`"x"`	Axis to sweep for the animation.
`ylabel`	`str`	`"Loss"`	Label of the y-axis.
`title`	`Optional[str]`	`null`	Title of the plot. Use <> to indicate the value of the sweep axis.

CACRutherfordPostprocBatchpostprocPlot2d

Description: Level 4: Class for 2D plot settings

Field	Type	Default	Description
`produce_plot2d`	`bool`	`False`	Set True to produce a 2D plot.
`combined_plot`	`bool`	`False`	Set True to produce a combined plot for all simulations. If False, a separate plot is produced for each simulation.
`save_plot`	`bool`	`False`	Set True to save the plot.
`filename`	`str`	`"plot2d"`	Name of the plot file.
`x_val`	`Optional[str]`	`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. '<>' will create a 2D plot with frequency on the x-axis. '<>' will create a plot with time on the x-axis.
`y_vals`	`Optional[list]`	`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 ['<>'].
`labels`	`Optional[list]`	`null`	List of labels for the plot. Each label corresponding to a value in y_val.
`linestyle`	`Optional[str]`	`null`	Linestyle for the plot.
`title`	`Optional[str]`	`null`	Title for the plot.
`xlabel`	`Optional[str]`	`null`	Label for the x-axis.
`ylabel`	`Optional[str]`	`null`	Label for the y-axis.
`x_log`	`bool`	`False`	Set True to plot x-axis in log-scale.
`y_log`	`bool`	`False`	Set True to plot y-axis in log-scale.
`legend`	`bool`	`True`	Set True to show legend.

CACRutherfordPostprocBatchpostprocSort

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

Field	Type	Default	Description
`apply_sort`	`bool`	`False`	Set True to sort simulations.
`sort_key`	`Optional[str]`	`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.

CACRutherfordPostprocCleanup

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.

CACRutherfordPostprocPlotInstPower

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

Field	Type	Default	Description
`show`	`bool`	`False`	Creates a plot for the calculated instantaneous AC loss (W/m) as a function of time (s).
`title`	`str`	`"Instantaneous Power"`	Title for the plot.
`save`	`bool`	`False`	Set True to save the plot.
`save_file_name`	`str`	`"instantaneous_power"`	Name of the plot file.

CACRutherfordSolve

Description: Level 2: Class for FiQuS ConductorAC

Field	Type	Default	Description
`pro_template`	`Optional[str]`	`null`	Name of the .pro template file.
`conductor_name`	`Optional[str]`	`null`	Name of the conductor.
`formulation_parameters`	`CACRutherfordSolveFormulationparameters`	`CACRutherfordSolveFormulationparameters()`
`general_parameters`	`CACRutherfordSolveGeneralparameters`	`CACRutherfordSolveGeneralparameters()`
`initial_conditions`	`CACRutherfordSolveInitialConditions`	`CACRutherfordSolveInitialConditions()`
`frequency_domain_solver`	`CACRutherfordSolveFrequencydomainsolver`	`CACRutherfordSolveFrequencydomainsolver()`
`source_parameters`	`CACRutherfordSolveSourceparameters`	`CACRutherfordSolveSourceparameters()`
`numerical_parameters`	`CACRutherfordSolveNumericalparameters`	`CACRutherfordSolveNumericalparameters()`

CACRutherfordSolveFormulationparameters

Description: Level 3: Class for finite element formulation parameters

Field	Type	Default	Description
`stranded_strands`	`bool`	`True`	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.
`rohm`	`bool`	`True`	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.
`rohf`	`bool`	`True`	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.

CACRutherfordSolveFrequencydomainsolver

Description: Level 3: Class for frequency domain solver settings

Field	Type	Default	Description
`enable`	`bool`	`False`	Set True to enable the frequency domain solver.
`frequency_sweep`	`CACRutherfordSolveFrequencydomainsolverFrequencysweep`	`CACRutherfordSolveFrequencydomainsolverFrequencysweep()`

CACRutherfordSolveFrequencydomainsolverFrequencysweep

Description: Level 4: Class for frequency sweep settings

Field	Type	Default	Description
`run_sweep`	`bool`	`False`	Set True to run a frequency sweep (logarithmic).
`start_frequency`	`float`	`1`	Start frequency (Hz) of the sweep.
`end_frequency`	`float`	`100`	End frequency (Hz) of the sweep.
`number_of_frequencies`	`int`	`10`	Number of frequencies in the sweep.

CACRutherfordSolveGeneralparameters

Description: Level 3: Class for general parameters

Field	Type	Default	Description
`temperature`	`float`	`1.9`	Temperature (K) of the strand.
`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).
`crossing_coupling_resistance`	`Optional[float]`	`1e-06`	Crossing coupling resistance (Ohm).
`adjacent_coupling_resistance`	`Optional[float]`	`1e-06`	Adjacent coupling resistance (Ohm).
`rho_coating`	`Optional[float]`	`1e-07`	Resistivity of coating domain outside of the strands (Ohm.m).
`rho_strands`	`Optional[float]`	`1e-12`	Resistivity of strands, when modelled as massive conductors (Ohm.m).
`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.

CACRutherfordSolveInitialConditions

Description: Level 3: Class for initial conditions

Field	Type	Default	Description
`init_from_pos_file`	`bool`	`False`	Do we initialize the solution at a non-zero field.
`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.

CACRutherfordSolveNumericalparameters

Description: Level 3: Class for numerical parameters

Field	Type	Default	Description
`sine`	`CACRutherfordSolveNumericalparametersSine`	`CACRutherfordSolveNumericalparametersSine()`
`piecewise`	`CACRutherfordSolveNumericalparametersPiecewise`	`CACRutherfordSolveNumericalparametersPiecewise()`

CACRutherfordSolveNumericalparametersPiecewise

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.

CACRutherfordSolveNumericalparametersSine

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.

CACRutherfordSolveSourceparameters

Description: Level 3: Class for material properties

Field	Type	Default	Description
`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.
`boundary_condition_type`	`str`	`"Natural"`	Boundary condition type. Supported options are: Natural, Essential. Do not use essential boundary condition with induced currents.
`sine`	`CACRutherfordSolveSourceparametersSine`	`CACRutherfordSolveSourceparametersSine()`
`piecewise`	`CACRutherfordSolveSourceparametersPiecewise`	`CACRutherfordSolveSourceparametersPiecewise()`
`excitation_coils`	`CACRutherfordSolveSourceparametersExcitationCoils`	`CACRutherfordSolveSourceparametersExcitationCoils()`

CACRutherfordSolveSourceparametersExcitationCoils

Description: Level 4: Class for excitation coils

Field	Type	Default	Description
`enable`	`Optional[bool]`	`False`	Are the excitation coils used in the model? (they can exist in the geometry and mesh but be ignored at the solution stage)
`source_csv_file`	`Optional[str]`	`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).

CACRutherfordSolveSourceparametersPiecewise

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.
`field_angle`	`Optional[float]`	`90`	Angle of the sine field direction, with respect to the x-axis (degrees).

CACRutherfordSolveSourceparametersSine

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).
`field_angle`	`Optional[float]`	`90`	Angle of the sine field direction, with respect to the x-axis (degrees).
`superimposed_DC`	`CACRutherfordSolveSourceparametersSineSuperimposedDC`	`CACRutherfordSolveSourceparametersSineSuperimposedDC()`

CACRutherfordSolveSourceparametersSineSuperimposedDC

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.

CACRutherfordExcitationCoils

Module: DataFiQuSConductorAC_Rutherford

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

Fields

Field	Type	Default	Description
`centers`	`Optional[list]`	`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.
`widths`	`Optional[list]`	`null`	List of widths of the excitation coil regions.
`heights`	`Optional[list]`	`null`	List of heights of the excitation coil regions.

CACRutherfordGeometry

Module: DataFiQuSConductorAC_Rutherford

Description: Level 2: Class for cable geometry parameters

Fields

Field	Type	Default	Description
`io_settings`	`CACRutherfordIOsettings`	`CACRutherfordIOsettings()`
`point_snap_tolerance_relative_to_strand_diameter`	`Optional[float]`	`null`	The maximum distance between two points, relative to the strand diameter, where the points are considered equal (i.e. they 'snap' together).
`min_roundness_factor`	`Optional[float]`	`null`	Minimum roundness is the ratio between the min -and max radius for the corner circle-arcs.
`air_radius`	`Optional[float]`	`null`	Radius of the air region (m).
`coating_corner_arc_radius`	`Optional[float]`	`0`	Radius of the corner arcs of the coating (m).
`coating_thickness`	`Optional[float]`	`0`	Thickness of the coating (m).
`keep_strand_area`	`Optional[bool]`	`True`	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.
`excitation_coils`	`CACRutherfordExcitationCoils`	`CACRutherfordExcitationCoils()`

Nested Models

CACRutherfordExcitationCoils

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

Field	Type	Default	Description
`centers`	`Optional[list]`	`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.
`widths`	`Optional[list]`	`null`	List of widths of the excitation coil regions.
`heights`	`Optional[list]`	`null`	List of heights of the excitation coil regions.

CACRutherfordIOsettings

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

Field	Type	Default	Description
`load`	`CACRutherfordIOsettingsLoad`	`CACRutherfordIOsettingsLoad()`
`save`	`CACRutherfordIOsettingsSave`	`CACRutherfordIOsettingsSave()`

CACRutherfordIOsettingsLoad

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

Field	Type	Default	Description
`load_from_yaml`	`Optional[bool]`	`null`	True to load cable geometry from yaml-file, false to create the geometry.
`filename`	`Optional[str]`	`null`	Name of the file from which to load the cable geometry.

CACRutherfordIOsettingsSave

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

Field	Type	Default	Description
`save_to_yaml`	`Optional[bool]`	`null`	True to save cable geometry to yaml-file, false to not save the geometry.
`filename`	`Optional[str]`	`null`	Name of the file to which to save the cable geometry.

CACRutherfordIOsettings

Module: DataFiQuSConductorAC_Rutherford

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

Fields

Field	Type	Default	Description
`load`	`CACRutherfordIOsettingsLoad`	`CACRutherfordIOsettingsLoad()`
`save`	`CACRutherfordIOsettingsSave`	`CACRutherfordIOsettingsSave()`

Nested Models

CACRutherfordIOsettingsLoad

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

Field	Type	Default	Description
`load_from_yaml`	`Optional[bool]`	`null`	True to load cable geometry from yaml-file, false to create the geometry.
`filename`	`Optional[str]`	`null`	Name of the file from which to load the cable geometry.

CACRutherfordIOsettingsSave

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

Field	Type	Default	Description
`save_to_yaml`	`Optional[bool]`	`null`	True to save cable geometry to yaml-file, false to not save the geometry.
`filename`	`Optional[str]`	`null`	Name of the file to which to save the cable geometry.

CACRutherfordIOsettingsLoad

Module: DataFiQuSConductorAC_Rutherford

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

Fields

Field	Type	Default	Description
`load_from_yaml`	`Optional[bool]`	`null`	True to load cable geometry from yaml-file, false to create the geometry.
`filename`	`Optional[str]`	`null`	Name of the file from which to load the cable geometry.

CACRutherfordIOsettingsSave

Module: DataFiQuSConductorAC_Rutherford

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

Fields

Field	Type	Default	Description
`save_to_yaml`	`Optional[bool]`	`null`	True to save cable geometry to yaml-file, false to not save the geometry.
`filename`	`Optional[str]`	`null`	Name of the file to which to save the cable geometry.

CACRutherfordMesh

Module: DataFiQuSConductorAC_Rutherford

Description: Level 2: Class for FiQuS ConductorAC

Fields

Field	Type	Default	Description
`scaling_global`	`Optional[float]`	`1`	Global scaling factor for mesh size.
`strand_mesh_size_ratio`	`Optional[float]`	`1`	Mesh size ratio for the strand, relative to the strand diameter.
`coating_mesh_size_ratio`	`Optional[float]`	`1`	Mesh size ratio for the coating, relative to the strand diameter.
`air_boundary_mesh_size_ratio`	`Optional[float]`	`1`	Mesh size ratio for the air boundary, relative to the strand diameter.

CACRutherfordPostproc

Module: DataFiQuSConductorAC_Rutherford

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
`plot_instantaneous_power`	`CACRutherfordPostprocPlotInstPower`	`CACRutherfordPostprocPlotInstPower()`
`compute_current_per_filament`	`bool`	`False`	Computes current in every filament, with decomposition into magnetization and transport current.
`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`	`CACRutherfordPostprocCleanup`	`CACRutherfordPostprocCleanup()`
`batch_postproc`	`CACRutherfordPostprocBatchpostproc`	`CACRutherfordPostprocBatchpostproc()`

Nested Models

CACRutherfordPostprocBatchpostproc

Description: Level 3: Class for batch post-processing settings

Field	Type	Default	Description
`postProc_csv`	`Optional[str]`	`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.
`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.
`filter`	`CACRutherfordPostprocBatchpostprocFilter`	`CACRutherfordPostprocBatchpostprocFilter()`
`sort`	`CACRutherfordPostprocBatchpostprocSort`	`CACRutherfordPostprocBatchpostprocSort()`
`loss_map`	`CACRutherfordPostprocBatchpostprocLossMap`	`CACRutherfordPostprocBatchpostprocLossMap()`
`plot2d`	`CACRutherfordPostprocBatchpostprocPlot2d`	`CACRutherfordPostprocBatchpostprocPlot2d()`

CACRutherfordPostprocBatchpostprocFilter

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

Field	Type	Default	Description
`apply_filter`	`bool`	`False`	Set True to filter simulations by parameters from the input YAML-file.
`filter_criterion`	`Optional[str]`	`null`	Criterion used to filter simulations based on simulation parameters. For example will '<> > 100' disregard simulations done with frequencies lower than 100Hz.

CACRutherfordPostprocBatchpostprocLossMap

Description: Level 4: Class with settings for generating loss maps

Field	Type	Default	Description
`produce_loss_map`	`bool`	`False`	Set True to produce a loss map.
`save_plot`	`bool`	`False`	Set True to save the plot.
`filename`	`str`	`"loss_map"`	Name of the plot file.
`x_val`	`Optional[str]`	`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.
`y_val`	`Optional[str]`	`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.
`x_steps`	`int`	`20`	Number of steps on the x-axis.
`y_steps`	`int`	`20`	Number of steps on the y-axis.
`loss_type`	`Literal[str]`	`"TotalLoss"`	Type of loss to be plotted. Supported options are: TotalLoss, FilamentLoss, CouplingLoss, EddyLoss. Available inputs: "TotalLoss", "FilamentLoss", "CouplingLoss", "EddyLoss"
`x_log`	`bool`	`True`	Set True to plot x-axis in log-scale.
`y_log`	`bool`	`True`	Set True to plot y-axis in log-scale.
`loss_log`	`bool`	`True`	Set True to plot loss in log-scale.
`x_norm`	`float`	`1`	Normalization factor for x-axis.
`y_norm`	`float`	`1`	Normalization factor for y-axis.
`loss_norm`	`float`	`1`	Normalization factor for the AC-loss.
`show_datapoints`	`bool`	`True`	Set True to show markers for all the datapoints in the loss map.
`title`	`Optional[str]`	`null`	Title for the plot.
`xlabel`	`Optional[str]`	`null`	Label for the x-axis.
`ylabel`	`Optional[str]`	`null`	Label for the y-axis.
`show_loss_type_dominance_contour`	`bool`	`False`	Set True to plot a contour curve separating regions where different loss types dominate.
`cross_section`	`CACRutherfordPostprocBatchpostprocLossMapCrossSection`	`CACRutherfordPostprocBatchpostprocLossMapCrossSection()`
`cross_section_sweep`	`CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep`	`CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep()`

CACRutherfordPostprocBatchpostprocLossMapCrossSection

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

Field	Type	Default	Description
`plot_cross_section`	`bool`	`False`	Set True to plot a cross-section of the loss map.
`save_plot`	`bool`	`False`	Set True to save the plot.
`filename`	`str`	`"cross_section"`	Name of the plot file.
`axis_to_cut`	`str`	`"x"`	Axis to cut for the cross-section.
`cut_value`	`float`	`0`	Value of the axis to cut for the cross-section.
`ylabel`	`str`	`"Loss"`	Label of the y-axis.
`title`	`Optional[str]`	`null`	Title of the plot. The placeholder <> can be used to indicate the value of the cut axis.

CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep

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

Field	Type	Default	Description
`animate_cross_section_sweep`	`bool`	`False`	Set True to animate a cross-section sweep of the loss map along one axis.
`save_plot`	`bool`	`False`	Set True to save the animation.
`filename`	`str`	`"crossSectionSweep"`	Name of the animation file.
`axis_to_sweep`	`str`	`"x"`	Axis to sweep for the animation.
`ylabel`	`str`	`"Loss"`	Label of the y-axis.
`title`	`Optional[str]`	`null`	Title of the plot. Use <> to indicate the value of the sweep axis.

CACRutherfordPostprocBatchpostprocPlot2d

Description: Level 4: Class for 2D plot settings

Field	Type	Default	Description
`produce_plot2d`	`bool`	`False`	Set True to produce a 2D plot.
`combined_plot`	`bool`	`False`	Set True to produce a combined plot for all simulations. If False, a separate plot is produced for each simulation.
`save_plot`	`bool`	`False`	Set True to save the plot.
`filename`	`str`	`"plot2d"`	Name of the plot file.
`x_val`	`Optional[str]`	`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. '<>' will create a 2D plot with frequency on the x-axis. '<>' will create a plot with time on the x-axis.
`y_vals`	`Optional[list]`	`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 ['<>'].
`labels`	`Optional[list]`	`null`	List of labels for the plot. Each label corresponding to a value in y_val.
`linestyle`	`Optional[str]`	`null`	Linestyle for the plot.
`title`	`Optional[str]`	`null`	Title for the plot.
`xlabel`	`Optional[str]`	`null`	Label for the x-axis.
`ylabel`	`Optional[str]`	`null`	Label for the y-axis.
`x_log`	`bool`	`False`	Set True to plot x-axis in log-scale.
`y_log`	`bool`	`False`	Set True to plot y-axis in log-scale.
`legend`	`bool`	`True`	Set True to show legend.

CACRutherfordPostprocBatchpostprocSort

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

Field	Type	Default	Description
`apply_sort`	`bool`	`False`	Set True to sort simulations.
`sort_key`	`Optional[str]`	`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.

CACRutherfordPostprocCleanup

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.

CACRutherfordPostprocPlotInstPower

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

Field	Type	Default	Description
`show`	`bool`	`False`	Creates a plot for the calculated instantaneous AC loss (W/m) as a function of time (s).
`title`	`str`	`"Instantaneous Power"`	Title for the plot.
`save`	`bool`	`False`	Set True to save the plot.
`save_file_name`	`str`	`"instantaneous_power"`	Name of the plot file.

CACRutherfordPostprocBatchpostproc

Module: DataFiQuSConductorAC_Rutherford

Description: Level 3: Class for batch post-processing settings

Fields

Field	Type	Default	Description
`postProc_csv`	`Optional[str]`	`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.
`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.
`filter`	`CACRutherfordPostprocBatchpostprocFilter`	`CACRutherfordPostprocBatchpostprocFilter()`
`sort`	`CACRutherfordPostprocBatchpostprocSort`	`CACRutherfordPostprocBatchpostprocSort()`
`loss_map`	`CACRutherfordPostprocBatchpostprocLossMap`	`CACRutherfordPostprocBatchpostprocLossMap()`
`plot2d`	`CACRutherfordPostprocBatchpostprocPlot2d`	`CACRutherfordPostprocBatchpostprocPlot2d()`

Nested Models

CACRutherfordPostprocBatchpostprocFilter

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

Field	Type	Default	Description
`apply_filter`	`bool`	`False`	Set True to filter simulations by parameters from the input YAML-file.
`filter_criterion`	`Optional[str]`	`null`	Criterion used to filter simulations based on simulation parameters. For example will '<> > 100' disregard simulations done with frequencies lower than 100Hz.

CACRutherfordPostprocBatchpostprocLossMap

Description: Level 4: Class with settings for generating loss maps

Field	Type	Default	Description
`produce_loss_map`	`bool`	`False`	Set True to produce a loss map.
`save_plot`	`bool`	`False`	Set True to save the plot.
`filename`	`str`	`"loss_map"`	Name of the plot file.
`x_val`	`Optional[str]`	`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.
`y_val`	`Optional[str]`	`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.
`x_steps`	`int`	`20`	Number of steps on the x-axis.
`y_steps`	`int`	`20`	Number of steps on the y-axis.
`loss_type`	`Literal[str]`	`"TotalLoss"`	Type of loss to be plotted. Supported options are: TotalLoss, FilamentLoss, CouplingLoss, EddyLoss. Available inputs: "TotalLoss", "FilamentLoss", "CouplingLoss", "EddyLoss"
`x_log`	`bool`	`True`	Set True to plot x-axis in log-scale.
`y_log`	`bool`	`True`	Set True to plot y-axis in log-scale.
`loss_log`	`bool`	`True`	Set True to plot loss in log-scale.
`x_norm`	`float`	`1`	Normalization factor for x-axis.
`y_norm`	`float`	`1`	Normalization factor for y-axis.
`loss_norm`	`float`	`1`	Normalization factor for the AC-loss.
`show_datapoints`	`bool`	`True`	Set True to show markers for all the datapoints in the loss map.
`title`	`Optional[str]`	`null`	Title for the plot.
`xlabel`	`Optional[str]`	`null`	Label for the x-axis.
`ylabel`	`Optional[str]`	`null`	Label for the y-axis.
`show_loss_type_dominance_contour`	`bool`	`False`	Set True to plot a contour curve separating regions where different loss types dominate.
`cross_section`	`CACRutherfordPostprocBatchpostprocLossMapCrossSection`	`CACRutherfordPostprocBatchpostprocLossMapCrossSection()`
`cross_section_sweep`	`CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep`	`CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep()`

CACRutherfordPostprocBatchpostprocLossMapCrossSection

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

Field	Type	Default	Description
`plot_cross_section`	`bool`	`False`	Set True to plot a cross-section of the loss map.
`save_plot`	`bool`	`False`	Set True to save the plot.
`filename`	`str`	`"cross_section"`	Name of the plot file.
`axis_to_cut`	`str`	`"x"`	Axis to cut for the cross-section.
`cut_value`	`float`	`0`	Value of the axis to cut for the cross-section.
`ylabel`	`str`	`"Loss"`	Label of the y-axis.
`title`	`Optional[str]`	`null`	Title of the plot. The placeholder <> can be used to indicate the value of the cut axis.

CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep

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

Field	Type	Default	Description
`animate_cross_section_sweep`	`bool`	`False`	Set True to animate a cross-section sweep of the loss map along one axis.
`save_plot`	`bool`	`False`	Set True to save the animation.
`filename`	`str`	`"crossSectionSweep"`	Name of the animation file.
`axis_to_sweep`	`str`	`"x"`	Axis to sweep for the animation.
`ylabel`	`str`	`"Loss"`	Label of the y-axis.
`title`	`Optional[str]`	`null`	Title of the plot. Use <> to indicate the value of the sweep axis.

CACRutherfordPostprocBatchpostprocPlot2d

Description: Level 4: Class for 2D plot settings

Field	Type	Default	Description
`produce_plot2d`	`bool`	`False`	Set True to produce a 2D plot.
`combined_plot`	`bool`	`False`	Set True to produce a combined plot for all simulations. If False, a separate plot is produced for each simulation.
`save_plot`	`bool`	`False`	Set True to save the plot.
`filename`	`str`	`"plot2d"`	Name of the plot file.
`x_val`	`Optional[str]`	`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. '<>' will create a 2D plot with frequency on the x-axis. '<>' will create a plot with time on the x-axis.
`y_vals`	`Optional[list]`	`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 ['<>'].
`labels`	`Optional[list]`	`null`	List of labels for the plot. Each label corresponding to a value in y_val.
`linestyle`	`Optional[str]`	`null`	Linestyle for the plot.
`title`	`Optional[str]`	`null`	Title for the plot.
`xlabel`	`Optional[str]`	`null`	Label for the x-axis.
`ylabel`	`Optional[str]`	`null`	Label for the y-axis.
`x_log`	`bool`	`False`	Set True to plot x-axis in log-scale.
`y_log`	`bool`	`False`	Set True to plot y-axis in log-scale.
`legend`	`bool`	`True`	Set True to show legend.

CACRutherfordPostprocBatchpostprocSort

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

Field	Type	Default	Description
`apply_sort`	`bool`	`False`	Set True to sort simulations.
`sort_key`	`Optional[str]`	`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.

CACRutherfordPostprocBatchpostprocFilter

Module: DataFiQuSConductorAC_Rutherford

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

Fields

Field	Type	Default	Description
`apply_filter`	`bool`	`False`	Set True to filter simulations by parameters from the input YAML-file.
`filter_criterion`	`Optional[str]`	`null`	Criterion used to filter simulations based on simulation parameters. For example will '<> > 100' disregard simulations done with frequencies lower than 100Hz.

CACRutherfordPostprocBatchpostprocLossMap

Module: DataFiQuSConductorAC_Rutherford

Description: Level 4: Class with settings for generating loss maps

Fields

Field	Type	Default	Description
`produce_loss_map`	`bool`	`False`	Set True to produce a loss map.
`save_plot`	`bool`	`False`	Set True to save the plot.
`filename`	`str`	`"loss_map"`	Name of the plot file.
`x_val`	`Optional[str]`	`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.
`y_val`	`Optional[str]`	`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.
`x_steps`	`int`	`20`	Number of steps on the x-axis.
`y_steps`	`int`	`20`	Number of steps on the y-axis.
`loss_type`	`Literal[str]`	`"TotalLoss"`	Type of loss to be plotted. Supported options are: TotalLoss, FilamentLoss, CouplingLoss, EddyLoss. Available inputs: "TotalLoss", "FilamentLoss", "CouplingLoss", "EddyLoss"
`x_log`	`bool`	`True`	Set True to plot x-axis in log-scale.
`y_log`	`bool`	`True`	Set True to plot y-axis in log-scale.
`loss_log`	`bool`	`True`	Set True to plot loss in log-scale.
`x_norm`	`float`	`1`	Normalization factor for x-axis.
`y_norm`	`float`	`1`	Normalization factor for y-axis.
`loss_norm`	`float`	`1`	Normalization factor for the AC-loss.
`show_datapoints`	`bool`	`True`	Set True to show markers for all the datapoints in the loss map.
`title`	`Optional[str]`	`null`	Title for the plot.
`xlabel`	`Optional[str]`	`null`	Label for the x-axis.
`ylabel`	`Optional[str]`	`null`	Label for the y-axis.
`show_loss_type_dominance_contour`	`bool`	`False`	Set True to plot a contour curve separating regions where different loss types dominate.
`cross_section`	`CACRutherfordPostprocBatchpostprocLossMapCrossSection`	`CACRutherfordPostprocBatchpostprocLossMapCrossSection()`
`cross_section_sweep`	`CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep`	`CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep()`

Nested Models

CACRutherfordPostprocBatchpostprocLossMapCrossSection

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

Field	Type	Default	Description
`plot_cross_section`	`bool`	`False`	Set True to plot a cross-section of the loss map.
`save_plot`	`bool`	`False`	Set True to save the plot.
`filename`	`str`	`"cross_section"`	Name of the plot file.
`axis_to_cut`	`str`	`"x"`	Axis to cut for the cross-section.
`cut_value`	`float`	`0`	Value of the axis to cut for the cross-section.
`ylabel`	`str`	`"Loss"`	Label of the y-axis.
`title`	`Optional[str]`	`null`	Title of the plot. The placeholder <> can be used to indicate the value of the cut axis.

CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep

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

Field	Type	Default	Description
`animate_cross_section_sweep`	`bool`	`False`	Set True to animate a cross-section sweep of the loss map along one axis.
`save_plot`	`bool`	`False`	Set True to save the animation.
`filename`	`str`	`"crossSectionSweep"`	Name of the animation file.
`axis_to_sweep`	`str`	`"x"`	Axis to sweep for the animation.
`ylabel`	`str`	`"Loss"`	Label of the y-axis.
`title`	`Optional[str]`	`null`	Title of the plot. Use <> to indicate the value of the sweep axis.

CACRutherfordPostprocBatchpostprocLossMapCrossSection

Module: DataFiQuSConductorAC_Rutherford

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

Fields

Field	Type	Default	Description
`plot_cross_section`	`bool`	`False`	Set True to plot a cross-section of the loss map.
`save_plot`	`bool`	`False`	Set True to save the plot.
`filename`	`str`	`"cross_section"`	Name of the plot file.
`axis_to_cut`	`str`	`"x"`	Axis to cut for the cross-section.
`cut_value`	`float`	`0`	Value of the axis to cut for the cross-section.
`ylabel`	`str`	`"Loss"`	Label of the y-axis.
`title`	`Optional[str]`	`null`	Title of the plot. The placeholder <> can be used to indicate the value of the cut axis.

CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep

Module: DataFiQuSConductorAC_Rutherford

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

Fields

Field	Type	Default	Description
`animate_cross_section_sweep`	`bool`	`False`	Set True to animate a cross-section sweep of the loss map along one axis.
`save_plot`	`bool`	`False`	Set True to save the animation.
`filename`	`str`	`"crossSectionSweep"`	Name of the animation file.
`axis_to_sweep`	`str`	`"x"`	Axis to sweep for the animation.
`ylabel`	`str`	`"Loss"`	Label of the y-axis.
`title`	`Optional[str]`	`null`	Title of the plot. Use <> to indicate the value of the sweep axis.

CACRutherfordPostprocBatchpostprocPlot2d

Module: DataFiQuSConductorAC_Rutherford

Description: Level 4: Class for 2D plot settings

Fields

Field	Type	Default	Description
`produce_plot2d`	`bool`	`False`	Set True to produce a 2D plot.
`combined_plot`	`bool`	`False`	Set True to produce a combined plot for all simulations. If False, a separate plot is produced for each simulation.
`save_plot`	`bool`	`False`	Set True to save the plot.
`filename`	`str`	`"plot2d"`	Name of the plot file.
`x_val`	`Optional[str]`	`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. '<>' will create a 2D plot with frequency on the x-axis. '<>' will create a plot with time on the x-axis.
`y_vals`	`Optional[list]`	`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 ['<>'].
`labels`	`Optional[list]`	`null`	List of labels for the plot. Each label corresponding to a value in y_val.
`linestyle`	`Optional[str]`	`null`	Linestyle for the plot.
`title`	`Optional[str]`	`null`	Title for the plot.
`xlabel`	`Optional[str]`	`null`	Label for the x-axis.
`ylabel`	`Optional[str]`	`null`	Label for the y-axis.
`x_log`	`bool`	`False`	Set True to plot x-axis in log-scale.
`y_log`	`bool`	`False`	Set True to plot y-axis in log-scale.
`legend`	`bool`	`True`	Set True to show legend.

CACRutherfordPostprocBatchpostprocSort

Module: DataFiQuSConductorAC_Rutherford

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

Fields

Field	Type	Default	Description
`apply_sort`	`bool`	`False`	Set True to sort simulations.
`sort_key`	`Optional[str]`	`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.

CACRutherfordPostprocCleanup

Module: DataFiQuSConductorAC_Rutherford

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.

CACRutherfordPostprocPlotInstPower

Module: DataFiQuSConductorAC_Rutherford

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

Fields

Field	Type	Default	Description
`show`	`bool`	`False`	Creates a plot for the calculated instantaneous AC loss (W/m) as a function of time (s).
`title`	`str`	`"Instantaneous Power"`	Title for the plot.
`save`	`bool`	`False`	Set True to save the plot.
`save_file_name`	`str`	`"instantaneous_power"`	Name of the plot file.

CACRutherfordSolve

Module: DataFiQuSConductorAC_Rutherford

Description: Level 2: Class for FiQuS ConductorAC

Fields

Field	Type	Default	Description
`pro_template`	`Optional[str]`	`null`	Name of the .pro template file.
`conductor_name`	`Optional[str]`	`null`	Name of the conductor.
`formulation_parameters`	`CACRutherfordSolveFormulationparameters`	`CACRutherfordSolveFormulationparameters()`
`general_parameters`	`CACRutherfordSolveGeneralparameters`	`CACRutherfordSolveGeneralparameters()`
`initial_conditions`	`CACRutherfordSolveInitialConditions`	`CACRutherfordSolveInitialConditions()`
`frequency_domain_solver`	`CACRutherfordSolveFrequencydomainsolver`	`CACRutherfordSolveFrequencydomainsolver()`
`source_parameters`	`CACRutherfordSolveSourceparameters`	`CACRutherfordSolveSourceparameters()`
`numerical_parameters`	`CACRutherfordSolveNumericalparameters`	`CACRutherfordSolveNumericalparameters()`

Nested Models

CACRutherfordSolveFormulationparameters

Description: Level 3: Class for finite element formulation parameters

Field	Type	Default	Description
`stranded_strands`	`bool`	`True`	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.
`rohm`	`bool`	`True`	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.
`rohf`	`bool`	`True`	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.

CACRutherfordSolveFrequencydomainsolver

Description: Level 3: Class for frequency domain solver settings

Field	Type	Default	Description
`enable`	`bool`	`False`	Set True to enable the frequency domain solver.
`frequency_sweep`	`CACRutherfordSolveFrequencydomainsolverFrequencysweep`	`CACRutherfordSolveFrequencydomainsolverFrequencysweep()`

CACRutherfordSolveFrequencydomainsolverFrequencysweep

Description: Level 4: Class for frequency sweep settings

Field	Type	Default	Description
`run_sweep`	`bool`	`False`	Set True to run a frequency sweep (logarithmic).
`start_frequency`	`float`	`1`	Start frequency (Hz) of the sweep.
`end_frequency`	`float`	`100`	End frequency (Hz) of the sweep.
`number_of_frequencies`	`int`	`10`	Number of frequencies in the sweep.

CACRutherfordSolveGeneralparameters

Description: Level 3: Class for general parameters

Field	Type	Default	Description
`temperature`	`float`	`1.9`	Temperature (K) of the strand.
`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).
`crossing_coupling_resistance`	`Optional[float]`	`1e-06`	Crossing coupling resistance (Ohm).
`adjacent_coupling_resistance`	`Optional[float]`	`1e-06`	Adjacent coupling resistance (Ohm).
`rho_coating`	`Optional[float]`	`1e-07`	Resistivity of coating domain outside of the strands (Ohm.m).
`rho_strands`	`Optional[float]`	`1e-12`	Resistivity of strands, when modelled as massive conductors (Ohm.m).
`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.

CACRutherfordSolveInitialConditions

Description: Level 3: Class for initial conditions

Field	Type	Default	Description
`init_from_pos_file`	`bool`	`False`	Do we initialize the solution at a non-zero field.
`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.

CACRutherfordSolveNumericalparameters

Description: Level 3: Class for numerical parameters

Field	Type	Default	Description
`sine`	`CACRutherfordSolveNumericalparametersSine`	`CACRutherfordSolveNumericalparametersSine()`
`piecewise`	`CACRutherfordSolveNumericalparametersPiecewise`	`CACRutherfordSolveNumericalparametersPiecewise()`

CACRutherfordSolveNumericalparametersPiecewise

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.

CACRutherfordSolveNumericalparametersSine

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.

CACRutherfordSolveSourceparameters

Description: Level 3: Class for material properties

Field	Type	Default	Description
`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.
`boundary_condition_type`	`str`	`"Natural"`	Boundary condition type. Supported options are: Natural, Essential. Do not use essential boundary condition with induced currents.
`sine`	`CACRutherfordSolveSourceparametersSine`	`CACRutherfordSolveSourceparametersSine()`
`piecewise`	`CACRutherfordSolveSourceparametersPiecewise`	`CACRutherfordSolveSourceparametersPiecewise()`
`excitation_coils`	`CACRutherfordSolveSourceparametersExcitationCoils`	`CACRutherfordSolveSourceparametersExcitationCoils()`

CACRutherfordSolveSourceparametersExcitationCoils

Description: Level 4: Class for excitation coils

Field	Type	Default	Description
`enable`	`Optional[bool]`	`False`	Are the excitation coils used in the model? (they can exist in the geometry and mesh but be ignored at the solution stage)
`source_csv_file`	`Optional[str]`	`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).

CACRutherfordSolveSourceparametersPiecewise

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.
`field_angle`	`Optional[float]`	`90`	Angle of the sine field direction, with respect to the x-axis (degrees).

CACRutherfordSolveSourceparametersSine

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).
`field_angle`	`Optional[float]`	`90`	Angle of the sine field direction, with respect to the x-axis (degrees).
`superimposed_DC`	`CACRutherfordSolveSourceparametersSineSuperimposedDC`	`CACRutherfordSolveSourceparametersSineSuperimposedDC()`

CACRutherfordSolveSourceparametersSineSuperimposedDC

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.

CACRutherfordSolveFormulationparameters

Module: DataFiQuSConductorAC_Rutherford

Description: Level 3: Class for finite element formulation parameters

Fields

Field	Type	Default	Description
`stranded_strands`	`bool`	`True`	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.
`rohm`	`bool`	`True`	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.
`rohf`	`bool`	`True`	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.

CACRutherfordSolveFrequencydomainsolver

Module: DataFiQuSConductorAC_Rutherford

Description: Level 3: Class for frequency domain solver settings

Fields

Field	Type	Default	Description
`enable`	`bool`	`False`	Set True to enable the frequency domain solver.
`frequency_sweep`	`CACRutherfordSolveFrequencydomainsolverFrequencysweep`	`CACRutherfordSolveFrequencydomainsolverFrequencysweep()`

Nested Models

CACRutherfordSolveFrequencydomainsolverFrequencysweep

Description: Level 4: Class for frequency sweep settings

Field	Type	Default	Description
`run_sweep`	`bool`	`False`	Set True to run a frequency sweep (logarithmic).
`start_frequency`	`float`	`1`	Start frequency (Hz) of the sweep.
`end_frequency`	`float`	`100`	End frequency (Hz) of the sweep.
`number_of_frequencies`	`int`	`10`	Number of frequencies in the sweep.

CACRutherfordSolveFrequencydomainsolverFrequencysweep

Module: DataFiQuSConductorAC_Rutherford

Description: Level 4: Class for frequency sweep settings

Fields

Field	Type	Default	Description
`run_sweep`	`bool`	`False`	Set True to run a frequency sweep (logarithmic).
`start_frequency`	`float`	`1`	Start frequency (Hz) of the sweep.
`end_frequency`	`float`	`100`	End frequency (Hz) of the sweep.
`number_of_frequencies`	`int`	`10`	Number of frequencies in the sweep.

CACRutherfordSolveGeneralparameters

Module: DataFiQuSConductorAC_Rutherford

Description: Level 3: Class for general parameters

Fields

Field	Type	Default	Description
`temperature`	`float`	`1.9`	Temperature (K) of the strand.
`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).
`crossing_coupling_resistance`	`Optional[float]`	`1e-06`	Crossing coupling resistance (Ohm).
`adjacent_coupling_resistance`	`Optional[float]`	`1e-06`	Adjacent coupling resistance (Ohm).
`rho_coating`	`Optional[float]`	`1e-07`	Resistivity of coating domain outside of the strands (Ohm.m).
`rho_strands`	`Optional[float]`	`1e-12`	Resistivity of strands, when modelled as massive conductors (Ohm.m).
`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.

CACRutherfordSolveInitialConditions

Module: DataFiQuSConductorAC_Rutherford

Description: Level 3: Class for initial conditions

Fields

Field	Type	Default	Description
`init_from_pos_file`	`bool`	`False`	Do we initialize the solution at a non-zero field.
`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.

CACRutherfordSolveNumericalparameters

Module: DataFiQuSConductorAC_Rutherford

Description: Level 3: Class for numerical parameters

Fields

Field	Type	Default	Description
`sine`	`CACRutherfordSolveNumericalparametersSine`	`CACRutherfordSolveNumericalparametersSine()`
`piecewise`	`CACRutherfordSolveNumericalparametersPiecewise`	`CACRutherfordSolveNumericalparametersPiecewise()`

Nested Models

CACRutherfordSolveNumericalparametersPiecewise

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.

CACRutherfordSolveNumericalparametersSine

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.

CACRutherfordSolveNumericalparametersPiecewise

Module: DataFiQuSConductorAC_Rutherford

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.

CACRutherfordSolveNumericalparametersSine

Module: DataFiQuSConductorAC_Rutherford

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.

CACRutherfordSolveSourceparameters

Module: DataFiQuSConductorAC_Rutherford

Description: Level 3: Class for material properties

Fields

Field	Type	Default	Description
`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.
`boundary_condition_type`	`str`	`"Natural"`	Boundary condition type. Supported options are: Natural, Essential. Do not use essential boundary condition with induced currents.
`sine`	`CACRutherfordSolveSourceparametersSine`	`CACRutherfordSolveSourceparametersSine()`
`piecewise`	`CACRutherfordSolveSourceparametersPiecewise`	`CACRutherfordSolveSourceparametersPiecewise()`
`excitation_coils`	`CACRutherfordSolveSourceparametersExcitationCoils`	`CACRutherfordSolveSourceparametersExcitationCoils()`

Nested Models

CACRutherfordSolveSourceparametersExcitationCoils

Description: Level 4: Class for excitation coils

Field	Type	Default	Description
`enable`	`Optional[bool]`	`False`	Are the excitation coils used in the model? (they can exist in the geometry and mesh but be ignored at the solution stage)
`source_csv_file`	`Optional[str]`	`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).

CACRutherfordSolveSourceparametersPiecewise

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.
`field_angle`	`Optional[float]`	`90`	Angle of the sine field direction, with respect to the x-axis (degrees).

CACRutherfordSolveSourceparametersSine

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).
`field_angle`	`Optional[float]`	`90`	Angle of the sine field direction, with respect to the x-axis (degrees).
`superimposed_DC`	`CACRutherfordSolveSourceparametersSineSuperimposedDC`	`CACRutherfordSolveSourceparametersSineSuperimposedDC()`

CACRutherfordSolveSourceparametersSineSuperimposedDC

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.

CACRutherfordSolveSourceparametersExcitationCoils

Module: DataFiQuSConductorAC_Rutherford

Description: Level 4: Class for excitation coils

Fields

Field	Type	Default	Description
`enable`	`Optional[bool]`	`False`	Are the excitation coils used in the model? (they can exist in the geometry and mesh but be ignored at the solution stage)
`source_csv_file`	`Optional[str]`	`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).

CACRutherfordSolveSourceparametersPiecewise

Module: DataFiQuSConductorAC_Rutherford

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.
`field_angle`	`Optional[float]`	`90`	Angle of the sine field direction, with respect to the x-axis (degrees).

CACRutherfordSolveSourceparametersSine

Module: DataFiQuSConductorAC_Rutherford

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).
`field_angle`	`Optional[float]`	`90`	Angle of the sine field direction, with respect to the x-axis (degrees).
`superimposed_DC`	`CACRutherfordSolveSourceparametersSineSuperimposedDC`	`CACRutherfordSolveSourceparametersSineSuperimposedDC()`

Nested Models

CACRutherfordSolveSourceparametersSineSuperimposedDC

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.

CACRutherfordSolveSourceparametersSineSuperimposedDC

Module: DataFiQuSConductorAC_Rutherford

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.