DataFiQuSConductorAC_Strand

Auto-generated documentation for DataFiQuSConductorAC_Strand.

Classes

• CACStrand
• CACStrandGeometry
• CACStrandGeometryIOsettings
• CACStrandIOsettingsLoad
• CACStrandIOsettingsSave
• CACStrandMesh
• CACStrandMeshAir
• CACStrandMeshFilaments
• CACStrandMeshMatrix
• CACStrandPostproc
• CACStrandPostprocBatchpostproc
• CACStrandPostprocBatchpostprocFilter
• CACStrandPostprocBatchpostprocLossMap
• CACStrandPostprocBatchpostprocLossMapCrossSection
• CACStrandPostprocBatchpostprocLossMapCrossSectionSweep
• CACStrandPostprocBatchpostprocPlot2d
• CACStrandPostprocBatchpostprocROHFgrid
• CACStrandPostprocBatchpostprocSort
• CACStrandPostprocCleanup
• CACStrandPostprocPlotFlux
• CACStrandPostprocPlotInstPower
• CACStrandPostprocPosFiles
• CACStrandSolve
• CACStrandSolveDiffusionBarriers
• CACStrandSolveFormulationparameters
• CACStrandSolveGeneralparameters
• CACStrandSolveInitialconditions
• CACStrandSolveNumericalparameters
• CACStrandSolveNumericalparametersPiecewise
• CACStrandSolveNumericalparametersRotating
• CACStrandSolveNumericalparametersSine
• CACStrandSolveSourceparameters
• CACStrandSolveSourceparametersPiecewise
• CACStrandSolveSourceparametersRotating
• CACStrandSolveSourceparametersSine
• CACStrandSolveSourceparametersSineSuperimposedDC

CACStrand

Module: DataFiQuSConductorAC_Strand

Description: Level 1: Class for FiQuS ConductorAC

Fields

Field	Type	Default	Description
type	str	Required
geometry	CACStrandGeometry	CACStrandGeometry()
mesh	CACStrandMesh	CACStrandMesh()
solve	CACStrandSolve	CACStrandSolve()
postproc	CACStrandPostproc	CACStrandPostproc()

Nested Models

CACStrandGeometry

Description: Level 2: Class for strand geometry parameters

Field	Type	Default	Description
io_settings	CACStrandGeometryIOsettings	CACStrandGeometryIOsettings()
hexagonal_filaments	Optional[bool]	null	Field for specifying the shape of the filaments. True for hexagonal, False for circular.
hexagonal_holes	Optional[bool]	null	Field for specifying the shape of the filament holes. True for hexagonal, False for circular.
filament_circular_distribution	Optional[bool]	null	Field for specifying the geometrical distribution of the filaments. Set True to distribute the filaments in a circular pattern and False to distribute them in a hexagonal pattern.
air_radius	Optional[float]	null	Radius of the circular numerical air region (m).
type	Literal[str]	"strand_only"	Type of model geometry which will be generated. Supported options are: strand_only, periodic_squarestrand_only models the strand in an circular air domain (natural boundary condition)periodic_square models the strand in an square air domain (periodic boundary condition)coil models a single coil winding in open space (uses hybrid boundary conditions) Available inputs: "strand_only", "periodic_square", "coil"
coil_radius	Optional[float]	null	used in geometry type 'coil' to determine the distance from strand center to mirroring plane (m). Should always be bigger than strand radius.
rotate_angle	Optional[float]	null	Rotates strand geometry by specified angle in deg counterclockwise around the z axis and x=0 and y=0

CACStrandGeometryIOsettings

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

Field	Type	Default	Description
load	CACStrandIOsettingsLoad	CACStrandIOsettingsLoad()
save	CACStrandIOsettingsSave	CACStrandIOsettingsSave()

CACStrandIOsettingsLoad

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.

CACStrandIOsettingsSave

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.

CACStrandMesh

Description: Level 2: Class for FiQuS ConductorAC

Field	Type	Default	Description
scaling_global	Optional[float]	1	Global scaling factor for mesh size.
filaments	CACStrandMeshFilaments	CACStrandMeshFilaments()
matrix	CACStrandMeshMatrix	CACStrandMeshMatrix()
air	CACStrandMeshAir	CACStrandMeshAir()

CACStrandMeshAir

Description: Level 3: Class for FiQuS ConductorAC

Field	Type	Default	Description
max_mesh_size_ratio	Optional[float]	null	Mesh size at the outer boundary of the air region, relative to the filament radius. E.g. 10 means that the mesh size is 10 times the filament radius.

CACStrandMeshFilaments

Description: Level 3: Class for FiQuS ConductorAC

Field	Type	Default	Description
boundary_mesh_size_ratio	Optional[float]	null	Mesh size at filament boundaries, relative to the radius of the filaments. E.g. 0.1 means that the mesh size is 0.1 times the filament radius.
center_mesh_size_ratio	Optional[float]	null	Mesh size at filament center, relative to the radius of the filaments. E.g. 0.1 means that the mesh size is 0.1 times the filament radius.
amplitude_dependent_scaling	Optional[bool]	False	Amplitude dependent scaling uses the field amplitude to approximate the field penetration distance in the filaments to alter the filament mesh. If the field penetration distance is low (i.e. for low field amplitudes) this feature increases mesh density in the region where the field is expected to penetrate, and decreases the mesh resolution in the region where the field does not penetrate.
field_penetration_depth_scaling_factor	Optional[float]	null	Scaling factor for the estimate of the field penetration depth, used for amplitude dependent scaling.
desired_elements_in_field_penetration_region	Optional[float]	null	Desired number of elements in the field penetration region. This parameter is used for amplitude dependent scaling, and determines the number of elements in the region where the field is expected to penetrate.

CACStrandMeshMatrix

Description: Level 3: Class for FiQuS ConductorAC

Field	Type	Default	Description
mesh_size_matrix_ratio_inner	Optional[float]	null	Mesh size at the matrix center, relative to the filament radius.
mesh_size_matrix_ratio_middle	Optional[float]	null	Mesh size at the matrix middle partition, relative to the filament radius.
mesh_size_matrix_ratio_outer	Optional[float]	null	Mesh size at the matrix outer boundary, relative to the filament radius.
interpolation_distance_from_filaments_ratio	Optional[float]	null	The mesh size is interpolated from the filament boundaries into the matrix, over a given distance. This parameter determines the distance over which the mesh size is interpolated.
rate_dependent_scaling_matrix	Optional[bool]	False	Rate dependent scaling uses the expected skin depth in the matrix to determine the matrix mesh. If the skin depth is low (i.e. for high frequencies) this feature increases mesh density in the region where the current is expected to flow, while decreasing the mesh resolution in the region where the current is not expected to flow.
skindepth_scaling_factor	Optional[float]	null	Scaling factor for the estimate of the skin depth, used for rate dependent scaling.
desired_elements_in_skindepth	Optional[float]	null	Desired number of elements in the skin depth region. This parameter is used for rate dependent scaling, and determines the number of elements in the region where the current is expected to flow.
force_center_symmetry	Optional[bool]	False	This option can be set in strands without center filament to enforce a cross of symmetric nodes in the center of the strand mesh - used within Glock thesis.

