DataFiQuSConductorAC_CC
Auto-generated documentation for DataFiQuSConductorAC_CC.
Classes
CACCCCACCCGeneralparametersCACCCGeometryCACCCMeshCACCCPostprocCACCCPostprocPosFilesCACCCSolveCACCCSolveInitialconditionsCACCCSolveNumericalparametersCACCCSolveNumericalparametersPiecewiseCACCCSolveNumericalparametersSineCACCCSolveSourceparametersCACCCSolveSourceparametersPiecewiseCACCCSolveSourceparametersSineCWSStrandPostprocCleanup
CACCC
Module: DataFiQuSConductorAC_CC
Description: Level 1: Class for FiQuS CACCC
Fields
| Field | Type | Default | Description |
|---|---|---|---|
type |
str |
Required | |
geometry |
CACCCGeometry |
CACCCGeometry() |
|
mesh |
CACCCMesh |
CACCCMesh() |
|
solve |
CACCCSolve |
CACCCSolve() |
|
postproc |
CACCCPostproc |
CACCCPostproc() |
Nested Models
CACCCGeneralparameters
Description: Level 3: Class for general parameters
| Field | Type | Default | Description |
|---|---|---|---|
temperature |
float |
1.9 |
Temperature (K). |
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. |
CACCCGeometry
Description: Level 2: Geometry for CACCC.
| Field | Type | Default | Description |
|---|---|---|---|
air_radius |
Optional[float] |
null |
Radius of air region. |
CACCCMesh
Description: Level 2: Mesh parameters for CACCC.
| Field | Type | Default | Description |
|---|---|---|---|
HTS_n_elem_width |
Optional[int] |
null |
Number of elements along HTS width (x-direction). |
HTS_n_elem_thickness |
Optional[int] |
null |
Number of elements through HTS thickness (y-direction). |
substrate_elem_scale |
Optional[float] |
null |
Element-count scale factor for substrate layer. |
substrate_side_progression |
Optional[float] |
null |
Progression factor for substrate vertical sides near the HTS side. |
silver_elem_scale |
Optional[float] |
null |
Element-count scale factor for silver layers. |
copper_elem_scale |
Optional[float] |
null |
Element-count scale factor for copper layers. |
air_boundary_mesh_size_ratio |
Optional[float] |
null |
Ratio of air outer-boundary mesh size to the HTS base size. |
scaling_global |
Optional[float] |
null |
Global refinement factor. |
bump_coef |
Optional[float] |
null |
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. |
CACCCPostproc
Description: Post-processing options for CACCC
| Field | Type | Default | Description |
|---|---|---|---|
pos_files |
CACCCPostprocPosFiles |
CACCCPostprocPosFiles() |
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 |
CWSStrandPostprocCleanup |
CWSStrandPostprocCleanup() |
CACCCPostprocPosFiles
Description: Level 3: Class for post-pro .pos file requests
| Field | Type | Default | Description |
|---|---|---|---|
quantities |
Optional[list] |
null |
List of GetDP postprocessing quantities to write to .pos file. Examples of valid entry is: phi, h, b, j, jz, power |
regions |
Optional[list] |
null |
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) |
CACCCSolve
Description: Level 2: Solve block for CACCC
| Field | Type | Default | Description |
|---|---|---|---|
pro_template |
Optional[str] |
"CAC_CC_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. |
general_parameters |
CACCCGeneralparameters |
CACCCGeneralparameters() |
|
initial_conditions |
CACCCSolveInitialconditions |
CACCCSolveInitialconditions() |
|
source_parameters |
CACCCSolveSourceparameters |
CACCCSolveSourceparameters() |
|
numerical_parameters |
CACCCSolveNumericalparameters |
CACCCSolveNumericalparameters() |
CACCCSolveInitialconditions
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 (initialization from pos_file is needed for this). 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_.../Mesh_.../ folder in which the Solution_xxx will be saved. |
CACCCSolveNumericalparameters
Description: Level 3: Class for numerical parameters
| Field | Type | Default | Description |
|---|---|---|---|
relative_tolerance |
Optional[float] |
1e-06 |
Tolerance on the relative change of the power indicator for the convergence criterion (1e-6 is usually a safe choice). |
voltage_per_meter_stopping_criterion |
Optional[float] |
null |
If a non-zero value is given, the simulation will stop if the transport voltage per meter reaches this value (in absolute value). |
relaxation_factors |
Optional[bool] |
True |
Use of relaxation factors to help convergence (automatic selection based on the lowest residual). |
sine |
CACCCSolveNumericalparametersSine |
CACCCSolveNumericalparametersSine() |
|
piecewise |
CACCCSolveNumericalparametersPiecewise |
CACCCSolveNumericalparametersPiecewise() |
CACCCSolveNumericalparametersPiecewise
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 inthe 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. |
CACCCSolveNumericalparametersSine
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. |
CACCCSolveSourceparameters
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, piecewise. Available inputs: "sine", "piecewise" |
sine |
CACCCSolveSourceparametersSine |
CACCCSolveSourceparametersSine() |
|
piecewise |
CACCCSolveSourceparametersPiecewise |
CACCCSolveSourceparametersPiecewise() |
|
field_angle_with_respect_to_normal_direction |
Optional[float] |
null |
Angle of the source magnetic field with respect to the y-axis (normal to the tape) (degrees). |
CACCCSolveSourceparametersPiecewise
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. |
CACCCSolveSourceparametersSine
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). |
CWSStrandPostprocCleanup
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. |
CACCCGeneralparameters
Module: DataFiQuSConductorAC_CC
Description: Level 3: Class for general parameters
Fields
| Field | Type | Default | Description |
|---|---|---|---|
temperature |
float |
1.9 |
Temperature (K). |
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. |
CACCCGeometry
Module: DataFiQuSConductorAC_CC
Description: Level 2: Geometry for CACCC.
Fields
| Field | Type | Default | Description |
|---|---|---|---|
air_radius |
Optional[float] |
null |
Radius of air region. |
CACCCMesh
Module: DataFiQuSConductorAC_CC
Description: Level 2: Mesh parameters for CACCC.
Fields
| Field | Type | Default | Description |
|---|---|---|---|
HTS_n_elem_width |
Optional[int] |
null |
Number of elements along HTS width (x-direction). |
HTS_n_elem_thickness |
Optional[int] |
null |
Number of elements through HTS thickness (y-direction). |
substrate_elem_scale |
Optional[float] |
null |
Element-count scale factor for substrate layer. |
substrate_side_progression |
Optional[float] |
null |
Progression factor for substrate vertical sides near the HTS side. |
silver_elem_scale |
Optional[float] |
null |
Element-count scale factor for silver layers. |
copper_elem_scale |
Optional[float] |
null |
Element-count scale factor for copper layers. |
air_boundary_mesh_size_ratio |
Optional[float] |
null |
Ratio of air outer-boundary mesh size to the HTS base size. |
scaling_global |
Optional[float] |
null |
Global refinement factor. |
bump_coef |
Optional[float] |
null |
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. |
CACCCPostproc
Module: DataFiQuSConductorAC_CC
Description: Post-processing options for CACCC
Fields
| Field | Type | Default | Description |
|---|---|---|---|
pos_files |
CACCCPostprocPosFiles |
CACCCPostprocPosFiles() |
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 |
CWSStrandPostprocCleanup |
CWSStrandPostprocCleanup() |
Nested Models
CACCCPostprocPosFiles
Description: Level 3: Class for post-pro .pos file requests
| Field | Type | Default | Description |
|---|---|---|---|
quantities |
Optional[list] |
null |
List of GetDP postprocessing quantities to write to .pos file. Examples of valid entry is: phi, h, b, j, jz, power |
regions |
Optional[list] |
null |
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) |
CWSStrandPostprocCleanup
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. |
CACCCPostprocPosFiles
Module: DataFiQuSConductorAC_CC
Description: Level 3: Class for post-pro .pos file requests
Fields
| Field | Type | Default | Description |
|---|---|---|---|
quantities |
Optional[list] |
null |
List of GetDP postprocessing quantities to write to .pos file. Examples of valid entry is: phi, h, b, j, jz, power |
regions |
Optional[list] |
null |
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) |
CACCCSolve
Module: DataFiQuSConductorAC_CC
Description: Level 2: Solve block for CACCC
Fields
| Field | Type | Default | Description |
|---|---|---|---|
pro_template |
Optional[str] |
"CAC_CC_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. |
general_parameters |
CACCCGeneralparameters |
CACCCGeneralparameters() |
|
initial_conditions |
CACCCSolveInitialconditions |
CACCCSolveInitialconditions() |
|
source_parameters |
CACCCSolveSourceparameters |
CACCCSolveSourceparameters() |
|
numerical_parameters |
CACCCSolveNumericalparameters |
CACCCSolveNumericalparameters() |
Nested Models
CACCCGeneralparameters
Description: Level 3: Class for general parameters
| Field | Type | Default | Description |
|---|---|---|---|
temperature |
float |
1.9 |
Temperature (K). |
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. |
CACCCSolveInitialconditions
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 (initialization from pos_file is needed for this). 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_.../Mesh_.../ folder in which the Solution_xxx will be saved. |
CACCCSolveNumericalparameters
Description: Level 3: Class for numerical parameters
| Field | Type | Default | Description |
|---|---|---|---|
relative_tolerance |
Optional[float] |
1e-06 |
Tolerance on the relative change of the power indicator for the convergence criterion (1e-6 is usually a safe choice). |
voltage_per_meter_stopping_criterion |
Optional[float] |
null |
If a non-zero value is given, the simulation will stop if the transport voltage per meter reaches this value (in absolute value). |
relaxation_factors |
Optional[bool] |
True |
Use of relaxation factors to help convergence (automatic selection based on the lowest residual). |
sine |
CACCCSolveNumericalparametersSine |
CACCCSolveNumericalparametersSine() |
|
piecewise |
CACCCSolveNumericalparametersPiecewise |
CACCCSolveNumericalparametersPiecewise() |
CACCCSolveNumericalparametersPiecewise
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 inthe 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. |
CACCCSolveNumericalparametersSine
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. |
CACCCSolveSourceparameters
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, piecewise. Available inputs: "sine", "piecewise" |
sine |
CACCCSolveSourceparametersSine |
CACCCSolveSourceparametersSine() |
|
piecewise |
CACCCSolveSourceparametersPiecewise |
CACCCSolveSourceparametersPiecewise() |
|
field_angle_with_respect_to_normal_direction |
Optional[float] |
null |
Angle of the source magnetic field with respect to the y-axis (normal to the tape) (degrees). |
CACCCSolveSourceparametersPiecewise
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. |
CACCCSolveSourceparametersSine
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). |
CACCCSolveInitialconditions
Module: DataFiQuSConductorAC_CC
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 (initialization from pos_file is needed for this). 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_.../Mesh_.../ folder in which the Solution_xxx will be saved. |
CACCCSolveNumericalparameters
Module: DataFiQuSConductorAC_CC
Description: Level 3: Class for numerical parameters
Fields
| Field | Type | Default | Description |
|---|---|---|---|
relative_tolerance |
Optional[float] |
1e-06 |
Tolerance on the relative change of the power indicator for the convergence criterion (1e-6 is usually a safe choice). |
voltage_per_meter_stopping_criterion |
Optional[float] |
null |
If a non-zero value is given, the simulation will stop if the transport voltage per meter reaches this value (in absolute value). |
relaxation_factors |
Optional[bool] |
True |
Use of relaxation factors to help convergence (automatic selection based on the lowest residual). |
sine |
CACCCSolveNumericalparametersSine |
CACCCSolveNumericalparametersSine() |
|
piecewise |
CACCCSolveNumericalparametersPiecewise |
CACCCSolveNumericalparametersPiecewise() |
Nested Models
CACCCSolveNumericalparametersPiecewise
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 inthe 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. |
CACCCSolveNumericalparametersSine
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. |
CACCCSolveNumericalparametersPiecewise
Module: DataFiQuSConductorAC_CC
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 inthe 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. |
CACCCSolveNumericalparametersSine
Module: DataFiQuSConductorAC_CC
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. |
CACCCSolveSourceparameters
Module: DataFiQuSConductorAC_CC
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, piecewise. Available inputs: "sine", "piecewise" |
sine |
CACCCSolveSourceparametersSine |
CACCCSolveSourceparametersSine() |
|
piecewise |
CACCCSolveSourceparametersPiecewise |
CACCCSolveSourceparametersPiecewise() |
|
field_angle_with_respect_to_normal_direction |
Optional[float] |
null |
Angle of the source magnetic field with respect to the y-axis (normal to the tape) (degrees). |
Nested Models
CACCCSolveSourceparametersPiecewise
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. |
CACCCSolveSourceparametersSine
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). |
CACCCSolveSourceparametersPiecewise
Module: DataFiQuSConductorAC_CC
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. |
CACCCSolveSourceparametersSine
Module: DataFiQuSConductorAC_CC
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). |
CWSStrandPostprocCleanup
Module: DataFiQuSConductorAC_CC
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. |