DataFiQuS

Auto-generated documentation for DataFiQuS.

Classes

FDM
GeneralFiQuS
QuenchProtection
RunFiQuS
SolveDumpDataModel

FDM

Module: DataFiQuS

Description: Class for FiQuS

Fields

Field	Type	Default	Description
`general`	`GeneralFiQuS`	`GeneralFiQuS()`
`run`	`RunFiQuS`	`RunFiQuS()`
`magnet`	`Multipole`	`CCT`	`Pancake3D`
`circuit`	`Circuit_Class`	`Circuit_Class()`
`power_supply`	`PowerSupplyClass`	`PowerSupplyClass()`
`quench_protection`	`QuenchProtection`	`QuenchProtection()`
`quench_detection`	`QuenchDetection`	`QuenchDetection()`
`conductors`	`dict`	`{}`

Nested Models

GeneralFiQuS

Description: Class for FiQuS general

Field	Type	Default	Description
`magnet_name`	`Optional[str]`	`null`

RunFiQuS

Description: Class for FiQuS run

Field	Type	Default	Description
`type`	`Literal[str]`	`"start_from_yaml"`	FiQuS allows you to run the model in different ways. The run type can be specified here. For example, you can just create the geometry and mesh or just solve the model with previous mesh, etc. Available inputs: "start_from_yaml" "mesh_only" "geometry_only" "geometry_and_mesh" "pre_process_only" "mesh_and_solve_with_post_process_python" "solve_with_post_process_python" "solve_only" "post_process_getdp_only" "post_process_python_only" "post_process" "plot_python" "batch_post_process_python" "only_create_pro_file_from_mesh" "postprocess_veusz"
`geometry`	`Optional[int` \| `str]`	`null`	This key will be appended to the geometry folder.
`mesh`	`Optional[int` \| `str]`	`null`	This key will be appended to the mesh folder.
`solution`	`Optional[int` \| `str]`	`null`	This key will be appended to the solution folder.
`launch_gui`	`bool`	`False`	If True, the GUI will be launched after the run.
`overwrite`	`bool`	`False`	If True, the existing folders will be overwritten, otherwise new folders will be created. NOTE: This setting has no effect for HTCondor runs.
`comments`	`str`	`""`	Comments for the run. These comments will be saved in the run_log.csv file.
`verbosity_Gmsh`	`int`	`5`	Level of information printed on the terminal and the message console (0: silent except for fatal errors, 1: +errors, 2: +warnings, 3: +direct, 4: +information, 5: +status, 99: +debug)
`verbosity_GetDP`	`int`	`5`	Level of information printed on the terminal and the message console. Higher number prints more, good options are 5 or 6.
`verbosity_FiQuS`	`bool`	`True`	Level of information printed on the terminal and the message console by FiQuS. Only True of False for now.

GeneralFiQuS

Module: DataFiQuS

Description: Class for FiQuS general

Fields

Field	Type	Default	Description
`magnet_name`	`Optional[str]`	`null`

QuenchProtection

Module: DataFiQuS

Description: Level 2: Class for FiQuS

Fields

Field	Type	Default
`energy_extraction`	`EnergyExtraction`	`EnergyExtraction()`
`quench_heaters`	`QuenchHeater`	`QuenchHeater()`
`cliq`	`CLIQ_Class`	`CLIQ_Class()`
`esc`	`ESC_Class`	`ESC_Class()`
`e_cliq`	`E_CLIQ_Class`	`E_CLIQ_Class()`

RunFiQuS

Module: DataFiQuS

Description: Class for FiQuS run

Fields

Field	Type	Default	Description
`type`	`Literal[str]`	`"start_from_yaml"`	FiQuS allows you to run the model in different ways. The run type can be specified here. For example, you can just create the geometry and mesh or just solve the model with previous mesh, etc. Available inputs: "start_from_yaml" "mesh_only" "geometry_only" "geometry_and_mesh" "pre_process_only" "mesh_and_solve_with_post_process_python" "solve_with_post_process_python" "solve_only" "post_process_getdp_only" "post_process_python_only" "post_process" "plot_python" "batch_post_process_python" "only_create_pro_file_from_mesh" "postprocess_veusz"
`geometry`	`Optional[int` \| `str]`	`null`	This key will be appended to the geometry folder.
`mesh`	`Optional[int` \| `str]`	`null`	This key will be appended to the mesh folder.
`solution`	`Optional[int` \| `str]`	`null`	This key will be appended to the solution folder.
`launch_gui`	`bool`	`False`	If True, the GUI will be launched after the run.
`overwrite`	`bool`	`False`	If True, the existing folders will be overwritten, otherwise new folders will be created. NOTE: This setting has no effect for HTCondor runs.
`comments`	`str`	`""`	Comments for the run. These comments will be saved in the run_log.csv file.
`verbosity_Gmsh`	`int`	`5`	Level of information printed on the terminal and the message console (0: silent except for fatal errors, 1: +errors, 2: +warnings, 3: +direct, 4: +information, 5: +status, 99: +debug)
`verbosity_GetDP`	`int`	`5`	Level of information printed on the terminal and the message console. Higher number prints more, good options are 5 or 6.
`verbosity_FiQuS`	`bool`	`True`	Level of information printed on the terminal and the message console by FiQuS. Only True of False for now.

SolveDumpDataModel

Module: DataFiQuS

Fields

Field	Type	Default
`solve`	Unknown	Required
`circuit`	`Circuit_Class`	`Circuit_Class()`
`power_supply`	`PowerSupplyClass`	`PowerSupplyClass()`
`quench_protection`	`QuenchProtection`	`QuenchProtection()`
`quench_detection`	`QuenchDetection`	`QuenchDetection()`
`conductors`	`dict`	`{}`