CACStrandPostproc

Description: Level 2: Class for FiQuS ConductorAC

Field	Type	Default	Description
pos_files	CACStrandPostprocPosFiles	CACStrandPostprocPosFiles()	Entries controlling output of .pos files. If None or empty lists are given, no .pos files are written. Note that not all combinations of quantities and regions make sense.
compute_current_per_filament	bool	False	Computes current in every filament, with decomposition into magnetization and transport current.
output_folder	Optional[str]	"Results"	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.
cleanup	CACStrandPostprocCleanup	CACStrandPostprocCleanup()
plot_flux	CACStrandPostprocPlotFlux	CACStrandPostprocPlotFlux()
plot_instantaneous_power	CACStrandPostprocPlotInstPower	CACStrandPostprocPlotInstPower()
batch_postproc	CACStrandPostprocBatchpostproc	CACStrandPostprocBatchpostproc()

CACStrandPostprocBatchpostproc

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

Field	Type	Default	Description
simulations_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.
fluxmodels_csv	Optional[str]	null	Name of the .csv file for post-processing (without file extension). This file specifies the fluxmodels to be post-processed. The file is structured into three columns, specifying the folder names to access the simulation results: 'input.run.geometry', 'input.run.mesh' and 'input.run.solve'. Each row corresponds to a simulation to be post-processed.
filter	CACStrandPostprocBatchpostprocFilter	CACStrandPostprocBatchpostprocFilter()
sort	CACStrandPostprocBatchpostprocSort	CACStrandPostprocBatchpostprocSort()
loss_map	CACStrandPostprocBatchpostprocLossMap	CACStrandPostprocBatchpostprocLossMap()
rohf_on_grid	CACStrandPostprocBatchpostprocROHFgrid	CACStrandPostprocBatchpostprocROHFgrid()
plot2d	CACStrandPostprocBatchpostprocPlot2d	CACStrandPostprocBatchpostprocPlot2d()

CACStrandPostprocBatchpostprocFilter

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.

CACStrandPostprocBatchpostprocLossMap

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	CACStrandPostprocBatchpostprocLossMapCrossSection	CACStrandPostprocBatchpostprocLossMapCrossSection()
cross_section_sweep	CACStrandPostprocBatchpostprocLossMapCrossSectionSweep	CACStrandPostprocBatchpostprocLossMapCrossSectionSweep()

CACStrandPostprocBatchpostprocLossMapCrossSection

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.

CACStrandPostprocBatchpostprocLossMapCrossSectionSweep

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.

CACStrandPostprocBatchpostprocPlot2d

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_pgfdata	bool	False	Set True to export the plot data in pgfplot readable .txt format stored in output_folder. Currently only supports combined plots.
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 dot notation 'simulation.' E.g. 'simulation.f' will create a 2D plot with sine source frequency on the x-axis. 'simulation.time' will create a plot with time on the x-axis.
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 dot notation 'simulation.' E.g. total AC-loss per cycle can be accessed as ['simulation.total_power_per_cycle['TotalLoss_dyn']'].
y_val_fluxmodel	Optional[str]	null	Attribute of the 'ROHFmodel' class which is plotted on the y-axis. Access via dot notation with 'fluxmodel.' and 'simulation.' E.g. ROHF computed flux - 'fluxmodel.compute(I=simulation.I_transport,time=simulation.time)[0]'
reference_vals	Optional[list]	null	reference values as set of two list [xvals, yvals] which will be plotted in the combined plot (For reference curves)
reference_label	Optional[str]	null	label text for the reference data in the plot legend
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.

CACStrandPostprocBatchpostprocROHFgrid

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

Field	Type	Default	Description
produce_error_map	bool	False	Set True to produce a error map of the definced error_type. If the fit_rohf option is enabled it will compute the map for the new ROHF model ignoring everything in the fluxmodel.csv.
interpolate_error_map	bool	False	Interpolate colormap linear between the computed values (graphical purposes)
error_type	str	"pc_loss"	realtive error metric displayed by the map. Options: pc_loss, flux, dyn_loss
fit_rohf	bool	False	Fit a ROHF model on the simulation grid given in the simulation.csv
fit_rohf_N	Optional[int]	7	Number of ROHF cells to use for the fit. Default is 7.
fit_rohf_tausweep_IIC	Optional[float]	1.0	I/Ic ratio used to fit the ratedependence parameters (taus).

CACStrandPostprocBatchpostprocSort

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.

CACStrandPostprocCleanup

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.

CACStrandPostprocPlotFlux

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

Field	Type	Default	Description
show	Optional[bool]	False	Enable flux related plots.
rohf	Optional[bool]	False	Enable ROHF model.
rohf_file	Optional[str]	null	Name of a .txt file in the geometry folder containing tau, kappa and alpha values. The file has to be structured into three columns (separated by whitespaces) with the preliminary header-row 'taus kappas alphas'. Each row corresponds to one cell of the multicell ROHF model.
rohf_N	Optional[int]	null	Total number of cells (N) for the ROHF model. If a parameter_file_name is given this option will be disregarded in favour of the parameterfile definitions.
rohf_kappa_spacing	Optional[str]	null	Spacing strategy for the N kappa values of the ROHF model. Options: 'linear', 'log', 'invlog' if left blank it will set the kappa interval based on a error minimization. If a parameter_file_name is given this option will be disregarded in favour of the parameterfile definitions.

CACStrandPostprocPlotInstPower

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.

CACStrandPostprocPosFiles

Description: Level 3: Class for cleanup settings

Field	Type	Default	Description
quantities	Optional[list]	null	List of GetDP postprocessing quantity to write to .pos file. Examples of valid entry is: phi, h, b, b_reaction, j, jz, jc, power_filaments, power_matrix, sigma_matrix, j_plane, v_plane, hsVal
regions	Optional[list]	null	List of GetDP region to to write to .pos file postprocessing for. Examples of valid entry is: Matrix, Filaments, Omega (full domain), OmegaC (conducting domain), OmegaCC (non conducting domain)

CACStrandSolve

Description: Level 2: Class for FiQuS ConductorAC Strand solver settings

