{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://catalog.lintel.tools/schemas/schemastore/fiqus/latest.json", "title": "FDM", "description": "Class for FiQuS", "x-lintel": { "source": "https://gitlab.cern.ch/steam/fiqus/-/raw/master/docs/schema.json", "sourceSha256": "57c3918f40f5d88cb06a5decf534a4a775ade7971cc6271f661828e84ffa0921", "fileMatch": [ "*_fiqus.json", "*_fiqus.json5", "*_fiqus.yaml", "*_fiqus.yml", "*_FiQuS.json", "*_FiQuS.json5", "*_FiQuS.yaml", "*_FiQuS.yml" ], "parsers": [ "json", "json5", "yaml" ] }, "type": "object", "properties": { "general": { "$ref": "#/$defs/GeneralFiQuS", "default": { "magnet_name": null } }, "run": { "$ref": "#/$defs/RunFiQuS", "default": { "type": "start_from_yaml", "geometry": null, "mesh": null, "solution": null, "launch_gui": false, "overwrite": false, "comments": "", "verbosity_Gmsh": 5, "verbosity_GetDP": 5, "verbosity_FiQuS": true } }, "magnet": { "default": { "type": "multipole", "geometry": { "electromagnetics": { "areas": [], "create": true, "symmetry": "none", "with_wedges": true }, "geom_file_path": null, "plot_preview": false, "thermal": { "areas": [], "correct_block_coil_tsa_checkered_scheme": false, "create": true, "use_TSA": false, "use_TSA_new": false, "with_wedges": true } }, "mesh": { "electromagnetics": { "bore_field": { "DistMax": null, "DistMin": null, "SizeMax": null, "SizeMin": null, "enabled": false }, "collar": { "DistMax": null, "DistMin": null, "Enforce_TSA_mapping": false, "SizeMax": null, "SizeMin": null, "enabled": false }, "conductors": { "field": { "DistMax": null, "DistMin": null, "SizeMax": null, "SizeMin": null, "enabled": false }, "transfinite": { "curve_target_size_height": 1.0, "curve_target_size_width": 1.0, "enabled_for": null } }, "create": true, "iron_field": { "DistMax": null, "DistMin": null, "SizeMax": null, "SizeMin": null, "enabled": false }, "poles": { "DistMax": null, "DistMin": null, "SizeMax": null, "SizeMin": null, "enabled": false }, "wedges": { "field": { "DistMax": null, "DistMin": null, "SizeMax": null, "SizeMin": null, "enabled": false }, "transfinite": { "curve_target_size_height": 1.0, "curve_target_size_width": 1.0, "enabled_for": null } } }, "thermal": { "collar": { "DistMax": null, "DistMin": null, "Enforce_TSA_mapping": false, "SizeMax": null, "SizeMin": null, "enabled": false }, "conductors": { "field": { "DistMax": null, "DistMin": null, "SizeMax": null, "SizeMin": null, "enabled": false }, "transfinite": { "curve_target_size_height": 1.0, "curve_target_size_width": 1.0, "enabled_for": null } }, "create": true, "insulation": { "TSA": { "global_size_COL": 0.0001, "global_size_QH": 0.0001, "minimum_discretizations": 1, "minimum_discretizations_COL": 1, "minimum_discretizations_QH": 1, "scale_factor_azimuthal": -1.0, "scale_factor_radial": -1.0 }, "global_size": 0.0001 }, "iron_field": { "DistMax": null, "DistMin": null, "SizeMax": null, "SizeMin": null, "enabled": false }, "isothermal_conductors": false, "isothermal_wedges": false, "poles": { "DistMax": null, "DistMin": null, "SizeMax": null, "SizeMin": null, "enabled": false }, "reference": { "DistMax": null, "DistMin": null, "SizeMax": null, "SizeMin": null, "enabled": false }, "wedges": { "field": { "DistMax": null, "DistMin": null, "SizeMax": null, "SizeMin": null, "enabled": false }, "transfinite": { "curve_target_size_height": 1.0, "curve_target_size_width": 1.0, "enabled_for": null } } } }, "solve": { "cable_homogenization": { "enabled": false, "rohf": { "enabled": false, "gather_cell_systems": false, "parameter_csv_file": null }, "rohm": { "enabled": false, "gather_cell_systems": false, "parameter_csv_file": null, "tau_scaling": 1.0, "weight_scaling": 1.0 }, "run_type": { "mode": "ramp", "ramp_file": null } }, "coil_windings": { "conductor_to_group": [], "electrical_pairs": { "group_together": [], "overwrite_electrical_order": [], "reversed": [] }, "group_to_coil_section": [], "half_turn_length": [], "polarities_in_group": [] }, "collar": { "RRR": null, "T_ref_RRR_high": null, "material": null, "transient_effects_enabled": false }, "electromagnetics": { "non_linear_solver": { "abs_tolerance": 0.1, "max_iterations": 20, "norm_type": "LinfNorm", "rel_tolerance": 0.0001, "relaxation_factor": 0.7 }, "solve_type": null, "time_stepping": { "T_sim": 1.9, "abs_tol_time": 0.0001, "breakpoints": [], "final_time": 0.0, "initial_time": 0.0, "initial_time_step": 1e-10, "integration_method": "Euler", "max_time_step": 10.0, "min_time_step": 1e-12, "norm_type": "LinfNorm", "rel_tol_time": 0.0001 } }, "iron_yoke": { "RRR": null, "T_ref_RRR_high": null, "material": null, "transient_effects_enabled": false }, "noOfMPITasks": false, "poles": { "RRR": null, "T_ref_RRR_high": null, "material": null, "transient_effects_enabled": false }, "thermal": { "He_cooling": { "enabled": false, "heat_transfer_coefficient": 0.0, "sides": "outer" }, "collar_cooling": { "enabled": false, "heat_transfer_coefficient": "CFUN_hHe_T_THe", "move_cooling_holes": null, "ref_temperature": 0.0, "which": "all" }, "enforce_init_temperature_as_minimum": false, "init_temperature": 1.9, "insulation_TSA": { "between_collar": { "material": null }, "block_to_block": { "blocks_connection_overwrite": [], "material": null, "materials_overwrite": [], "thicknesses_overwrite": [] }, "exterior": { "blocks": [], "materials_append": [], "thicknesses_append": [] } }, "jc_degradation_to_zero": { "t_trigger": [], "turns": [] }, "non_linear_solver": { "abs_tolerance": 0.1, "max_iterations": 20, "norm_type": "LinfNorm", "rel_tolerance": 0.0001, "relaxation_factor": 0.7 }, "overwrite_boundary_conditions": { "cooling": {}, "heat_flux": {}, "temperature": {} }, "solve_type": null, "time_stepping": { "abs_tol_time": 0.0001, "breakpoints": [], "final_time": 0.0, "initial_time": 0.0, "initial_time_step": 1e-10, "integration_method": "Euler", "max_time_step": 10.0, "min_time_step": 1e-12, "norm_type": "LinfNorm", "rel_tol_time": 0.0001, "stop_temperature": 300.0 } }, "time_stepping": { "abs_tol_time": [ 0.0001, 0.0001 ], "breakpoints": [], "final_time": 0.0, "initial_time": 0.0, "initial_time_step": 1e-10, "integration_method": "Euler", "max_time_step": 10.0, "min_time_step": 1e-12, "norm_type": [ "LinfNorm", "LinfNorm" ], "rel_tol_time": [ 0.0001, 0.0001 ], "seq_NL": true, "stop_temperature": 300.0 }, "wedges": { "RRR": null, "T_ref_RRR_high": null, "material": null, "transient_effects_enabled": false } }, "postproc": { "circuit_coupling": { "assemble_veusz": false, "variables_I": [], "variables_U": [] }, "electromagnetics": { "compare_to_ROXIE": null, "output_time_steps_pos": true, "output_time_steps_txt": true, "plot_all": false, "save_pos_at_the_end": true, "save_txt_at_the_end": false, "variables": [], "volumes": [] }, "thermal": { "output_time_steps_pos": true, "output_time_steps_txt": true, "plot_all": false, "save_pos_at_the_end": true, "save_txt_at_the_end": false, "take_average_conductor_temperature": true, "variables": [ "T" ], "volumes": [ "powered" ] } } }, "discriminator": { "mapping": { "CACCC": "#/$defs/CACCC", "CACRutherford": "#/$defs/CACRutherford", "CACStrand": "#/$defs/CACStrand", "CCT_straight": "#/$defs/CCT", "HomogenizedConductor": "#/$defs/fiqus__data__DataFiQuSHomogenizedConductor__HomogenizedConductor", "Pancake3D": "#/$defs/Pancake3D", "multipole": "#/$defs/Multipole" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/Multipole" }, { "$ref": "#/$defs/CCT" }, { "$ref": "#/$defs/Pancake3D" }, { "$ref": "#/$defs/CACStrand" }, { "$ref": "#/$defs/fiqus__data__DataFiQuSHomogenizedConductor__HomogenizedConductor" }, { "$ref": "#/$defs/CACRutherford" }, { "$ref": "#/$defs/CACCC" } ], "title": "Magnet" }, "circuit": { "$ref": "#/$defs/Circuit_Class", "default": { "field_circuit": false, "R_circuit": null, "L_circuit": null, "R_parallel": null } }, "power_supply": { "$ref": "#/$defs/PowerSupplyClass", "default": { "I_initial": null, "t_off": null, "t_control_LUT": [], "I_control_LUT": [], "R_crowbar": 0.0, "L_crowbar": 0.0, "Ud_crowbar": 0.0, "R_c_r": 0.0, "L_c_r": 0.0, "Ud_c_r": 0.0, "R_1": 0.0, "L_1": 0.0, "R_2": 0.0, "L_2": 0.0, "C": 0.0, "R_3": 0.0, "L_3": 0.0 } }, "quench_protection": { "$ref": "#/$defs/QuenchProtection", "default": { "energy_extraction": { "C": 0.0, "C_n": 0.0, "L": 0.0, "L_c": 0.0, "L_c_n": 0.0, "L_n": 0.0, "L_s": 0.0, "L_s_n": 0.0, "R_EE": 0.0, "R_EE_n": 0.0, "R_c": 0.0, "R_c_n": 0.0, "R_s": 0.0, "R_s_n": 0.0, "Ud_snubber": 0.0, "Ud_snubber_n": 0.0, "Ud_switch": 0.0, "Ud_switch_n": 0.0, "power_R_EE": 0.0, "power_R_EE_n": 0.0, "t_trigger": 99999.0, "t_trigger_n": 99999.0 }, "quench_heaters": { "C": [], "L_QH_offset": [], "NZPV_multiplier": 1.0, "N_strips": null, "R_warm": [], "U0": [], "f_cover": [], "h": [], "iQH_toHalfTurn_From": [], "iQH_toHalfTurn_To": [], "l": [], "l_copper": [], "l_stainless_steel": [], "quench_prop_model": "Ts", "quench_propagation": "full", "s_ins": [], "s_ins_He": [], "t_trigger": [], "turns_sides": [], "type_ins": [], "type_ins_He": [], "w": [] }, "cliq": { "C": 0.0, "I0": null, "L": 0.0, "N_units": null, "R": 0.0, "U0": 0.0, "current_direction": [], "sym_factor": null, "t_trigger": 99999.0 }, "esc": { "C": [], "L": [], "L_Diode": [], "R_leads": [], "R_unit": [], "U0": [], "Ud_Diode": [], "t_trigger": [] }, "e_cliq": { "L_ecliq_offset": [], "L_leads": null, "NZPV_multiplier": 1.0, "N_units": [], "R_leads": null, "h_ecliq": [], "iECLIQ_toHalfTurn_From": [], "iECLIQ_toHalfTurn_To": [], "l_ecliq": [], "piecewise": { "csv_file": null, "current_multiplier": null, "currents": null, "time_multiplier": null, "times": null }, "quench_prop_model": "Ts", "quench_propagation": "full", "sine": { "current_amplitude": null, "frequency": null, "number_of_periods": null, "number_of_turns": null }, "source_type": null, "t_trigger": [] } } }, "quench_detection": { "$ref": "#/$defs/QuenchDetection", "default": { "voltage_thresholds": null, "discrimination_times": null, "voltage_tap_pairs": null } }, "conductors": { "type": "object", "default": {}, "title": "Conductors", "additionalProperties": { "$ref": "#/$defs/Conductor" } } }, "$defs": { "Air_g": { "description": "Level 2: Class for FiQuS CCT", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "sh_type": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Sh Type" }, "ar": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Ar" }, "z_min": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Z Min" }, "z_max": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Z Max" } }, "title": "Air_g", "type": "object" }, "Air_s": { "description": "Level 2: Class for FiQuS CCT", "properties": { "sigma": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Sigma" }, "mu_r": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Mu R" } }, "title": "Air_s", "type": "object" }, "BSCCO_2212_LBNL": { "description": "Level 3: Class for cable Bi-2212 fit developed in LBNL", "properties": { "type": { "const": "BSCCO_2212_LBNL", "title": "Type", "type": "string" }, "f_scaling_Jc_BSCCO2212": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "F Scaling Jc Bscco2212" } }, "required": [ "type" ], "title": "BSCCO_2212_LBNL", "type": "object" }, "Bordini": { "description": "Level 3: Class for cable Bordini's Nb3Sn fit", "properties": { "type": { "const": "Bordini", "title": "Type", "type": "string" }, "Tc0_Bordini": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Tc0 Bordini" }, "Bc20_Bordini": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Bc20 Bordini" }, "C0_Bordini": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "C0 Bordini" }, "alpha_Bordini": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Alpha Bordini" } }, "required": [ "type" ], "title": "Bordini", "type": "object" }, "Bottura": { "description": "Level 3: Class for setting Bottura fit", "properties": { "type": { "const": "Bottura", "title": "Type", "type": "string" }, "Tc0_Bottura": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Tc0 Bottura" }, "Bc20_Bottura": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Bc20 Bottura" }, "Jc_ref_Bottura": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Jc Ref Bottura" }, "C0_Bottura": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "C0 Bottura" }, "alpha_Bottura": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Alpha Bottura" }, "beta_Bottura": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Beta Bottura" }, "gamma_Bottura": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Gamma Bottura" } }, "required": [ "type" ], "title": "Bottura", "type": "object" }, "CACCC": { "description": "Level 1: Class for FiQuS CACCC", "properties": { "type": { "const": "CACCC", "title": "Type", "type": "string" }, "geometry": { "$ref": "#/$defs/CACCCGeometry", "default": { "air_radius": null } }, "mesh": { "$ref": "#/$defs/CACCCMesh", "default": { "HTS_n_elem_width": null, "HTS_n_elem_thickness": null, "substrate_elem_scale": null, "substrate_side_progression": null, "silver_elem_scale": null, "copper_elem_scale": null, "air_boundary_mesh_size_ratio": null, "scaling_global": null, "bump_coef": null } }, "solve": { "$ref": "#/$defs/CACCCSolve", "default": { "pro_template": "CAC_CC_template.pro", "conductor_name": null, "general_parameters": { "noOfMPITasks": false, "temperature": 1.9 }, "initial_conditions": { "init_type": "virgin", "solution_to_init_from": null }, "source_parameters": { "field_angle_with_respect_to_normal_direction": null, "piecewise": { "applied_field_multiplier": null, "applied_fields_relative": null, "source_csv_file": null, "time_multiplier": null, "times": null, "transport_current_multiplier": null, "transport_currents_relative": null }, "sine": { "current_amplitude": null, "field_amplitude": null, "frequency": null }, "source_type": "sine" }, "numerical_parameters": { "piecewise": { "force_stepping_at_times_piecewise_linear": false, "max_timestep_piecewise_linear": null, "time_to_simulate": null, "times_max_timestep_piecewise_linear": null, "timesteps_per_time_to_simulate": null, "variable_max_timestep": false }, "relative_tolerance": 1e-6, "relaxation_factors": true, "sine": { "number_of_periods_to_simulate": null, "timesteps_per_period": null }, "voltage_per_meter_stopping_criterion": null } } }, "postproc": { "$ref": "#/$defs/CACCCPostproc", "default": { "pos_files": { "quantities": [], "regions": [] }, "cleanup": { "remove_msh_file": false, "remove_pre_file": false, "remove_res_file": false } } } }, "required": [ "type" ], "title": "CACCC", "type": "object" }, "CACCCGeneralparameters": { "description": "Level 3: Class for general parameters", "properties": { "temperature": { "default": 1.9, "description": "Temperature (K).", "title": "Temperature", "type": "number" }, "noOfMPITasks": { "oneOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "null" } ], "default": false, "description": "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.", "title": "No. of tasks for MPI parallel run of GetDP" } }, "title": "CACCCGeneralparameters", "type": "object" }, "CACCCGeometry": { "description": "Level 2: Geometry for CACCC.", "properties": { "air_radius": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Radius of air region.", "title": "Air Radius" } }, "title": "CACCCGeometry", "type": "object" }, "CACCCMesh": { "description": "Level 2: Mesh parameters for CACCC.", "properties": { "HTS_n_elem_width": { "oneOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of elements along HTS width (x-direction).", "title": "Hts N Elem Width" }, "HTS_n_elem_thickness": { "oneOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of elements through HTS thickness (y-direction).", "title": "Hts N Elem Thickness" }, "substrate_elem_scale": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Element-count scale factor for substrate layer.", "title": "Substrate Elem Scale" }, "substrate_side_progression": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Progression factor for substrate vertical sides near the HTS side.", "title": "Substrate Side Progression" }, "silver_elem_scale": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Element-count scale factor for silver layers.", "title": "Silver Elem Scale" }, "copper_elem_scale": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Element-count scale factor for copper layers.", "title": "Copper Elem Scale" }, "air_boundary_mesh_size_ratio": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Ratio of air outer-boundary mesh size to the HTS base size.", "title": "Air Boundary Mesh Size Ratio" }, "scaling_global": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Global refinement factor.", "title": "Scaling Global" }, "bump_coef": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Unified bump coefficient for transfinite horizontal edges. Used for both HTS and SilverTop when applying 'Bump' distributions. Values < 1 cluster nodes toward the edges; values > 1 cluster toward the center.", "title": "Bump Coef" } }, "title": "CACCCMesh", "type": "object" }, "CACCCPostproc": { "description": "Post-processing options for CACCC", "properties": { "pos_files": { "$ref": "#/$defs/CACCCPostprocPosFiles", "default": { "quantities": [], "regions": [] }, "description": "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." }, "cleanup": { "$ref": "#/$defs/CWSStrandPostprocCleanup", "default": { "remove_pre_file": false, "remove_res_file": false, "remove_msh_file": false } } }, "title": "CACCCPostproc", "type": "object" }, "CACCCPostprocPosFiles": { "description": "Level 3: Class for post-pro .pos file requests", "properties": { "quantities": { "oneOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of GetDP postprocessing quantities to write to .pos file. Examples of valid entry is: phi, h, b, j, jz, power", "title": "Quantities" }, "regions": { "oneOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of GetDP regions to write to .pos file postprocessing for. Examples of a valid entry is: Matrix, Filaments, Omega (full domain), OmegaC (conducting domain), OmegaCC (non conducting domain)", "title": "Regions" } }, "title": "CACCCPostprocPosFiles", "type": "object" }, "CACCCSolve": { "description": "Level 2: Solve block for CACCC", "properties": { "pro_template": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": "CAC_CC_template.pro", "description": "Name of the .pro template file.", "title": "Pro Template" }, "conductor_name": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the conductor. Must match a conductor name in the conductors section of the input YAML-file.", "title": "Conductor Name" }, "general_parameters": { "$ref": "#/$defs/CACCCGeneralparameters", "default": { "temperature": 1.9, "noOfMPITasks": false } }, "initial_conditions": { "$ref": "#/$defs/CACCCSolveInitialconditions", "default": { "init_type": "virgin", "solution_to_init_from": null } }, "source_parameters": { "$ref": "#/$defs/CACCCSolveSourceparameters", "default": { "source_type": "sine", "sine": { "current_amplitude": null, "field_amplitude": null, "frequency": null }, "piecewise": { "applied_field_multiplier": null, "applied_fields_relative": null, "source_csv_file": null, "time_multiplier": null, "times": null, "transport_current_multiplier": null, "transport_currents_relative": null }, "field_angle_with_respect_to_normal_direction": null } }, "numerical_parameters": { "$ref": "#/$defs/CACCCSolveNumericalparameters", "default": { "relative_tolerance": 1e-6, "voltage_per_meter_stopping_criterion": null, "relaxation_factors": true, "sine": { "number_of_periods_to_simulate": null, "timesteps_per_period": null }, "piecewise": { "force_stepping_at_times_piecewise_linear": false, "max_timestep_piecewise_linear": null, "time_to_simulate": null, "times_max_timestep_piecewise_linear": null, "timesteps_per_time_to_simulate": null, "variable_max_timestep": false } } } }, "title": "CACCCSolve", "type": "object" }, "CACCCSolveInitialconditions": { "description": "Level 3: Class for initial conditions", "properties": { "init_type": { "oneOf": [ { "enum": [ "virgin", "pos_file", "uniform_field" ], "type": "string" }, { "type": "null" } ], "default": "virgin", "description": "Type of initialization for the simulation. (i) 'virgin' is the default type, the initial magnetic field is zero,(ii) 'pos_file' is to initialize from the solution of another solution, given by the solution_to_init_from entry, and (iii) 'uniform_field' is to initialize at a uniform field, which will be the applied field at the initial time of the simulation. Note that the uniform_field option does not allow any non-zero transport current (initialization from pos_file is needed for this).", "title": "Init Type" }, "solution_to_init_from": { "oneOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name xxx of the solution from which the simulation should be initialized. The file last_magnetic_field.pos of folder Solution_xxx will be used for the initial solution.It must be in the Geometry_.../Mesh_.../ folder in which the Solution_xxx will be saved.", "title": "Solution To Init From" } }, "title": "CACCCSolveInitialconditions", "type": "object" }, "CACCCSolveNumericalparameters": { "description": "Level 3: Class for numerical parameters", "properties": { "relative_tolerance": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": 1e-6, "description": "Tolerance on the relative change of the power indicator for the convergence criterion (1e-6 is usually a safe choice).", "title": "Relative Tolerance" }, "voltage_per_meter_stopping_criterion": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "If a non-zero value is given, the simulation will stop if the transport voltage per meter reaches this value (in absolute value).", "title": "Voltage Per Meter Stopping Criterion" }, "relaxation_factors": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Use of relaxation factors to help convergence (automatic selection based on the lowest residual).", "title": "Relaxation Factors" }, "sine": { "$ref": "#/$defs/CACCCSolveNumericalparametersSine", "default": { "timesteps_per_period": null, "number_of_periods_to_simulate": null } }, "piecewise": { "$ref": "#/$defs/CACCCSolveNumericalparametersPiecewise", "default": { "time_to_simulate": null, "timesteps_per_time_to_simulate": null, "force_stepping_at_times_piecewise_linear": false, "variable_max_timestep": false, "times_max_timestep_piecewise_linear": null, "max_timestep_piecewise_linear": null } } }, "title": "CACCCSolveNumericalparameters", "type": "object" }, "CACCCSolveNumericalparametersPiecewise": { "description": "Level 4: Numerical parameters corresponding to the piecewise source", "properties": { "time_to_simulate": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Total time to simulate (s). Used for the piecewise source.", "title": "Time To Simulate" }, "timesteps_per_time_to_simulate": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "If variable_max_timestep is False. Number of time steps (-) per period for the piecewise source.", "title": "Timesteps Per Time To Simulate" }, "force_stepping_at_times_piecewise_linear": { "default": false, "description": "If True, time-stepping will contain exactly the time instants that are inthe times_source_piecewise_linear list (to avoid truncation maximum applied field/current values).", "title": "Force Stepping At Times Piecewise Linear", "type": "boolean" }, "variable_max_timestep": { "default": false, "description": "If False, the maximum time step is kept constant through the simulation. If True, it varies according to the piecewise definition.", "title": "Variable Max Timestep", "type": "boolean" }, "times_max_timestep_piecewise_linear": { "oneOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Time instants (s) defining the piecewise linear maximum time step.", "title": "Times Max Timestep Piecewise Linear" }, "max_timestep_piecewise_linear": { "oneOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Maximum time steps (s) at the times_max_timestep_piecewise_linear. Above the limits, linear extrapolation of the last two values.", "title": "Max Timestep Piecewise Linear" } }, "title": "CACCCSolveNumericalparametersPiecewise", "type": "object" }, "CACCCSolveNumericalparametersSine": { "description": "Level 4: Numerical parameters corresponding to the sine source", "properties": { "timesteps_per_period": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Initial value for number of time steps (-) per period for the sine source.Determines the initial time step size.", "title": "Timesteps Per Period" }, "number_of_periods_to_simulate": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Number of periods (-) to simulate for the sine source.", "title": "Number Of Periods To Simulate" } }, "title": "CACCCSolveNumericalparametersSine", "type": "object" }, "CACCCSolveSourceparameters": { "description": "Level 3: Class for material properties", "properties": { "source_type": { "default": "sine", "description": "Time evolution of applied current and magnetic field. Supported options are: sine, piecewise.", "enum": [ "sine", "piecewise" ], "title": "Source Type", "type": "string" }, "sine": { "$ref": "#/$defs/CACCCSolveSourceparametersSine", "default": { "frequency": null, "field_amplitude": null, "current_amplitude": null } }, "piecewise": { "$ref": "#/$defs/CACCCSolveSourceparametersPiecewise", "default": { "source_csv_file": null, "times": null, "applied_fields_relative": null, "transport_currents_relative": null, "time_multiplier": null, "applied_field_multiplier": null, "transport_current_multiplier": null } }, "field_angle_with_respect_to_normal_direction": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Angle of the source magnetic field with respect to the y-axis (normal to the tape) (degrees).", "title": "Field Angle With Respect To Normal Direction" } }, "title": "CACCCSolveSourceparameters", "type": "object" }, "CACCCSolveSourceparametersPiecewise": { "description": "Level 4: Class for piecewise (linear) source parameters", "properties": { "source_csv_file": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "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.", "title": "Source Csv File" }, "times": { "oneOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Time instants (s) defining the piecewise linear sources.Used only if source_csv_file is not set.Can be scaled by time_multiplier.", "title": "Times" }, "applied_fields_relative": { "oneOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Applied fields relative to multiplier applied_field_multiplier at the time instants 'times'.Used only if source_csv_file is not set.", "title": "Applied Fields Relative" }, "transport_currents_relative": { "oneOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Transport currents relative to multiplier transport_current_multiplier at the time instants 'times'.Used only if source_csv_file is not set.", "title": "Transport Currents Relative" }, "time_multiplier": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Multiplier for the time values in times (scales the time values).Also used for the time values in the source_csv_file.", "title": "Time Multiplier" }, "applied_field_multiplier": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Multiplier for the applied fields in applied_fields_relative.Also used for the values in the source_csv_file.", "title": "Applied Field Multiplier" }, "transport_current_multiplier": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Multiplier for the transport currents in transport_currents_relative.Also used for the values in the source_csv_file.", "title": "Transport Current Multiplier" } }, "title": "CACCCSolveSourceparametersPiecewise", "type": "object" }, "CACCCSolveSourceparametersSine": { "description": "Level 4: Class for Sine source parameters", "properties": { "frequency": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Frequency of the sine source (Hz).", "title": "Frequency" }, "field_amplitude": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Amplitude of the sine field (T).", "title": "Field Amplitude" }, "current_amplitude": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Amplitude of the sine current (A).", "title": "Current Amplitude" } }, "title": "CACCCSolveSourceparametersSine", "type": "object" }, "CACRutherford": { "description": "Level 1: Class for FiQuS ConductorAC", "properties": { "type": { "const": "CACRutherford", "title": "Type", "type": "string" }, "geometry": { "$ref": "#/$defs/CACRutherfordGeometry", "default": { "io_settings": { "load": { "filename": null, "load_from_yaml": null }, "save": { "filename": null, "save_to_yaml": null } }, "point_snap_tolerance_relative_to_strand_diameter": null, "min_roundness_factor": null, "air_radius": null, "coating_corner_arc_radius": 0.0, "coating_thickness": 0.0, "keep_strand_area": true, "excitation_coils": { "centers": null, "heights": null, "widths": null } } }, "mesh": { "$ref": "#/$defs/CACRutherfordMesh", "default": { "scaling_global": 1.0, "strand_mesh_size_ratio": 1.0, "coating_mesh_size_ratio": 1.0, "air_boundary_mesh_size_ratio": 1.0 } }, "solve": { "$ref": "#/$defs/CACRutherfordSolve", "default": { "pro_template": null, "conductor_name": null, "formulation_parameters": { "rohf": true, "rohm": true, "stranded_strands": true }, "general_parameters": { "adjacent_coupling_resistance": 1e-6, "crossing_coupling_resistance": 1e-6, "matrix_resistance": 0.0006536208, "noOfMPITasks": false, "rho_coating": 1e-7, "rho_strands": 1e-12, "superconductor_Ic": 350.0, "superconductor_n_value": 30.0, "temperature": 1.9 }, "initial_conditions": { "init_from_pos_file": false, "pos_file_to_init_from": null }, "frequency_domain_solver": { "enable": false, "frequency_sweep": { "end_frequency": 100.0, "number_of_frequencies": 10, "run_sweep": false, "start_frequency": 1.0 } }, "source_parameters": { "boundary_condition_type": "Natural", "excitation_coils": { "enable": false, "source_csv_file": null }, "parallel_resistor": false, "piecewise": { "applied_field_multiplier": null, "applied_fields_relative": null, "field_angle": 90.0, "source_csv_file": null, "time_multiplier": null, "times": null, "transport_current_multiplier": null, "transport_currents_relative": null }, "sine": { "current_amplitude": null, "field_amplitude": null, "field_angle": 90.0, "frequency": null, "superimposed_DC": { "current_magnitude": 0.0, "field_magnitude": 0.0 } }, "source_type": "sine" }, "numerical_parameters": { "piecewise": { "force_stepping_at_times_piecewise_linear": false, "max_timestep_piecewise_linear": null, "time_to_simulate": null, "times_max_timestep_piecewise_linear": null, "timesteps_per_time_to_simulate": null, "variable_max_timestep": false }, "sine": { "number_of_periods_to_simulate": null, "timesteps_per_period": null } } } }, "postproc": { "$ref": "#/$defs/CACRutherfordPostproc", "default": { "generate_pos_files": true, "plot_instantaneous_power": { "save": false, "save_file_name": "instantaneous_power", "show": false, "title": "Instantaneous Power" }, "compute_current_per_filament": false, "save_last_current_density": null, "save_last_magnetic_field": null, "cleanup": { "remove_msh_file": false, "remove_pre_file": false, "remove_res_file": false }, "batch_postproc": { "filter": { "apply_filter": false, "filter_criterion": null }, "loss_map": { "cross_section": { "axis_to_cut": "x", "cut_value": 0.0, "filename": "cross_section", "plot_cross_section": false, "save_plot": false, "title": null, "ylabel": "Loss" }, "cross_section_sweep": { "animate_cross_section_sweep": false, "axis_to_sweep": "x", "filename": "crossSectionSweep", "save_plot": false, "title": null, "ylabel": "Loss" }, "filename": "loss_map", "loss_log": true, "loss_norm": 1.0, "loss_type": "TotalLoss", "produce_loss_map": false, "save_plot": false, "show_datapoints": true, "show_loss_type_dominance_contour": false, "title": null, "x_log": true, "x_norm": 1.0, "x_steps": 20, "x_val": null, "xlabel": null, "y_log": true, "y_norm": 1.0, "y_steps": 20, "y_val": null, "ylabel": null }, "output_folder": null, "plot2d": { "combined_plot": false, "filename": "plot2d", "labels": null, "legend": true, "linestyle": null, "produce_plot2d": false, "save_plot": false, "title": null, "x_log": false, "x_val": null, "xlabel": null, "y_log": false, "y_vals": null, "ylabel": null }, "postProc_csv": null, "sort": { "apply_sort": false, "sort_key": null } } } } }, "required": [ "type" ], "title": "CACRutherford", "type": "object" }, "CACRutherfordExcitationCoils": { "description": "Level 3: Class for Input/Output settings for the cable geometry", "properties": { "centers": { "oneOf": [ { "items": { "items": { "type": "number" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of center points for the centers of the excitations coil regions. Each center point is a list of three elements for x, y, and z (=0) coordinates.", "title": "Centers" }, "widths": { "oneOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of widths of the excitation coil regions.", "title": "Widths" }, "heights": { "oneOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of heights of the excitation coil regions.", "title": "Heights" } }, "title": "CACRutherfordExcitationCoils", "type": "object" }, "CACRutherfordGeometry": { "description": "Level 2: Class for cable geometry parameters", "properties": { "io_settings": { "$ref": "#/$defs/CACRutherfordIOsettings", "default": { "load": { "filename": null, "load_from_yaml": null }, "save": { "filename": null, "save_to_yaml": null } } }, "point_snap_tolerance_relative_to_strand_diameter": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "The maximum distance between two points, relative to the strand diameter, where the points are considered equal (i.e. they 'snap' together).", "title": "Point Snap Tolerance Relative To Strand Diameter" }, "min_roundness_factor": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Minimum roundness is the ratio between the min -and max radius for the corner circle-arcs.", "title": "Min Roundness Factor" }, "air_radius": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Radius of the air region (m).", "title": "Air Radius" }, "coating_corner_arc_radius": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": 0, "description": "Radius of the corner arcs of the coating (m).", "title": "Coating Corner Arc Radius" }, "coating_thickness": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": 0, "description": "Thickness of the coating (m).", "title": "Coating Thickness" }, "keep_strand_area": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "If True, the area of the strands are determined by the area of the strand described in 'conductors'. If False, the area of the strands are determined based on the cable geometry inputs.", "title": "Keep Strand Area" }, "excitation_coils": { "$ref": "#/$defs/CACRutherfordExcitationCoils", "default": { "centers": null, "widths": null, "heights": null } } }, "title": "CACRutherfordGeometry", "type": "object" }, "CACRutherfordIOsettings": { "description": "Level 3: Class for Input/Output settings for the cable geometry", "properties": { "load": { "$ref": "#/$defs/CACRutherfordIOsettingsLoad", "default": { "load_from_yaml": null, "filename": null } }, "save": { "$ref": "#/$defs/CACRutherfordIOsettingsSave", "default": { "save_to_yaml": null, "filename": null } } }, "title": "CACRutherfordIOsettings", "type": "object" }, "CACRutherfordIOsettingsLoad": { "description": "Level 3: Class for Input/Output settings for the cable geometry", "properties": { "load_from_yaml": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True to load cable geometry from yaml-file, false to create the geometry.", "title": "Load From Yaml" }, "filename": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the file from which to load the cable geometry.", "title": "Filename" } }, "title": "CACRutherfordIOsettingsLoad", "type": "object" }, "CACRutherfordIOsettingsSave": { "description": "Level 3: Class for Input/Output settings for the cable geometry", "properties": { "save_to_yaml": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True to save cable geometry to yaml-file, false to not save the geometry.", "title": "Save To Yaml" }, "filename": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the file to which to save the cable geometry.", "title": "Filename" } }, "title": "CACRutherfordIOsettingsSave", "type": "object" }, "CACRutherfordMesh": { "description": "Level 2: Class for FiQuS ConductorAC", "properties": { "scaling_global": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": 1, "description": "Global scaling factor for mesh size.", "title": "Scaling Global" }, "strand_mesh_size_ratio": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": 1, "description": "Mesh size ratio for the strand, relative to the strand diameter.", "title": "Strand Mesh Size Ratio" }, "coating_mesh_size_ratio": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": 1, "description": "Mesh size ratio for the coating, relative to the strand diameter.", "title": "Coating Mesh Size Ratio" }, "air_boundary_mesh_size_ratio": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "default": 1, "description": "Mesh size ratio for the air boundary, relative to the strand diameter.", "title": "Air Boundary Mesh Size Ratio" } }, "title": "CACRutherfordMesh", "type": "object" }, "CACRutherfordPostproc": { "description": "Level 2: Class for FiQuS ConductorAC", "properties": { "generate_pos_files": { "default": true, "description": "Set True to generate .pos-files during post-processing", "title": "Generate Pos Files", "type": "boolean" }, "plot_instantaneous_power": { "$ref": "#/$defs/CACRutherfordPostprocPlotInstPower", "default": { "show": false, "title": "Instantaneous Power", "save": false, "save_file_name": "instantaneous_power" } }, "compute_current_per_filament": { "default": false, "description": "Computes current in every filament, with decomposition into magnetization and transport current.", "title": "Compute Current Per Filament", "type": "boolean" }, "save_last_current_density": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Saves the last current density field solution (out-of-plane) in the file given as a string. The '.pos' extension will be appended to it. Nothing is done if None. This can be for using the current density as an initial condition (but not implemented yet).", "title": "Save Last Current Density" }, "save_last_magnetic_field": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Saves the last magnetic field solution (in-plane) in the file given as a string. The '.pos' extension will be appended to it. Nothing is done if None. This is for using the magnetic field as an initial condition for another resolution.", "title": "Save Last Magnetic Field" }, "cleanup": { "$ref": "#/$defs/CACRutherfordPostprocCleanup", "default": { "remove_pre_file": false, "remove_res_file": false, "remove_msh_file": false } }, "batch_postproc": { "$ref": "#/$defs/CACRutherfordPostprocBatchpostproc", "default": { "postProc_csv": null, "output_folder": null, "filter": { "apply_filter": false, "filter_criterion": null }, "sort": { "apply_sort": false, "sort_key": null }, "loss_map": { "cross_section": { "axis_to_cut": "x", "cut_value": 0.0, "filename": "cross_section", "plot_cross_section": false, "save_plot": false, "title": null, "ylabel": "Loss" }, "cross_section_sweep": { "animate_cross_section_sweep": false, "axis_to_sweep": "x", "filename": "crossSectionSweep", "save_plot": false, "title": null, "ylabel": "Loss" }, "filename": "loss_map", "loss_log": true, "loss_norm": 1.0, "loss_type": "TotalLoss", "produce_loss_map": false, "save_plot": false, "show_datapoints": true, "show_loss_type_dominance_contour": false, "title": null, "x_log": true, "x_norm": 1.0, "x_steps": 20, "x_val": null, "xlabel": null, "y_log": true, "y_norm": 1.0, "y_steps": 20, "y_val": null, "ylabel": null }, "plot2d": { "combined_plot": false, "filename": "plot2d", "labels": null, "legend": true, "linestyle": null, "produce_plot2d": false, "save_plot": false, "title": null, "x_log": false, "x_val": null, "xlabel": null, "y_log": false, "y_vals": null, "ylabel": null } } } }, "title": "CACRutherfordPostproc", "type": "object" }, "CACRutherfordPostprocBatchpostproc": { "description": "Level 3: Class for batch post-processing settings", "properties": { "postProc_csv": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "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.", "title": "Postproc Csv" }, "output_folder": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Batch post-processing creates a folder with the given name in the output directory, where all the plots are saved.", "title": "Output Folder" }, "filter": { "$ref": "#/$defs/CACRutherfordPostprocBatchpostprocFilter", "default": { "apply_filter": false, "filter_criterion": null } }, "sort": { "$ref": "#/$defs/CACRutherfordPostprocBatchpostprocSort", "default": { "apply_sort": false, "sort_key": null } }, "loss_map": { "$ref": "#/$defs/CACRutherfordPostprocBatchpostprocLossMap", "default": { "produce_loss_map": false, "save_plot": false, "filename": "loss_map", "x_val": null, "y_val": null, "x_steps": 20, "y_steps": 20, "loss_type": "TotalLoss", "x_log": true, "y_log": true, "loss_log": true, "x_norm": 1.0, "y_norm": 1.0, "loss_norm": 1.0, "show_datapoints": true, "title": null, "xlabel": null, "ylabel": null, "show_loss_type_dominance_contour": false, "cross_section": { "axis_to_cut": "x", "cut_value": 0.0, "filename": "cross_section", "plot_cross_section": false, "save_plot": false, "title": null, "ylabel": "Loss" }, "cross_section_sweep": { "animate_cross_section_sweep": false, "axis_to_sweep": "x", "filename": "crossSectionSweep", "save_plot": false, "title": null, "ylabel": "Loss" } } }, "plot2d": { "$ref": "#/$defs/CACRutherfordPostprocBatchpostprocPlot2d", "default": { "produce_plot2d": false, "combined_plot": false, "save_plot": false, "filename": "plot2d", "x_val": null, "y_vals": null, "labels": null, "linestyle": null, "title": null, "xlabel": null, "ylabel": null, "x_log": false, "y_log": false, "legend": true } } }, "title": "CACRutherfordPostprocBatchpostproc", "type": "object" }, "CACRutherfordPostprocBatchpostprocFilter": { "description": "Level 4: Field for filtering simulations based on simulation parameters for batch post-processing", "properties": { "apply_filter": { "default": false, "description": "Set True to filter simulations by parameters from the input YAML-file.", "title": "Apply Filter", "type": "boolean" }, "filter_criterion": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Criterion used to filter simulations based on simulation parameters. For example will '<> > 100' disregard simulations done with frequencies lower than 100Hz.", "title": "Filter Criterion" } }, "title": "CACRutherfordPostprocBatchpostprocFilter", "type": "object" }, "CACRutherfordPostprocBatchpostprocLossMap": { "description": "Level 4: Class with settings for generating loss maps", "properties": { "produce_loss_map": { "default": false, "description": "Set True to produce a loss map.", "title": "Produce Loss Map", "type": "boolean" }, "save_plot": { "default": false, "description": "Set True to save the plot.", "title": "Save Plot", "type": "boolean" }, "filename": { "default": "loss_map", "description": "Name of the plot file.", "title": "Filename", "type": "string" }, "x_val": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "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.", "title": "X Val" }, "y_val": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "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.", "title": "Y Val" }, "x_steps": { "default": 20, "description": "Number of steps on the x-axis.", "title": "X Steps", "type": "integer" }, "y_steps": { "default": 20, "description": "Number of steps on the y-axis.", "title": "Y Steps", "type": "integer" }, "loss_type": { "default": "TotalLoss", "description": "Type of loss to be plotted. Supported options are: TotalLoss, FilamentLoss, CouplingLoss, EddyLoss.", "enum": [ "TotalLoss", "FilamentLoss", "CouplingLoss", "EddyLoss" ], "title": "Loss Type", "type": "string" }, "x_log": { "default": true, "description": "Set True to plot x-axis in log-scale.", "title": "X Log", "type": "boolean" }, "y_log": { "default": true, "description": "Set True to plot y-axis in log-scale.", "title": "Y Log", "type": "boolean" }, "loss_log": { "default": true, "description": "Set True to plot loss in log-scale.", "title": "Loss Log", "type": "boolean" }, "x_norm": { "default": 1, "description": "Normalization factor for x-axis.", "title": "X Norm", "type": "number" }, "y_norm": { "default": 1, "description": "Normalization factor for y-axis.", "title": "Y Norm", "type": "number" }, "loss_norm": { "default": 1, "description": "Normalization factor for the AC-loss.", "title": "Loss Norm", "type": "number" }, "show_datapoints": { "default": true, "description": "Set True to show markers for all the datapoints in the loss map.", "title": "Show Datapoints", "type": "boolean" }, "title": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Title for the plot.", "title": "Title" }, "xlabel": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Label for the x-axis.", "title": "Xlabel" }, "ylabel": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Label for the y-axis.", "title": "Ylabel" }, "show_loss_type_dominance_contour": { "default": false, "description": "Set True to plot a contour curve separating regions where different loss types dominate. ", "title": "Show Loss Type Dominance Contour", "type": "boolean" }, "cross_section": { "$ref": "#/$defs/CACRutherfordPostprocBatchpostprocLossMapCrossSection", "default": { "plot_cross_section": false, "save_plot": false, "filename": "cross_section", "axis_to_cut": "x", "cut_value": 0.0, "ylabel": "Loss", "title": null } }, "cross_section_sweep": { "$ref": "#/$defs/CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep", "default": { "animate_cross_section_sweep": false, "save_plot": false, "filename": "crossSectionSweep", "axis_to_sweep": "x", "ylabel": "Loss", "title": null } } }, "title": "CACRutherfordPostprocBatchpostprocLossMap", "type": "object" }, "CACRutherfordPostprocBatchpostprocLossMapCrossSection": { "description": "Level 5: Class with settings for plotting a cross-section of the loss map.", "properties": { "plot_cross_section": { "default": false, "description": "Set True to plot a cross-section of the loss map.", "title": "Plot Cross Section", "type": "boolean" }, "save_plot": { "default": false, "description": "Set True to save the plot.", "title": "Save Plot", "type": "boolean" }, "filename": { "default": "cross_section", "description": "Name of the plot file.", "title": "Filename", "type": "string" }, "axis_to_cut": { "default": "x", "description": "Axis to cut for the cross-section.", "title": "Axis To Cut", "type": "string" }, "cut_value": { "default": 0, "description": "Value of the axis to cut for the cross-section.", "title": "Cut Value", "type": "number" }, "ylabel": { "default": "Loss", "description": "Label of the y-axis.", "title": "Ylabel", "type": "string" }, "title": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Title of the plot. The placeholder <> can be used to indicate the value of the cut axis.", "title": "Title" } }, "title": "CACRutherfordPostprocBatchpostprocLossMapCrossSection", "type": "object" }, "CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep": { "description": "Level 5: Class with settings for animating a cross-section sweep of the loss map along one axis.", "properties": { "animate_cross_section_sweep": { "default": false, "description": "Set True to animate a cross-section sweep of the loss map along one axis.", "title": "Animate Cross Section Sweep", "type": "boolean" }, "save_plot": { "default": false, "description": "Set True to save the animation.", "title": "Save Plot", "type": "boolean" }, "filename": { "default": "crossSectionSweep", "description": "Name of the animation file.", "title": "Filename", "type": "string" }, "axis_to_sweep": { "default": "x", "description": "Axis to sweep for the animation.", "title": "Axis To Sweep", "type": "string" }, "ylabel": { "default": "Loss", "description": "Label of the y-axis.", "title": "Ylabel", "type": "string" }, "title": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Title of the plot. Use <> to indicate the value of the sweep axis.", "title": "Title" } }, "title": "CACRutherfordPostprocBatchpostprocLossMapCrossSectionSweep", "type": "object" }, "CACRutherfordPostprocBatchpostprocPlot2d": { "description": "Level 4: Class for 2D plot settings", "properties": { "produce_plot2d": { "default": false, "description": "Set True to produce a 2D plot.", "title": "Produce Plot2D", "type": "boolean" }, "combined_plot": { "default": false, "description": "Set True to produce a combined plot for all simulations. If False, a separate plot is produced for each simulation.", "title": "Combined Plot", "type": "boolean" }, "save_plot": { "default": false, "description": "Set True to save the plot.", "title": "Save Plot", "type": "boolean" }, "filename": { "default": "plot2d", "description": "Name of the plot file.", "title": "Filename", "type": "string" }, "x_val": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Value to be plotted on the x-axis. Parameters in the input YAML-file and class-variables from the plotter 'SimulationData' class can be accessed trough the notation << . >>. E.g. '<>' will create a 2D plot with frequency on the x-axis. '<