Field	Type	Default	Description
pro_template	Optional[str]	"CAC_Strand_template.pro"	Name of the .pro template file.
conductor_name	Optional[str]	null	Name of the conductor. Must match a conductor name in the conductors section of the input YAML-file.
formulation_parameters	CACStrandSolveFormulationparameters	CACStrandSolveFormulationparameters()
general_parameters	CACStrandSolveGeneralparameters	CACStrandSolveGeneralparameters()
initial_conditions	CACStrandSolveInitialconditions	CACStrandSolveInitialconditions()
diffusion_barriers	CACStrandSolveDiffusionBarriers	CACStrandSolveDiffusionBarriers()
global_diffusion_barrier	CACStrandSolveDiffusionBarriers	CACStrandSolveDiffusionBarriers()	Additional diffusion barrier around all filaments together (global).This is created on a line between two strand matrix regions.One around the filaments and the other for the external ring.
source_parameters	CACStrandSolveSourceparameters	CACStrandSolveSourceparameters()
numerical_parameters	CACStrandSolveNumericalparameters	CACStrandSolveNumericalparameters()

CACStrandSolveDiffusionBarriers

Field	Type	Default	Description
enable	Optional[bool]	False	Set True to enable diffusion barriers.
load_data_from_yaml	Optional[bool]	False	Set True to load the diffusion barrier data from the input YAML-file. Otherwise, the thickness and resistivity specified in this file are used.
resistivity	Optional[float]	1e-06	Resistivity of the diffusion barriers (Ohm*m).
thickness	Optional[float]	1e-06	Thickness of the diffusion barriers (m).

CACStrandSolveFormulationparameters

Description: Level 3: Class for finite element formulation parameters

Field	Type	Default	Description
formulation	Literal[str]	"CATI"	Which formulation? CATI is the default and usual choice to model hysteresis/coupling/eddy currents with the CATI method. AI_uncoupled is a conventional 2D formulation with axial currents modelling UNCOUPLED filaments (and eddy currents in matrix). Available inputs: "CATI", "AI_uncoupled"
dynamic_correction	Optional[bool]	True	With the CATI method, do we activate the dynamic correction?
compute_temperature	Optional[bool]	False	Do we compute the temperature?
two_ell_periodicity	Optional[bool]	True	With CATI method: True to integrate over twice the shortest periodicity length (recommended), False to integrate over the shortest periodicity length (not recommended).

CACStrandSolveGeneralparameters

Description: Level 3: Class for general parameters

Field	Type	Default	Description
temperature	float	1.9	Temperature (K) of the strand.
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.

CACStrandSolveInitialconditions

Description: Level 3: Class for initial conditions

Field	Type	Default	Description
init_type	Optional[Literal[str]]	"virgin"	Type of initialization for the simulation. (i) 'virgin' is the default type, the initial magnetic field is zero, (ii) 'pos_file' is to initialize from the solution of another solution, given by the solution_to_init_from entry, and (iii) 'uniform_field' is to initialize at a uniform field, which will be the applied field at the initial time of the simulation. Note that the uniform_field option does not allow any non-zero transport current. Available inputs: "virgin", "pos_file", "uniform_field"
solution_to_init_from	Optional[int | str]	null	Name xxx of the solution from which the simulation should be initialized. The file last_magnetic_field.pos of folder Solution_xxx will be used for the initial solution. It must be in the Geometry_xxx/Mesh_xxx/ folder in which the Solution_xxx will be saved.

CACStrandSolveNumericalparameters

Description: Level 3: Class for numerical parameters

Field	Type	Default	Description
sine	CACStrandSolveNumericalparametersSine	CACStrandSolveNumericalparametersSine()
piecewise	CACStrandSolveNumericalparametersPiecewise	CACStrandSolveNumericalparametersPiecewise()
rotating	CACStrandSolveNumericalparametersRotating	CACStrandSolveNumericalparametersRotating()

CACStrandSolveNumericalparametersPiecewise

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.

CACStrandSolveNumericalparametersRotating

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 source rotation. Determines the initial time step size.
number_of_periods_to_simulate	Optional[float]	null	Number of periods (-) to simulate for the source rotation.

CACStrandSolveNumericalparametersSine

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.

CACStrandSolveSourceparameters

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, rotating. Available inputs: "sine", "piecewise", "rotating"
sine	CACStrandSolveSourceparametersSine	CACStrandSolveSourceparametersSine()
piecewise	CACStrandSolveSourceparametersPiecewise	CACStrandSolveSourceparametersPiecewise()
rotating	CACStrandSolveSourceparametersRotating	CACStrandSolveSourceparametersRotating()
field_angle	Optional[float]	90	Angle of the source magnetic field, with respect to the x-axis (degrees).

CACStrandSolveSourceparametersPiecewise

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.

CACStrandSolveSourceparametersRotating

Description: Level 4: Class for Rotating magnetic source field parameters

Field	Type	Default	Description
frequency	Optional[float]	null	Frequency of field rotation around z-axis
field_magnitude	Optional[float]	null	constant Magnitude of the rotating field (T).

CACStrandSolveSourceparametersSine

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	CACStrandSolveSourceparametersSineSuperimposedDC	CACStrandSolveSourceparametersSineSuperimposedDC()

CACStrandSolveSourceparametersSineSuperimposedDC

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), in the same direction as the AC applied field. Solution must be initialized with a non-zero field solution, either stored in a .pos file, or a uniform field, if non-zero DC field is used.
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.

CACStrandGeometry

Module: DataFiQuSConductorAC_Strand

Description: Level 2: Class for strand geometry parameters

Fields

Field	Type	Default	Description
io_settings	CACStrandGeometryIOsettings	CACStrandGeometryIOsettings()
hexagonal_filaments	Optional[bool]	null	Field for specifying the shape of the filaments. True for hexagonal, False for circular.
hexagonal_holes	Optional[bool]	null	Field for specifying the shape of the filament holes. True for hexagonal, False for circular.
filament_circular_distribution	Optional[bool]	null	Field for specifying the geometrical distribution of the filaments. Set True to distribute the filaments in a circular pattern and False to distribute them in a hexagonal pattern.
air_radius	Optional[float]	null	Radius of the circular numerical air region (m).
type	Literal[str]	"strand_only"	Type of model geometry which will be generated. Supported options are: strand_only, periodic_squarestrand_only models the strand in an circular air domain (natural boundary condition)periodic_square models the strand in an square air domain (periodic boundary condition)coil models a single coil winding in open space (uses hybrid boundary conditions) Available inputs: "strand_only", "periodic_square", "coil"
coil_radius	Optional[float]	null	used in geometry type 'coil' to determine the distance from strand center to mirroring plane (m). Should always be bigger than strand radius.
rotate_angle	Optional[float]	null	Rotates strand geometry by specified angle in deg counterclockwise around the z axis and x=0 and y=0

Nested Models

CACStrandGeometryIOsettings

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

Field	Type	Default	Description
load	CACStrandIOsettingsLoad	CACStrandIOsettingsLoad()
save	CACStrandIOsettingsSave	CACStrandIOsettingsSave()

CACStrandIOsettingsLoad

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.

CACStrandIOsettingsSave

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.

CACStrandGeometryIOsettings

Module: DataFiQuSConductorAC_Strand

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

Fields

Field	Type	Default	Description
load	CACStrandIOsettingsLoad	CACStrandIOsettingsLoad()
save	CACStrandIOsettingsSave	CACStrandIOsettingsSave()

Nested Models

CACStrandIOsettingsLoad

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.

CACStrandIOsettingsSave

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.

CACStrandIOsettingsLoad

Module: DataFiQuSConductorAC_Strand

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.

CACStrandIOsettingsSave

Module: DataFiQuSConductorAC_Strand

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.

CACStrandMesh

Module: DataFiQuSConductorAC_Strand

Description: Level 2: Class for FiQuS ConductorAC

Fields

Field	Type	Default	Description
scaling_global	Optional[float]	1	Global scaling factor for mesh size.
filaments	CACStrandMeshFilaments	CACStrandMeshFilaments()
matrix	CACStrandMeshMatrix	CACStrandMeshMatrix()
air	CACStrandMeshAir	CACStrandMeshAir()

Nested Models

CACStrandMeshAir

Description: Level 3: Class for FiQuS ConductorAC

Field	Type	Default	Description
max_mesh_size_ratio	Optional[float]	null	Mesh size at the outer boundary of the air region, relative to the filament radius. E.g. 10 means that the mesh size is 10 times the filament radius.

CACStrandMeshFilaments

Description: Level 3: Class for FiQuS ConductorAC

Field	Type	Default	Description
boundary_mesh_size_ratio	Optional[float]	null	Mesh size at filament boundaries, relative to the radius of the filaments. E.g. 0.1 means that the mesh size is 0.1 times the filament radius.
center_mesh_size_ratio	Optional[float]	null	Mesh size at filament center, relative to the radius of the filaments. E.g. 0.1 means that the mesh size is 0.1 times the filament radius.
amplitude_dependent_scaling	Optional[bool]	False	Amplitude dependent scaling uses the field amplitude to approximate the field penetration distance in the filaments to alter the filament mesh. If the field penetration distance is low (i.e. for low field amplitudes) this feature increases mesh density in the region where the field is expected to penetrate, and decreases the mesh resolution in the region where the field does not penetrate.
field_penetration_depth_scaling_factor	Optional[float]	null	Scaling factor for the estimate of the field penetration depth, used for amplitude dependent scaling.
desired_elements_in_field_penetration_region	Optional[float]	null	Desired number of elements in the field penetration region. This parameter is used for amplitude dependent scaling, and determines the number of elements in the region where the field is expected to penetrate.

CACStrandMeshMatrix

Description: Level 3: Class for FiQuS ConductorAC

Field	Type	Default	Description
mesh_size_matrix_ratio_inner	Optional[float]	null	Mesh size at the matrix center, relative to the filament radius.
mesh_size_matrix_ratio_middle	Optional[float]	null	Mesh size at the matrix middle partition, relative to the filament radius.
mesh_size_matrix_ratio_outer	Optional[float]	null	Mesh size at the matrix outer boundary, relative to the filament radius.
interpolation_distance_from_filaments_ratio	Optional[float]	null	The mesh size is interpolated from the filament boundaries into the matrix, over a given distance. This parameter determines the distance over which the mesh size is interpolated.
rate_dependent_scaling_matrix	Optional[bool]	False	Rate dependent scaling uses the expected skin depth in the matrix to determine the matrix mesh. If the skin depth is low (i.e. for high frequencies) this feature increases mesh density in the region where the current is expected to flow, while decreasing the mesh resolution in the region where the current is not expected to flow.
skindepth_scaling_factor	Optional[float]	null	Scaling factor for the estimate of the skin depth, used for rate dependent scaling.
desired_elements_in_skindepth	Optional[float]	null	Desired number of elements in the skin depth region. This parameter is used for rate dependent scaling, and determines the number of elements in the region where the current is expected to flow.
force_center_symmetry	Optional[bool]	False	This option can be set in strands without center filament to enforce a cross of symmetric nodes in the center of the strand mesh - used within Glock thesis.

CACStrandMeshAir

Module: DataFiQuSConductorAC_Strand

Description: Level 3: Class for FiQuS ConductorAC

Fields

Field	Type	Default	Description
max_mesh_size_ratio	Optional[float]	null	Mesh size at the outer boundary of the air region, relative to the filament radius. E.g. 10 means that the mesh size is 10 times the filament radius.

CACStrandMeshFilaments

Module: DataFiQuSConductorAC_Strand

Description: Level 3: Class for FiQuS ConductorAC

Fields

Field	Type	Default	Description
boundary_mesh_size_ratio	Optional[float]	null	Mesh size at filament boundaries, relative to the radius of the filaments. E.g. 0.1 means that the mesh size is 0.1 times the filament radius.
center_mesh_size_ratio	Optional[float]	null	Mesh size at filament center, relative to the radius of the filaments. E.g. 0.1 means that the mesh size is 0.1 times the filament radius.
amplitude_dependent_scaling	Optional[bool]	False	Amplitude dependent scaling uses the field amplitude to approximate the field penetration distance in the filaments to alter the filament mesh. If the field penetration distance is low (i.e. for low field amplitudes) this feature increases mesh density in the region where the field is expected to penetrate, and decreases the mesh resolution in the region where the field does not penetrate.
field_penetration_depth_scaling_factor	Optional[float]	null	Scaling factor for the estimate of the field penetration depth, used for amplitude dependent scaling.
desired_elements_in_field_penetration_region	Optional[float]	null	Desired number of elements in the field penetration region. This parameter is used for amplitude dependent scaling, and determines the number of elements in the region where the field is expected to penetrate.

CACStrandMeshMatrix

Module: DataFiQuSConductorAC_Strand

Description: Level 3: Class for FiQuS ConductorAC

Fields

Field	Type	Default	Description
mesh_size_matrix_ratio_inner	Optional[float]	null	Mesh size at the matrix center, relative to the filament radius.
mesh_size_matrix_ratio_middle	Optional[float]	null	Mesh size at the matrix middle partition, relative to the filament radius.
mesh_size_matrix_ratio_outer	Optional[float]	null	Mesh size at the matrix outer boundary, relative to the filament radius.
interpolation_distance_from_filaments_ratio	Optional[float]	null	The mesh size is interpolated from the filament boundaries into the matrix, over a given distance. This parameter determines the distance over which the mesh size is interpolated.
rate_dependent_scaling_matrix	Optional[bool]	False	Rate dependent scaling uses the expected skin depth in the matrix to determine the matrix mesh. If the skin depth is low (i.e. for high frequencies) this feature increases mesh density in the region where the current is expected to flow, while decreasing the mesh resolution in the region where the current is not expected to flow.
skindepth_scaling_factor	Optional[float]	null	Scaling factor for the estimate of the skin depth, used for rate dependent scaling.
desired_elements_in_skindepth	Optional[float]	null	Desired number of elements in the skin depth region. This parameter is used for rate dependent scaling, and determines the number of elements in the region where the current is expected to flow.
force_center_symmetry	Optional[bool]	False	This option can be set in strands without center filament to enforce a cross of symmetric nodes in the center of the strand mesh - used within Glock thesis.

CACStrandPostproc

Module: DataFiQuSConductorAC_Strand

Description: Level 2: Class for FiQuS ConductorAC

Fields

Field	Type	Default	Description
pos_files	CACStrandPostprocPosFiles	CACStrandPostprocPosFiles()	Entries controlling output of .pos files. If None or empty lists are given, no .pos files are written. Note that not all combinations of quantities and regions make sense.
compute_current_per_filament	bool	False	Computes current in every filament, with decomposition into magnetization and transport current.
output_folder	Optional[str]	"Results"	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.
cleanup	CACStrandPostprocCleanup	CACStrandPostprocCleanup()
plot_flux	CACStrandPostprocPlotFlux	CACStrandPostprocPlotFlux()
plot_instantaneous_power	CACStrandPostprocPlotInstPower	CACStrandPostprocPlotInstPower()
batch_postproc	CACStrandPostprocBatchpostproc	CACStrandPostprocBatchpostproc()

Nested Models

CACStrandPostprocBatchpostproc

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

Field	Type	Default	Description
simulations_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.
fluxmodels_csv	Optional[str]	null	Name of the .csv file for post-processing (without file extension). This file specifies the fluxmodels to be post-processed. The file is structured into three columns, specifying the folder names to access the simulation results: 'input.run.geometry', 'input.run.mesh' and 'input.run.solve'. Each row corresponds to a simulation to be post-processed.
filter	CACStrandPostprocBatchpostprocFilter	CACStrandPostprocBatchpostprocFilter()
sort	CACStrandPostprocBatchpostprocSort	CACStrandPostprocBatchpostprocSort()
loss_map	CACStrandPostprocBatchpostprocLossMap	CACStrandPostprocBatchpostprocLossMap()
rohf_on_grid	CACStrandPostprocBatchpostprocROHFgrid	CACStrandPostprocBatchpostprocROHFgrid()
plot2d	CACStrandPostprocBatchpostprocPlot2d	CACStrandPostprocBatchpostprocPlot2d()

CACStrandPostprocBatchpostprocFilter

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.

CACStrandPostprocBatchpostprocLossMap

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	CACStrandPostprocBatchpostprocLossMapCrossSection	CACStrandPostprocBatchpostprocLossMapCrossSection()
cross_section_sweep	CACStrandPostprocBatchpostprocLossMapCrossSectionSweep	CACStrandPostprocBatchpostprocLossMapCrossSectionSweep()

CACStrandPostprocBatchpostprocLossMapCrossSection

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.

CACStrandPostprocBatchpostprocLossMapCrossSectionSweep

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.

CACStrandPostprocBatchpostprocPlot2d

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_pgfdata	bool	False	Set True to export the plot data in pgfplot readable .txt format stored in output_folder. Currently only supports combined plots.
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 dot notation 'simulation.' E.g. 'simulation.f' will create a 2D plot with sine source frequency on the x-axis. 'simulation.time' will create a plot with time on the x-axis.
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 dot notation 'simulation.' E.g. total AC-loss per cycle can be accessed as ['simulation.total_power_per_cycle['TotalLoss_dyn']'].
y_val_fluxmodel	Optional[str]	null	Attribute of the 'ROHFmodel' class which is plotted on the y-axis. Access via dot notation with 'fluxmodel.' and 'simulation.' E.g. ROHF computed flux - 'fluxmodel.compute(I=simulation.I_transport,time=simulation.time)[0]'
reference_vals	Optional[list]	null	reference values as set of two list [xvals, yvals] which will be plotted in the combined plot (For reference curves)
reference_label	Optional[str]	null	label text for the reference data in the plot legend
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.

CACStrandPostprocBatchpostprocROHFgrid

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

Field	Type	Default	Description
produce_error_map	bool	False	Set True to produce a error map of the definced error_type. If the fit_rohf option is enabled it will compute the map for the new ROHF model ignoring everything in the fluxmodel.csv.
interpolate_error_map	bool	False	Interpolate colormap linear between the computed values (graphical purposes)
error_type	str	"pc_loss"	realtive error metric displayed by the map. Options: pc_loss, flux, dyn_loss
fit_rohf	bool	False	Fit a ROHF model on the simulation grid given in the simulation.csv
fit_rohf_N	Optional[int]	7	Number of ROHF cells to use for the fit. Default is 7.
fit_rohf_tausweep_IIC	Optional[float]	1.0	I/Ic ratio used to fit the ratedependence parameters (taus).

CACStrandPostprocBatchpostprocSort

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.

CACStrandPostprocCleanup

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.

CACStrandPostprocPlotFlux

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

Field	Type	Default	Description
show	Optional[bool]	False	Enable flux related plots.
rohf	Optional[bool]	False	Enable ROHF model.
rohf_file	Optional[str]	null	Name of a .txt file in the geometry folder containing tau, kappa and alpha values. The file has to be structured into three columns (separated by whitespaces) with the preliminary header-row 'taus kappas alphas'. Each row corresponds to one cell of the multicell ROHF model.
rohf_N	Optional[int]	null	Total number of cells (N) for the ROHF model. If a parameter_file_name is given this option will be disregarded in favour of the parameterfile definitions.
rohf_kappa_spacing	Optional[str]	null	Spacing strategy for the N kappa values of the ROHF model. Options: 'linear', 'log', 'invlog' if left blank it will set the kappa interval based on a error minimization. If a parameter_file_name is given this option will be disregarded in favour of the parameterfile definitions.

CACStrandPostprocPlotInstPower

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.

CACStrandPostprocPosFiles

Description: Level 3: Class for cleanup settings

Field	Type	Default	Description
quantities	Optional[list]	null	List of GetDP postprocessing quantity to write to .pos file. Examples of valid entry is: phi, h, b, b_reaction, j, jz, jc, power_filaments, power_matrix, sigma_matrix, j_plane, v_plane, hsVal
regions	Optional[list]	null	List of GetDP region to to write to .pos file postprocessing for. Examples of valid entry is: Matrix, Filaments, Omega (full domain), OmegaC (conducting domain), OmegaCC (non conducting domain)

CACStrandPostprocBatchpostproc

Module: DataFiQuSConductorAC_Strand

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

Fields

Field	Type	Default	Description
simulations_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.
fluxmodels_csv	Optional[str]	null	Name of the .csv file for post-processing (without file extension). This file specifies the fluxmodels to be post-processed. The file is structured into three columns, specifying the folder names to access the simulation results: 'input.run.geometry', 'input.run.mesh' and 'input.run.solve'. Each row corresponds to a simulation to be post-processed.
filter	CACStrandPostprocBatchpostprocFilter	CACStrandPostprocBatchpostprocFilter()
sort	CACStrandPostprocBatchpostprocSort	CACStrandPostprocBatchpostprocSort()
loss_map	CACStrandPostprocBatchpostprocLossMap	CACStrandPostprocBatchpostprocLossMap()
rohf_on_grid	CACStrandPostprocBatchpostprocROHFgrid	CACStrandPostprocBatchpostprocROHFgrid()
plot2d	CACStrandPostprocBatchpostprocPlot2d	CACStrandPostprocBatchpostprocPlot2d()

Nested Models

CACStrandPostprocBatchpostprocFilter

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.

CACStrandPostprocBatchpostprocLossMap

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	CACStrandPostprocBatchpostprocLossMapCrossSection	CACStrandPostprocBatchpostprocLossMapCrossSection()
cross_section_sweep	CACStrandPostprocBatchpostprocLossMapCrossSectionSweep	CACStrandPostprocBatchpostprocLossMapCrossSectionSweep()

CACStrandPostprocBatchpostprocLossMapCrossSection

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.

CACStrandPostprocBatchpostprocLossMapCrossSectionSweep

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.

CACStrandPostprocBatchpostprocPlot2d

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_pgfdata	bool	False	Set True to export the plot data in pgfplot readable .txt format stored in output_folder. Currently only supports combined plots.
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 dot notation 'simulation.' E.g. 'simulation.f' will create a 2D plot with sine source frequency on the x-axis. 'simulation.time' will create a plot with time on the x-axis.
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 dot notation 'simulation.' E.g. total AC-loss per cycle can be accessed as ['simulation.total_power_per_cycle['TotalLoss_dyn']'].
y_val_fluxmodel	Optional[str]	null	Attribute of the 'ROHFmodel' class which is plotted on the y-axis. Access via dot notation with 'fluxmodel.' and 'simulation.' E.g. ROHF computed flux - 'fluxmodel.compute(I=simulation.I_transport,time=simulation.time)[0]'
reference_vals	Optional[list]	null	reference values as set of two list [xvals, yvals] which will be plotted in the combined plot (For reference curves)
reference_label	Optional[str]	null	label text for the reference data in the plot legend
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.

CACStrandPostprocBatchpostprocROHFgrid

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

Field	Type	Default	Description
produce_error_map	bool	False	Set True to produce a error map of the definced error_type. If the fit_rohf option is enabled it will compute the map for the new ROHF model ignoring everything in the fluxmodel.csv.
interpolate_error_map	bool	False	Interpolate colormap linear between the computed values (graphical purposes)
error_type	str	"pc_loss"	realtive error metric displayed by the map. Options: pc_loss, flux, dyn_loss
fit_rohf	bool	False	Fit a ROHF model on the simulation grid given in the simulation.csv
fit_rohf_N	Optional[int]	7	Number of ROHF cells to use for the fit. Default is 7.
fit_rohf_tausweep_IIC	Optional[float]	1.0	I/Ic ratio used to fit the ratedependence parameters (taus).

CACStrandPostprocBatchpostprocSort

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.

CACStrandPostprocBatchpostprocFilter

Module: DataFiQuSConductorAC_Strand

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.

CACStrandPostprocBatchpostprocLossMap

Module: DataFiQuSConductorAC_Strand

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	CACStrandPostprocBatchpostprocLossMapCrossSection	CACStrandPostprocBatchpostprocLossMapCrossSection()
cross_section_sweep	CACStrandPostprocBatchpostprocLossMapCrossSectionSweep	CACStrandPostprocBatchpostprocLossMapCrossSectionSweep()

Nested Models

CACStrandPostprocBatchpostprocLossMapCrossSection

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.

CACStrandPostprocBatchpostprocLossMapCrossSectionSweep

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.

CACStrandPostprocBatchpostprocLossMapCrossSection

Module: DataFiQuSConductorAC_Strand

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.

CACStrandPostprocBatchpostprocLossMapCrossSectionSweep

Module: DataFiQuSConductorAC_Strand

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.

CACStrandPostprocBatchpostprocPlot2d

Module: DataFiQuSConductorAC_Strand

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_pgfdata	bool	False	Set True to export the plot data in pgfplot readable .txt format stored in output_folder. Currently only supports combined plots.
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 dot notation 'simulation.' E.g. 'simulation.f' will create a 2D plot with sine source frequency on the x-axis. 'simulation.time' will create a plot with time on the x-axis.
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 dot notation 'simulation.' E.g. total AC-loss per cycle can be accessed as ['simulation.total_power_per_cycle['TotalLoss_dyn']'].
y_val_fluxmodel	Optional[str]	null	Attribute of the 'ROHFmodel' class which is plotted on the y-axis. Access via dot notation with 'fluxmodel.' and 'simulation.' E.g. ROHF computed flux - 'fluxmodel.compute(I=simulation.I_transport,time=simulation.time)[0]'
reference_vals	Optional[list]	null	reference values as set of two list [xvals, yvals] which will be plotted in the combined plot (For reference curves)
reference_label	Optional[str]	null	label text for the reference data in the plot legend
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.

CACStrandPostprocBatchpostprocROHFgrid

Module: DataFiQuSConductorAC_Strand

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

Fields

Field	Type	Default	Description
produce_error_map	bool	False	Set True to produce a error map of the definced error_type. If the fit_rohf option is enabled it will compute the map for the new ROHF model ignoring everything in the fluxmodel.csv.
interpolate_error_map	bool	False	Interpolate colormap linear between the computed values (graphical purposes)
error_type	str	"pc_loss"	realtive error metric displayed by the map. Options: pc_loss, flux, dyn_loss
fit_rohf	bool	False	Fit a ROHF model on the simulation grid given in the simulation.csv
fit_rohf_N	Optional[int]	7	Number of ROHF cells to use for the fit. Default is 7.
fit_rohf_tausweep_IIC	Optional[float]	1.0	I/Ic ratio used to fit the ratedependence parameters (taus).

CACStrandPostprocBatchpostprocSort

Module: DataFiQuSConductorAC_Strand

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.

CACStrandPostprocCleanup

Module: DataFiQuSConductorAC_Strand

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.

CACStrandPostprocPlotFlux

Module: DataFiQuSConductorAC_Strand

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

Fields

Field	Type	Default	Description
show	Optional[bool]	False	Enable flux related plots.
rohf	Optional[bool]	False	Enable ROHF model.
rohf_file	Optional[str]	null	Name of a .txt file in the geometry folder containing tau, kappa and alpha values. The file has to be structured into three columns (separated by whitespaces) with the preliminary header-row 'taus kappas alphas'. Each row corresponds to one cell of the multicell ROHF model.
rohf_N	Optional[int]	null	Total number of cells (N) for the ROHF model. If a parameter_file_name is given this option will be disregarded in favour of the parameterfile definitions.
rohf_kappa_spacing	Optional[str]	null	Spacing strategy for the N kappa values of the ROHF model. Options: 'linear', 'log', 'invlog' if left blank it will set the kappa interval based on a error minimization. If a parameter_file_name is given this option will be disregarded in favour of the parameterfile definitions.

CACStrandPostprocPlotInstPower

Module: DataFiQuSConductorAC_Strand

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.

CACStrandPostprocPosFiles

Module: DataFiQuSConductorAC_Strand

Description: Level 3: Class for cleanup settings

Fields

Field	Type	Default	Description
quantities	Optional[list]	null	List of GetDP postprocessing quantity to write to .pos file. Examples of valid entry is: phi, h, b, b_reaction, j, jz, jc, power_filaments, power_matrix, sigma_matrix, j_plane, v_plane, hsVal
regions	Optional[list]	null	List of GetDP region to to write to .pos file postprocessing for. Examples of valid entry is: Matrix, Filaments, Omega (full domain), OmegaC (conducting domain), OmegaCC (non conducting domain)

CACStrandSolve

Module: DataFiQuSConductorAC_Strand

Description: Level 2: Class for FiQuS ConductorAC Strand solver settings

Fields

Field	Type	Default	Description
pro_template	Optional[str]	"CAC_Strand_template.pro"	Name of the .pro template file.
conductor_name	Optional[str]	null	Name of the conductor. Must match a conductor name in the conductors section of the input YAML-file.
formulation_parameters	CACStrandSolveFormulationparameters	CACStrandSolveFormulationparameters()
general_parameters	CACStrandSolveGeneralparameters	CACStrandSolveGeneralparameters()
initial_conditions	CACStrandSolveInitialconditions	CACStrandSolveInitialconditions()
diffusion_barriers	CACStrandSolveDiffusionBarriers	CACStrandSolveDiffusionBarriers()
global_diffusion_barrier	CACStrandSolveDiffusionBarriers	CACStrandSolveDiffusionBarriers()	Additional diffusion barrier around all filaments together (global).This is created on a line between two strand matrix regions.One around the filaments and the other for the external ring.
source_parameters	CACStrandSolveSourceparameters	CACStrandSolveSourceparameters()
numerical_parameters	CACStrandSolveNumericalparameters	CACStrandSolveNumericalparameters()

Nested Models

CACStrandSolveDiffusionBarriers

Field	Type	Default	Description
enable	Optional[bool]	False	Set True to enable diffusion barriers.
load_data_from_yaml	Optional[bool]	False	Set True to load the diffusion barrier data from the input YAML-file. Otherwise, the thickness and resistivity specified in this file are used.
resistivity	Optional[float]	1e-06	Resistivity of the diffusion barriers (Ohm*m).
thickness	Optional[float]	1e-06	Thickness of the diffusion barriers (m).

CACStrandSolveFormulationparameters

Description: Level 3: Class for finite element formulation parameters

Field	Type	Default	Description
formulation	Literal[str]	"CATI"	Which formulation? CATI is the default and usual choice to model hysteresis/coupling/eddy currents with the CATI method. AI_uncoupled is a conventional 2D formulation with axial currents modelling UNCOUPLED filaments (and eddy currents in matrix). Available inputs: "CATI", "AI_uncoupled"
dynamic_correction	Optional[bool]	True	With the CATI method, do we activate the dynamic correction?
compute_temperature	Optional[bool]	False	Do we compute the temperature?
two_ell_periodicity	Optional[bool]	True	With CATI method: True to integrate over twice the shortest periodicity length (recommended), False to integrate over the shortest periodicity length (not recommended).

CACStrandSolveGeneralparameters

Description: Level 3: Class for general parameters

Field	Type	Default	Description
temperature	float	1.9	Temperature (K) of the strand.
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.

CACStrandSolveInitialconditions

Description: Level 3: Class for initial conditions

Field	Type	Default	Description
init_type	Optional[Literal[str]]	"virgin"	Type of initialization for the simulation. (i) 'virgin' is the default type, the initial magnetic field is zero, (ii) 'pos_file' is to initialize from the solution of another solution, given by the solution_to_init_from entry, and (iii) 'uniform_field' is to initialize at a uniform field, which will be the applied field at the initial time of the simulation. Note that the uniform_field option does not allow any non-zero transport current. Available inputs: "virgin", "pos_file", "uniform_field"
solution_to_init_from	Optional[int | str]	null	Name xxx of the solution from which the simulation should be initialized. The file last_magnetic_field.pos of folder Solution_xxx will be used for the initial solution. It must be in the Geometry_xxx/Mesh_xxx/ folder in which the Solution_xxx will be saved.

CACStrandSolveNumericalparameters

Description: Level 3: Class for numerical parameters

Field	Type	Default	Description
sine	CACStrandSolveNumericalparametersSine	CACStrandSolveNumericalparametersSine()
piecewise	CACStrandSolveNumericalparametersPiecewise	CACStrandSolveNumericalparametersPiecewise()
rotating	CACStrandSolveNumericalparametersRotating	CACStrandSolveNumericalparametersRotating()

CACStrandSolveNumericalparametersPiecewise

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.

CACStrandSolveNumericalparametersRotating

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 source rotation. Determines the initial time step size.
number_of_periods_to_simulate	Optional[float]	null	Number of periods (-) to simulate for the source rotation.

CACStrandSolveNumericalparametersSine

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.

CACStrandSolveSourceparameters

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, rotating. Available inputs: "sine", "piecewise", "rotating"
sine	CACStrandSolveSourceparametersSine	CACStrandSolveSourceparametersSine()
piecewise	CACStrandSolveSourceparametersPiecewise	CACStrandSolveSourceparametersPiecewise()
rotating	CACStrandSolveSourceparametersRotating	CACStrandSolveSourceparametersRotating()
field_angle	Optional[float]	90	Angle of the source magnetic field, with respect to the x-axis (degrees).

CACStrandSolveSourceparametersPiecewise

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.

CACStrandSolveSourceparametersRotating

Description: Level 4: Class for Rotating magnetic source field parameters

Field	Type	Default	Description
frequency	Optional[float]	null	Frequency of field rotation around z-axis
field_magnitude	Optional[float]	null	constant Magnitude of the rotating field (T).

CACStrandSolveSourceparametersSine

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	CACStrandSolveSourceparametersSineSuperimposedDC	CACStrandSolveSourceparametersSineSuperimposedDC()

CACStrandSolveSourceparametersSineSuperimposedDC

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), in the same direction as the AC applied field. Solution must be initialized with a non-zero field solution, either stored in a .pos file, or a uniform field, if non-zero DC field is used.
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.

CACStrandSolveDiffusionBarriers

Module: DataFiQuSConductorAC_Strand

Fields

Field	Type	Default	Description
enable	Optional[bool]	False	Set True to enable diffusion barriers.
load_data_from_yaml	Optional[bool]	False	Set True to load the diffusion barrier data from the input YAML-file. Otherwise, the thickness and resistivity specified in this file are used.
resistivity	Optional[float]	1e-06	Resistivity of the diffusion barriers (Ohm*m).
thickness	Optional[float]	1e-06	Thickness of the diffusion barriers (m).

CACStrandSolveFormulationparameters

Module: DataFiQuSConductorAC_Strand

Description: Level 3: Class for finite element formulation parameters

Fields

Field	Type	Default	Description
formulation	Literal[str]	"CATI"	Which formulation? CATI is the default and usual choice to model hysteresis/coupling/eddy currents with the CATI method. AI_uncoupled is a conventional 2D formulation with axial currents modelling UNCOUPLED filaments (and eddy currents in matrix). Available inputs: "CATI", "AI_uncoupled"
dynamic_correction	Optional[bool]	True	With the CATI method, do we activate the dynamic correction?
compute_temperature	Optional[bool]	False	Do we compute the temperature?
two_ell_periodicity	Optional[bool]	True	With CATI method: True to integrate over twice the shortest periodicity length (recommended), False to integrate over the shortest periodicity length (not recommended).

CACStrandSolveGeneralparameters

Module: DataFiQuSConductorAC_Strand

Description: Level 3: Class for general parameters

Fields

Field	Type	Default	Description
temperature	float	1.9	Temperature (K) of the strand.
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.

CACStrandSolveInitialconditions

Module: DataFiQuSConductorAC_Strand

Description: Level 3: Class for initial conditions

Fields

Field	Type	Default	Description
init_type	Optional[Literal[str]]	"virgin"	Type of initialization for the simulation. (i) 'virgin' is the default type, the initial magnetic field is zero, (ii) 'pos_file' is to initialize from the solution of another solution, given by the solution_to_init_from entry, and (iii) 'uniform_field' is to initialize at a uniform field, which will be the applied field at the initial time of the simulation. Note that the uniform_field option does not allow any non-zero transport current. Available inputs: "virgin", "pos_file", "uniform_field"
solution_to_init_from	Optional[int | str]	null	Name xxx of the solution from which the simulation should be initialized. The file last_magnetic_field.pos of folder Solution_xxx will be used for the initial solution. It must be in the Geometry_xxx/Mesh_xxx/ folder in which the Solution_xxx will be saved.

CACStrandSolveNumericalparameters

Module: DataFiQuSConductorAC_Strand

Description: Level 3: Class for numerical parameters

Fields

Field	Type	Default	Description
sine	CACStrandSolveNumericalparametersSine	CACStrandSolveNumericalparametersSine()
piecewise	CACStrandSolveNumericalparametersPiecewise	CACStrandSolveNumericalparametersPiecewise()
rotating	CACStrandSolveNumericalparametersRotating	CACStrandSolveNumericalparametersRotating()

Nested Models

CACStrandSolveNumericalparametersPiecewise

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.

CACStrandSolveNumericalparametersRotating

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 source rotation. Determines the initial time step size.
number_of_periods_to_simulate	Optional[float]	null	Number of periods (-) to simulate for the source rotation.

CACStrandSolveNumericalparametersSine

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.

CACStrandSolveNumericalparametersPiecewise

Module: DataFiQuSConductorAC_Strand

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.

CACStrandSolveNumericalparametersRotating

Module: DataFiQuSConductorAC_Strand

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 source rotation. Determines the initial time step size.
number_of_periods_to_simulate	Optional[float]	null	Number of periods (-) to simulate for the source rotation.

CACStrandSolveNumericalparametersSine

Module: DataFiQuSConductorAC_Strand

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.

CACStrandSolveSourceparameters

Module: DataFiQuSConductorAC_Strand

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, rotating. Available inputs: "sine", "piecewise", "rotating"
sine	CACStrandSolveSourceparametersSine	CACStrandSolveSourceparametersSine()
piecewise	CACStrandSolveSourceparametersPiecewise	CACStrandSolveSourceparametersPiecewise()
rotating	CACStrandSolveSourceparametersRotating	CACStrandSolveSourceparametersRotating()
field_angle	Optional[float]	90	Angle of the source magnetic field, with respect to the x-axis (degrees).

Nested Models

CACStrandSolveSourceparametersPiecewise

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.

CACStrandSolveSourceparametersRotating

Description: Level 4: Class for Rotating magnetic source field parameters

Field	Type	Default	Description
frequency	Optional[float]	null	Frequency of field rotation around z-axis
field_magnitude	Optional[float]	null	constant Magnitude of the rotating field (T).

CACStrandSolveSourceparametersSine

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	CACStrandSolveSourceparametersSineSuperimposedDC	CACStrandSolveSourceparametersSineSuperimposedDC()

CACStrandSolveSourceparametersSineSuperimposedDC

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), in the same direction as the AC applied field. Solution must be initialized with a non-zero field solution, either stored in a .pos file, or a uniform field, if non-zero DC field is used.
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.

CACStrandSolveSourceparametersPiecewise

Module: DataFiQuSConductorAC_Strand

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.

CACStrandSolveSourceparametersRotating

Module: DataFiQuSConductorAC_Strand

Description: Level 4: Class for Rotating magnetic source field parameters

Fields

Field	Type	Default	Description
frequency	Optional[float]	null	Frequency of field rotation around z-axis
field_magnitude	Optional[float]	null	constant Magnitude of the rotating field (T).

CACStrandSolveSourceparametersSine

Module: DataFiQuSConductorAC_Strand

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	CACStrandSolveSourceparametersSineSuperimposedDC	CACStrandSolveSourceparametersSineSuperimposedDC()

Nested Models

CACStrandSolveSourceparametersSineSuperimposedDC

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), in the same direction as the AC applied field. Solution must be initialized with a non-zero field solution, either stored in a .pos file, or a uniform field, if non-zero DC field is used.
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.

CACStrandSolveSourceparametersSineSuperimposedDC

Module: DataFiQuSConductorAC_Strand

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), in the same direction as the AC applied field. Solution must be initialized with a non-zero field solution, either stored in a .pos file, or a uniform field, if non-zero DC field is used.
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.