DataFiQuSPancake3D
Auto-generated documentation for DataFiQuSPancake3D.
Classes
Pancake3DPancake3DGeometryPancake3DGeometryAirBasePancake3DGeometryContactLayerPancake3DGeometryInnerTerminalPancake3DGeometryOuterTerminalPancake3DGeometryTerminalBasePancake3DGeometryTerminalsPancake3DGeometryWindingPancake3DMeshPancake3DMeshAirAndTerminalsPancake3DMeshContactLayerPancake3DMeshWindingPancake3DPostprocessPancake3DPostprocessTimeSeriesPlotBasePancake3DSolvePancake3DSolveAdaptiveTimeLoopSettingsPancake3DSolveAirPancake3DSolveContactLayerMaterialPancake3DSolveHTSMaterialBasePancake3DSolveInitialConditionsPancake3DSolveLocalDefectsPancake3DSolveMaterialPancake3DSolveMaterialBasePancake3DSolveQuantityBasePancake3DSolveSettingsWithTolerancesPancake3DSolveShuntLayerMaterialPancake3DSolveSuperconductingMaterialPancake3DSolveTerminalMaterialAndBoundaryConditionPancake3DSolveTimeBasePancake3DSolveToleranceBasePancake3DSolveWindingMaterialPancake3DTerminalCryocoolerLumpedMass
Pancake3D
Module: DataFiQuSPancake3D
Description: Level 1: Class for FiQuS Pancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
type |
str |
Required | |
geometry |
Pancake3DGeometry |
null |
This dictionary contains the geometry information. |
mesh |
Pancake3DMesh |
null |
This dictionary contains the mesh information. |
solve |
Pancake3DSolve |
null |
This dictionary contains the solve information. |
postproc |
Pancake3DPostprocess |
Pancake3DPostprocess() |
This dictionary contains the postprocess information. |
input_file_path |
str |
null |
path of the input file (calculated by FiQuS) |
Nested Models
Pancake3DGeometry
| Field | Type | Default | Description |
|---|---|---|---|
conductorWrite |
bool |
False |
To Write the Conductor File |
numberOfPancakes |
int |
Required | Number of pancake coils stacked on top of each other. |
gapBetweenPancakes |
float |
Required | Gap distance between the pancake coils. |
winding |
Pancake3DGeometryWinding |
Required | This dictionary contains the winding geometry information. |
contactLayer |
Pancake3DGeometryContactLayer |
Required | This dictionary contains the contact layer geometry information. |
terminals |
Pancake3DGeometryTerminals |
Required | This dictionary contains the terminals geometry information. |
air |
Pancake3DGeometryAirCylinder |
Pancake3DGeometryAirCuboid |
Required |
dimensionTolerance |
float |
1e-08 |
dimension tolerance (CAD related, not physical) |
pancakeBoundaryName |
str |
"PancakeBoundary" |
name of the pancake's curves that touches the air to be used in the mesh |
contactLayerBoundaryName |
str |
"contactLayerBoundary" |
name of the contact layers's curves that touches the air to be used in the mesh (only for TSA) |
Pancake3DGeometryAirCuboid
| Field | Type | Default | Description |
|---|---|---|---|
axialMargin |
float |
Required | Axial margin between the ends of the air and first/last pancake coils. |
name |
str |
"air" |
The name to be used in the mesh. |
shellTransformation |
bool |
False |
Generate outer shell air to apply shell transformation if True (GetDP related, not physical) |
shellTransformationMultiplier |
float |
1.2 |
multiply the air's outer dimension by this value to get the shell's outer dimension |
cutName |
str |
"Air-Cut" |
name of the cut (cochain) to be used in the mesh |
shellVolumeName |
str |
"air-Shell" |
name of the shell volume to be used in the mesh |
generateGapAirWithFragment |
bool |
False |
generate the gap air with gmsh/model/occ/fragment if true (CAD related, not physical) |
type |
str |
"cuboid" |
|
sideLength |
float |
null |
Side length of the air (for cuboid type air). |
Pancake3DGeometryAirCylinder
| Field | Type | Default | Description |
|---|---|---|---|
axialMargin |
float |
Required | Axial margin between the ends of the air and first/last pancake coils. |
name |
str |
"air" |
The name to be used in the mesh. |
shellTransformation |
bool |
False |
Generate outer shell air to apply shell transformation if True (GetDP related, not physical) |
shellTransformationMultiplier |
float |
1.2 |
multiply the air's outer dimension by this value to get the shell's outer dimension |
cutName |
str |
"Air-Cut" |
name of the cut (cochain) to be used in the mesh |
shellVolumeName |
str |
"air-Shell" |
name of the shell volume to be used in the mesh |
generateGapAirWithFragment |
bool |
False |
generate the gap air with gmsh/model/occ/fragment if true (CAD related, not physical) |
type |
str |
"cylinder" |
|
radius |
float |
null |
Radius of the air (for cylinder type air). |
Pancake3DGeometryContactLayer
| Field | Type | Default | Description |
|---|---|---|---|
thinShellApproximation |
bool |
Required | If True, the contact layer will be modeled with 2D shell elements (thin shell approximation), and if False, the contact layer will be modeled with 3D elements. |
thickness |
float |
Required | Thickness of the contact layer.It is the total thickness of the contact or insulation layer.In particular, for perfect insulation this would be the sum of the insulation layer of the two adjacent CC with an insulation layer of thickness t/2 on each side. |
name |
str |
"contactLayer" |
The name to be used in the mesh. |
Pancake3DGeometryInnerTerminal
| Field | Type | Default | Description |
|---|---|---|---|
thickness |
float |
Required | Thickness of the terminal's tube. |
name |
str |
"innerTerminal" |
The name to be used in the mesh. |
Pancake3DGeometryOuterTerminal
| Field | Type | Default | Description |
|---|---|---|---|
thickness |
float |
Required | Thickness of the terminal's tube. |
name |
str |
"outerTerminal" |
The name to be used in the mesh. |
Pancake3DGeometryTerminals
| Field | Type | Default | Description |
|---|---|---|---|
inner |
Pancake3DGeometryInnerTerminal |
Required | |
outer |
Pancake3DGeometryOuterTerminal |
Required | |
firstName |
str |
"firstTerminal" |
name of the first terminal |
lastName |
str |
"lastTerminal" |
name of the last terminal |
Pancake3DGeometryWinding
| Field | Type | Default | Description |
|---|---|---|---|
innerRadius |
float |
Required | Inner radius of the winding. |
thickness |
float |
Required | Thickness of the winding. |
numberOfTurns |
float |
Required | Number of turns of the winding. |
height |
float |
Required | Height/width of the winding. |
name |
str |
"winding" |
The The name to be used in the mesh.. |
numberOfVolumesPerTurn |
int |
2 |
The number of volumes per turn (CAD related, not physical). |
Pancake3DMesh
| Field | Type | Default | Description |
|---|---|---|---|
winding |
Pancake3DMeshWinding |
Required | This dictionary contains the winding mesh information. |
contactLayer |
Pancake3DMeshContactLayer |
Required | This dictionary contains the contact layer mesh information. |
terminals |
Pancake3DMeshAirAndTerminals |
Pancake3DMeshAirAndTerminals() |
This dictionary contains the terminal mesh information. |
air |
Pancake3DMeshAirAndTerminals |
Pancake3DMeshAirAndTerminals() |
This dictionary contains the air mesh information. |
computeCohomologyForInsulating |
bool |
True |
Expert option only. If False, the cohomology regions needed for simulating an insulating coilwill not be computed. This will reduce the time spent for the meshing or more accurately the cohomology computing phase. BEWARE: The simulation will fail if set to False and a perfectlyInsulating coil is simulated. |
minimumElementSize |
float |
Required | The minimum mesh element size in terms of the largest mesh size in the winding. This mesh size will be used in the regions close the the winding, and then the mesh size will increate to maximum mesh element size as it gets away from the winding. |
maximumElementSize |
float |
Required | The maximum mesh element size in terms of the largest mesh size in the winding. This mesh size will be used in the regions close the the winding, and then the mesh size will increate to maximum mesh element size as it gets away from the winding. |
Pancake3DMeshAirAndTerminals
| Field | Type | Default | Description |
|---|---|---|---|
structured |
bool |
False |
If True, the mesh will be structured. If False, the mesh will be unstructured. |
radialElementSize |
float |
1 |
If structured mesh is used, the radial element size can be set. It is the radial element size in terms of the winding's radial element size. |
Pancake3DMeshContactLayer
| Field | Type | Default | Description |
|---|---|---|---|
radialNumberOfElementsPerTurn |
list |
Required | The number of radial elements per tape of the contact layer. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil. |
Pancake3DMeshWinding
| Field | Type | Default | Description |
|---|---|---|---|
axialNumberOfElements |
list | int |
Required | The number of axial elements for the whole height of the coil. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil. |
azimuthalNumberOfElementsPerTurn |
list | int |
Required | The number of azimuthal elements per turn of the coil. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil. |
radialNumberOfElementsPerTurn |
list | int |
Required | The number of radial elements per tape of the winding. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil. |
axialDistributionCoefficient |
list | float |
[...] (1 items) |
If 1, it won't affect anything. If smaller than 1, elements will get finer in the axial direction at the ends of the coil. If greater than 1, elements will get coarser in the axial direction at the ends of the coil. It can be either a list of floats to specify the value for each pancake coil separately or a float to use the same setting for each pancake coil. |
elementType |
list[Literal[str]] | Literal[str] |
[...] (1 items) |
The element type of windings and contact layers. It can be either a tetrahedron, hexahedron, or a prism. It can be either a list of strings to specify the value for each pancake coil separately or a string to use the same setting for each pancake coil. Available inputs: "tetrahedron", "hexahedron", "prism" |
Pancake3DPositionInCoordinates
| Field | Type | Default | Description |
|---|---|---|---|
x |
float |
Required | x coordinate of the position. |
y |
float |
Required | y coordinate of the position. |
z |
float |
Required | z coordinate of the position. |
Pancake3DPositionInTurnNumbers
| Field | Type | Default | Description |
|---|---|---|---|
turnNumber |
float |
Required | Winding turn number as a position input. It starts from 0 and it can be a float. |
whichPancakeCoil |
Optional[int] |
null |
The first pancake coil is 1, the second is 2, etc. |
Pancake3DPostprocess
Description: TO BE UPDATED
| Field | Type | Default | Description |
|---|---|---|---|
timeSeriesPlots |
Optional[list] |
null |
Values can be plotted with respect to time. |
magneticFieldOnCutPlane |
Optional[Pancake3DPostprocessMagneticFieldOnPlane] |
null |
Color map of the magnetic field on the YZ plane can be plotted with streamlines. |
Pancake3DPostprocessMagneticFieldOnPlane
| Field | Type | Default | Description |
|---|---|---|---|
colormap |
str |
"viridis" |
Colormap for the plot. |
streamLines |
bool |
True |
If True, streamlines will be plotted. Note that magnetic field vectors may have components perpendicular to the plane, and streamlines will be drawn depending on the vectors' projection onto the plane. |
interpolationMethod |
Literal[str] |
"linear" |
Interpolation type for the plot.Because of the FEM basis function selections of FiQuS, each mesh element has a constant magnetic field vector. Therefore, for smooth 2D plots, interpolation can be used.Types:nearest: it will plot the nearest magnetic field value to the plotting point.linear: it will do linear interpolation to the magnetic field values.cubic: it will do cubic interpolation to the magnetic field values. Available inputs: "nearest", "linear", "cubic" |
timesToBePlotted |
Optional[list] |
null |
List of times that wanted to be plotted. If not given, all the time steps will be plotted. |
planeNormal |
list |
[...] (3 items) |
Normal vector of the plane. The default is YZ-plane (1, 0, 0). |
planeXAxisUnitVector |
list |
[...] (3 items) |
If an arbitrary plane is wanted to be plotted, the arbitrary plane's X axis unit vector must be specified. The dot product of the plane's X axis and the plane's normal vector must be zero. |
Pancake3DPostprocessTimeSeriesPlotPositionNotRequired
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] |
Required | Name of the quantity to be plotted. Available inputs: "currentThroughCoil" "voltageBetweenTerminals" "inductance" "timeConstant" "totalResistiveHeating" "magneticEnergy" "maximumTemperature" "cryocoolerAveragePower" "cryocoolerAverageTemperature" |
Pancake3DPostprocessTimeSeriesPlotPositionRequired
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] |
Required | Name of the quantity to be plotted. Available inputs: "magneticField" "magnitudeOfMagneticField" "currentDensity" "magnitudeOfCurrentDensity" "resistiveHeating" "temperature" "criticalCurrentDensity" "heatFlux" "resistivity" "thermalConductivity" "specificHeatCapacity" "jHTSOverjCritical" "criticalCurrent" "axialComponentOfTheMagneticField" "debug" "jHTS" "currentSharingIndex" "arcLength" "turnNumber" |
position |
Pancake3DPositionInCoordinates | Pancake3DPositionInTurnNumbers |
Required | Probing position of the quantity for time series plot. |
Pancake3DSolve
| Field | Type | Default | Description |
|---|---|---|---|
time |
Pancake3DSolveTimeAdaptive |
Pancake3DSolveTimeFixed |
Required |
nonlinearSolver |
Optional[Pancake3DSolveNonlinearSolverSettings] |
Required | All the nonlinear solver related settings. |
winding |
Pancake3DSolveWindingMaterial |
Required | This dictionary contains the winding material properties. |
contactLayer |
Pancake3DSolveContactLayerMaterial |
Required | This dictionary contains the contact layer material properties. |
terminals |
Pancake3DSolveTerminalMaterialAndBoundaryCondition |
Required | This dictionary contains the terminals material properties and cooling condition. |
air |
Pancake3DSolveAir |
Required | This dictionary contains the air material properties. |
initialConditions |
Pancake3DSolveInitialConditions |
Required | Initial conditions of the problem. |
boundaryConditions |
str | Pancake3DSolveImposedField |
"vanishingTangentialElectricField" |
Boundary conditions of the problem. |
quantitiesToBeSaved |
list |
null |
List of quantities to be saved. |
type |
Literal[str] |
Required | FiQuS/Pancake3D can solve only electromagnetic and thermal or electromagnetic and thermal coupled. In the weaklyCoupled setting, thermal and electromagnetics systems will be put into different matrices, whereas in the stronglyCoupled setting, they all will be combined into the same matrix. The solution should remain the same. Available inputs: "electromagnetic", "thermal", "weaklyCoupled", "stronglyCoupled" |
proTemplate |
str |
"Pancake3D_template.pro" |
file name of the .pro template file |
localDefects |
Pancake3DSolveLocalDefects |
Pancake3DSolveLocalDefects() |
Local defects (like making a small part of the winding normal conductor at some time) can be introduced. |
initFromPrevious |
str |
"" |
The simulation is continued from an existing .res file. The .res file is from a previous computation on the same geometry and mesh. The .res file is taken from the folder Solution_< |
isothermalInAxialDirection |
bool |
False |
If True, the DoF along the axial direction will be equated. This means that the temperature will be the same along the axial direction reducing the number of DoF. This is only valid for the thermal analysis. |
voltageTapPositions |
Optional[list] |
[] |
List of voltage tap positions. The position can be given in the form of a list of [x, y, z] coordinates or as turnNumber and number of pancake coil. |
EECircuit |
Optional[Pancake3DSolveEECircuit] |
{...} (9 fields) |
This dictionary contains the detection circuit settings. |
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. |
resistiveHeatingTerminals |
bool |
True |
If True, terminals are subject to Joule heating. If False, terminal regions are not subject to Joule heating. In both cases, heat conduction through the terminal is considered. |
solveHeatEquationTerminalsTransitionNotch |
bool |
True |
If True, the heat equation is solved in the terminals and transition notch.If False, the heat equation is not solved in the terminals and transition notches.In the latter case, neither heat conduction nor generation are considered.In other words, the temperature is not an unknown of the problem in the terminals. |
heatFlowBetweenTurns |
bool |
True |
If True, heat flow between turns is considered. If False, it is not considered. In the latter case, heat conduction is only considered to the middle of the winding in the thin shell approximation in order to keep the thermal mass of the insulation included. In the middle between the turns, an adiabatic condition is applied. Between the turns refers to the region between the winding turns, NOT to the region between terminals and the first and last turn. This feature is only implemented for the thin shell approximation. |
convectiveCooling |
Optional[Pancake3DSolveConvectiveCooling] |
{...} (2 fields) |
This dictionary contains the convective cooling settings. |
imposedPowerDensity |
Optional[Pancake3DSolvePowerDensity] |
null |
The power density for an imposed power density in the winding. |
materialParametersUseCoilField |
bool |
True |
If True, the total field (i.e., coil field plus potentially imposed field)will be used for the material (default).If False, only the imposed field (can be zero) will be used. |
stopWhenTemperatureReaches |
Optional[float] |
0 |
If the maximum temperature reaches this value, the simulation will be stopped. |
Pancake3DSolveAdaptiveTimeLoopSettings
| Field | Type | Default | Description |
|---|---|---|---|
tolerances |
list |
Required | Time steps or nonlinear iterations will be refined until the tolerances are satisfied. |
initialStep |
float |
Required | Initial step for adaptive time stepping |
minimumStep |
float |
Required | The simulation will be aborted if a finer time step is required than this minimum step value. |
maximumStep |
float |
Required | Bigger steps than this won't be allowed |
integrationMethod |
Literal[str] |
"Euler" |
Integration method for transient analysis Available inputs: "Euler", "Gear_2", "Gear_3", "Gear_4", "Gear_5", "Gear_6" |
breakPoints_input |
list |
[...] (1 items) |
Make sure to solve the system for these times. |
Pancake3DSolveAir
| Field | Type | Default | Description |
|---|---|---|---|
permeability |
float |
Required | Permeability of air. |
Pancake3DSolveContactLayerMaterial
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
float | str |
null |
A scalar value or "perfectlyInsulating". If "perfectlyInsulating" is given, the contact layer will be perfectly insulating. If this value is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveNormalMaterial] |
null |
Material from STEAM material library. |
numberOfThinShellElements |
int |
1 |
Number of thin shell elements in the FE formulation (GetDP related, not physical and only used when TSA is set to True) |
Pancake3DSolveConvectiveCooling
| Field | Type | Default | Description |
|---|---|---|---|
heatTransferCoefficient |
Optional[float | str] |
0 |
The heat transfer coefficient for the heat transfer between the winding and the air. If zero, no heat transfer to the air is considered.This feature is only implemented for the thin shell approximation.At the moment, only constant values are supported. |
exteriorBathTemperature |
Optional[float] |
4.2 |
The temperature of the exterior bath for convective cooling boundary condition. |
Pancake3DSolveEECircuit
| Field | Type | Default | Description |
|---|---|---|---|
inductanceInSeriesWithPancakeCoil |
Optional[float] |
0 |
A lumped inductance in series with the pancake coil to model a bigger coil. |
enable |
bool |
False |
Enable the detection circuit for the pancake coil. |
ResistanceEnergyExtractionOpenSwitch |
Optional[float] |
1000000.0 |
The resistance of the energy extraction switch when modeled as open. |
ResistanceEnergyExtractionClosedSwitch |
Optional[float] |
1e-06 |
The resistance of the energy extraction switch when modeled as closed. |
ResistanceCrowbarOpenSwitch |
Optional[float] |
1000000.0 |
The resistance of the crowbar switch when modeled as open. |
ResistanceCrowbarClosedSwitch |
Optional[float] |
1e-06 |
The resistance of the crowbar switch when modeled as closed. |
stopSimulationAtCurrent |
Optional[float] |
0 |
If a quench is detected and the current reaches this value, the simulation will be stopped after. stopSimulationWaitingTime seconds. |
stopSimulationWaitingTime |
Optional[float] |
0 |
The time to wait after a quench is detected and the current reaches stopSimulationAtCurrent before stopping the simulation. |
TurnOffDeltaTimePowerSupply |
Optional[float] |
0 |
The time it takes for the power supply to be turned off after quench detection. A linear ramp-down is assumed between the time of quench detection and the time of power supply turn off. |
Pancake3DSolveFixedLoopInterval
| Field | Type | Default | Description |
|---|---|---|---|
startTime |
float |
Required | Start time of the interval. |
endTime |
float |
Required | End time of the interval. |
step |
float |
Required | Time step for the interval |
Pancake3DSolveFixedTimeLoopSettings
| Field | Type | Default | Description |
|---|---|---|---|
step |
float |
Required | Time step for fixed time stepping. |
Pancake3DSolveHTSNormalMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
Required | Available inputs: "Copper", "Hastelloy", "Silver", "Indium", "Stainless Steel", "Kapton", "G10" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
relativeThickness |
float |
Required | Winding tapes generally consist of more than one material. Therefore, when materials are given as a list in winding, their relative thickness, (thickness of the material) / (thickness of the bare conductor), should be specified. |
Pancake3DSolveHTSShuntLayerMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
"Copper" |
Available inputs: "Copper", "Hastelloy", "Silver", "Indium", "Stainless Steel", "Kapton", "G10" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
relativeHeight |
float |
0.0 |
HTS 2G coated conductor are typically plated, usually using copper. The relative height of the shunt layer is the width of the shunt layer divided by the width of the tape. 0 means no shunt layer. |
Pancake3DSolveHTSSuperconductingMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
Required | Available inputs: "HTSSuperPower", "HTSFujikura", "HTSSucci" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
nValue |
float |
30 |
N-value for E-J power law. |
IcAtTAndBref |
float | Pancake3DSolveIcVsLengthCSV | Pancake3DSolveIcVsLengthList |
Required | Critical current in A at reference temperature and magnetic field.The critical current value will change with temperature depending on the superconductor material.Either the same critical current for the whole tape or the critical current with respect to the tape length can be specified. To specify the same critical current for the entire tape, just use a scalar. To specify critical current with respect to the tape length: a CSV file can be used, or lengthValues and criticalCurrentValues can be given as lists. The data will be linearly interpolated.If a CSV file is to be used, the input should be the name of a CSV file (which is in the same folder as the input file) instead of a scalar. The first column of the CSV file will be the tape length in m, and the second column will be the critical current in A. |
electricFieldCriterion |
float |
0.0001 |
The electric field that defines the critical current density, i.e., the electric field at which the current density reaches the critical current density. |
jCriticalScalingNormalToWinding |
float |
1 |
Critical current scaling normal to winding, i.e., along the c_axis. We have Jc_cAxis = scalingFactor * Jc_abPlane. A factor of 1 means no scaling such that the HTS layer is isotropic. |
IcReferenceTemperature |
float |
77 |
Critical current reference temperature in Kelvin. |
IcReferenceBmagnitude |
float |
0.0 |
Critical current reference magnetic field magnitude in Tesla. |
IcReferenceBangle |
float |
90.0 |
Critical current reference magnetic field angle in degrees.0 degrees means the magnetic field is normal to the tape's wide surfaceand 90 degrees means the magnetic field is parallel to the tape's widesurface. |
relativeThickness |
float |
Required | Winding tapes generally consist of more than one material. Therefore, when materials are given as a list in winding, their relative thickness, (thickness of the material) / (thickness of the bare conductor), should be specified. |
Pancake3DSolveIcVsLengthCSV
| Field | Type | Default | Description |
|---|---|---|---|
csvFile |
str |
Required | The path of the CSV file that contains the critical current values. |
lengthUnit |
str |
Required | Unit of the critical current values. It can be either the arc length in meter or the number of turns. |
Pancake3DSolveIcVsLengthList
| Field | Type | Default | Description |
|---|---|---|---|
lengthValues |
list |
Required | Tape length values that corresponds to criticalCurrentValues. |
criticalCurrentValues |
list |
Required | Critical current values that corresponds to lengthValues. |
lengthUnit |
str |
Required | Unit of the critical current values. It can be either the arc length in meter or the number of turns. |
Pancake3DSolveImposedField
| Field | Type | Default | Description |
|---|---|---|---|
imposedAxialField |
float |
Required | Imposed axial magnetic field in Tesla. Only constant, purely axial magnetic fields are supported at the moment. |
Pancake3DSolveInitialConditions
| Field | Type | Default | Description |
|---|---|---|---|
temperature |
float |
Required | Initial temperature of the pancake coils. |
Pancake3DSolveLocalDefect
| Field | Type | Default | Description |
|---|---|---|---|
value |
float |
Required | Value of the local defect. |
startTurn |
float |
Required | Start turn of the local defect. |
endTurn |
float |
Required | End turn of the local defect. |
startTime |
float |
Required | Start time of the local defect. |
transitionDuration |
float |
0 |
Transition duration of the local defect. If not given, the transition will be instantly. |
whichPancakeCoil |
Optional[int] |
null |
The first pancake coil is 1, the second is 2, etc. |
Pancake3DSolveLocalDefects
| Field | Type | Default | Description |
|---|---|---|---|
criticalCurrentDensity |
Optional[Pancake3DSolveLocalDefect] |
null |
Set critical current density locally. |
Pancake3DSolveMaterial
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveNormalMaterial] |
null |
Material from STEAM material library. |
Pancake3DSolveNonlinearSolverSettings
| Field | Type | Default | Description |
|---|---|---|---|
tolerances |
list |
Required | Time steps or nonlinear iterations will be refined until the tolerances are satisfied. |
maximumNumberOfIterations |
int |
100 |
Maximum number of iterations allowed for the nonlinear solver. |
relaxationFactor |
float |
0.7 |
Calculated step changes of the solution vector will be multiplied with this value for better convergence. |
Pancake3DSolveNormalMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
Required | Available inputs: "Copper", "Hastelloy", "Silver", "Indium", "Stainless Steel", "Kapton", "G10" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
Pancake3DSolvePositionNotRequiredTolerance
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] | Literal[str] |
Required | Name of the quantity for tolerance. Available inputs: "electromagneticSolutionVector", "thermalSolutionVector", "coupledSolutionVector" |
relative |
float |
Required | Relative tolerance for the quantity. |
absolute |
float |
Required | Absolute tolerance for the quantity |
normType |
Literal[str] |
"L2Norm" |
Sometimes, tolerances return a vector instead of a scalar (ex, solutionVector). Then, the magnitude of the tolerance should be calculated with a method. Norm type selects this method. Available inputs: "L1Norm", "MeanL1Norm", "L2Norm", "MeanL2Norm", "LinfNorm" |
Pancake3DSolvePositionRequiredTolerance
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] |
Required | Name of the quantity for tolerance. Available inputs: "magneticField" "magnitudeOfMagneticField" "currentDensity" "magnitudeOfCurrentDensity" "resistiveHeating" "temperature" "criticalCurrentDensity" "heatFlux" "resistivity" "thermalConductivity" "specificHeatCapacity" "jHTSOverjCritical" "criticalCurrent" "axialComponentOfTheMagneticField" "debug" "jHTS" "currentSharingIndex" "arcLength" "turnNumber" |
relative |
float |
Required | Relative tolerance for the quantity. |
absolute |
float |
Required | Absolute tolerance for the quantity |
normType |
Literal[str] |
"L2Norm" |
Sometimes, tolerances return a vector instead of a scalar (ex, solutionVector). Then, the magnitude of the tolerance should be calculated with a method. Norm type selects this method. Available inputs: "L1Norm", "MeanL1Norm", "L2Norm", "MeanL2Norm", "LinfNorm" |
position |
Pancake3DPositionInCoordinates | Pancake3DPositionInTurnNumbers |
Required | Probing position of the quantity for tolerance. |
Pancake3DSolvePowerDensity
| Field | Type | Default | Description |
|---|---|---|---|
power |
Optional[float] |
0 |
The power in W for an imposed power density in the winding. 'startTime', 'endTime', 'startTurn', and 'endTurn' are also required to be set. |
startTime |
Optional[float] |
0 |
The start time for the imposed power density in the winding. 'power', 'endTime', 'startTurn', and 'endTurn' are also required to be set. |
endTime |
Optional[float] |
0 |
The end time for the imposed power density in the winding. 'power', 'startTime', 'startTurn', and 'endTurn' are also required to be set. |
startArcLength |
Optional[float] |
0 |
The start arc length in m for the imposed power density in the winding. 'power', 'startTime', 'endTime', and 'endArcLength' are also required to be set. |
endArcLength |
Optional[float] |
0 |
The end arc length in m for the imposed power density in the winding. 'power', 'startTime', 'endTime', and 'startArcLength' are also required to be set. |
Pancake3DSolveSaveQuantity
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] | Literal[str] |
Required | Name of the quantity to be saved. Available inputs: "currentThroughCoil" "voltageBetweenTerminals" "inductance" "timeConstant" "totalResistiveHeating" "magneticEnergy" "maximumTemperature" "cryocoolerAveragePower" "cryocoolerAverageTemperature" |
timesToBeSaved |
Optional[list] |
null |
List of times that wanted to be saved. If not given, all the time steps will be saved. |
Pancake3DSolveShuntLayerMaterial
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveHTSShuntLayerMaterial] |
{...} (16 fields) |
Material from STEAM material library. |
Pancake3DSolveTerminalMaterialAndBoundaryCondition
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveNormalMaterial] |
null |
Material from STEAM material library. |
cooling |
Literal[str] |
"fixedTemperature" |
Cooling condition of the terminal. It can be either adiabatic, fixed temperature, or cryocooler. Available inputs: "adiabatic", "fixedTemperature", "cryocooler" |
cryocoolerOptions |
Optional[Pancake3DTerminalCryocoolerBoundaryCondition] |
{...} (3 fields) |
Additional inputs for the cryocooler boundary condition. |
transitionNotch |
Pancake3DSolveMaterial |
Required | Material properties of the transition notch volume. |
terminalContactLayer |
Pancake3DSolveMaterial |
Required | Material properties of the transition layer between terminals and windings. |
Pancake3DSolveTimeAdaptive
| Field | Type | Default | Description |
|---|---|---|---|
start |
float |
Required | Start time of the simulation. |
end |
float |
Required | End time of the simulation. |
extrapolationOrder |
Literal[int] |
1 |
Before solving for the next time steps, the previous solutions can be extrapolated for better convergence. Available inputs: 0, 1, 2, 3 |
timeSteppingType |
str |
"adaptive" |
|
adaptiveSteppingSettings |
Pancake3DSolveAdaptiveTimeLoopSettings |
Required | Adaptive time loop settings (only used if stepping type is adaptive). |
Pancake3DSolveTimeFixed
| Field | Type | Default | Description |
|---|---|---|---|
start |
float |
Required | Start time of the simulation. |
end |
float |
Required | End time of the simulation. |
extrapolationOrder |
Literal[int] |
1 |
Before solving for the next time steps, the previous solutions can be extrapolated for better convergence. Available inputs: 0, 1, 2, 3 |
timeSteppingType |
str |
"fixed" |
|
fixedSteppingSettings |
list | Pancake3DSolveFixedTimeLoopSettings |
Required | Fixed time loop settings (only used if stepping type is fixed). |
Pancake3DSolveWindingMaterial
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[list] |
null |
List of materials of HTS CC. |
shuntLayer |
Pancake3DSolveShuntLayerMaterial |
Pancake3DSolveShuntLayerMaterial() |
Material properties of the shunt layer. |
isotropic |
Optional[bool] |
False |
If True, resistivity and thermal conductivity are isotropic. If False, they are anisotropic. The default is anisotropic material. |
minimumPossibleResistivity |
float |
1e-20 |
The resistivity of the winding won't be lower than this value, no matter what. |
maximumPossibleResistivity |
float |
0.01 |
The resistivity of the winding won't be higher than this value, no matter what. |
Pancake3DTerminalCryocoolerBoundaryCondition
| Field | Type | Default | Description |
|---|---|---|---|
coolingPowerMultiplier |
float |
1 |
Multiplier for the cooling power. It can be used to scale the cooling power given by the coldhead capacity map by a non-negative float factor. |
staticHeatLoadPower |
float |
0 |
Static heat load power in W. It can be used to add a static heat load to the cryocooler, i.e., decrease the power available for cooling. The actual cooling power is P(t) = P_cryocooler(T) - P_staticLoad. |
lumpedMass |
Pancake3DTerminalCryocoolerLumpedMass |
Pancake3DTerminalCryocoolerLumpedMass() |
Thermal lumped mass between second stage of the cryocooler and pancake coil modeled via TSA. |
Pancake3DTerminalCryocoolerLumpedMass
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveNormalMaterial] |
{...} (15 fields) |
Material from STEAM material library. |
volume |
float |
0 |
Volume of the lumped thermal mass between second stage of the cryocooler and pancake coil in m^3. A zero value effectively disables the lumped thermal mass between second stage of the cryocooler and pancake coil. |
numberOfThinShellElements |
int |
1 |
Number of thin shell elements in the FE formulation (GetDP related, not physical and only used when TSA is set to True) |
Pancake3DGeometry
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
conductorWrite |
bool |
False |
To Write the Conductor File |
numberOfPancakes |
int |
Required | Number of pancake coils stacked on top of each other. |
gapBetweenPancakes |
float |
Required | Gap distance between the pancake coils. |
winding |
Pancake3DGeometryWinding |
Required | This dictionary contains the winding geometry information. |
contactLayer |
Pancake3DGeometryContactLayer |
Required | This dictionary contains the contact layer geometry information. |
terminals |
Pancake3DGeometryTerminals |
Required | This dictionary contains the terminals geometry information. |
air |
Pancake3DGeometryAirCylinder |
Pancake3DGeometryAirCuboid |
Required |
dimensionTolerance |
float |
1e-08 |
dimension tolerance (CAD related, not physical) |
pancakeBoundaryName |
str |
"PancakeBoundary" |
name of the pancake's curves that touches the air to be used in the mesh |
contactLayerBoundaryName |
str |
"contactLayerBoundary" |
name of the contact layers's curves that touches the air to be used in the mesh (only for TSA) |
Nested Models
Pancake3DGeometryAirCuboid
| Field | Type | Default | Description |
|---|---|---|---|
axialMargin |
float |
Required | Axial margin between the ends of the air and first/last pancake coils. |
name |
str |
"air" |
The name to be used in the mesh. |
shellTransformation |
bool |
False |
Generate outer shell air to apply shell transformation if True (GetDP related, not physical) |
shellTransformationMultiplier |
float |
1.2 |
multiply the air's outer dimension by this value to get the shell's outer dimension |
cutName |
str |
"Air-Cut" |
name of the cut (cochain) to be used in the mesh |
shellVolumeName |
str |
"air-Shell" |
name of the shell volume to be used in the mesh |
generateGapAirWithFragment |
bool |
False |
generate the gap air with gmsh/model/occ/fragment if true (CAD related, not physical) |
type |
str |
"cuboid" |
|
sideLength |
float |
null |
Side length of the air (for cuboid type air). |
Pancake3DGeometryAirCylinder
| Field | Type | Default | Description |
|---|---|---|---|
axialMargin |
float |
Required | Axial margin between the ends of the air and first/last pancake coils. |
name |
str |
"air" |
The name to be used in the mesh. |
shellTransformation |
bool |
False |
Generate outer shell air to apply shell transformation if True (GetDP related, not physical) |
shellTransformationMultiplier |
float |
1.2 |
multiply the air's outer dimension by this value to get the shell's outer dimension |
cutName |
str |
"Air-Cut" |
name of the cut (cochain) to be used in the mesh |
shellVolumeName |
str |
"air-Shell" |
name of the shell volume to be used in the mesh |
generateGapAirWithFragment |
bool |
False |
generate the gap air with gmsh/model/occ/fragment if true (CAD related, not physical) |
type |
str |
"cylinder" |
|
radius |
float |
null |
Radius of the air (for cylinder type air). |
Pancake3DGeometryContactLayer
| Field | Type | Default | Description |
|---|---|---|---|
thinShellApproximation |
bool |
Required | If True, the contact layer will be modeled with 2D shell elements (thin shell approximation), and if False, the contact layer will be modeled with 3D elements. |
thickness |
float |
Required | Thickness of the contact layer.It is the total thickness of the contact or insulation layer.In particular, for perfect insulation this would be the sum of the insulation layer of the two adjacent CC with an insulation layer of thickness t/2 on each side. |
name |
str |
"contactLayer" |
The name to be used in the mesh. |
Pancake3DGeometryInnerTerminal
| Field | Type | Default | Description |
|---|---|---|---|
thickness |
float |
Required | Thickness of the terminal's tube. |
name |
str |
"innerTerminal" |
The name to be used in the mesh. |
Pancake3DGeometryOuterTerminal
| Field | Type | Default | Description |
|---|---|---|---|
thickness |
float |
Required | Thickness of the terminal's tube. |
name |
str |
"outerTerminal" |
The name to be used in the mesh. |
Pancake3DGeometryTerminals
| Field | Type | Default | Description |
|---|---|---|---|
inner |
Pancake3DGeometryInnerTerminal |
Required | |
outer |
Pancake3DGeometryOuterTerminal |
Required | |
firstName |
str |
"firstTerminal" |
name of the first terminal |
lastName |
str |
"lastTerminal" |
name of the last terminal |
Pancake3DGeometryWinding
| Field | Type | Default | Description |
|---|---|---|---|
innerRadius |
float |
Required | Inner radius of the winding. |
thickness |
float |
Required | Thickness of the winding. |
numberOfTurns |
float |
Required | Number of turns of the winding. |
height |
float |
Required | Height/width of the winding. |
name |
str |
"winding" |
The The name to be used in the mesh.. |
numberOfVolumesPerTurn |
int |
2 |
The number of volumes per turn (CAD related, not physical). |
Pancake3DGeometryAirBase
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
axialMargin |
float |
Required | Axial margin between the ends of the air and first/last pancake coils. |
name |
str |
"air" |
The name to be used in the mesh. |
shellTransformation |
bool |
False |
Generate outer shell air to apply shell transformation if True (GetDP related, not physical) |
shellTransformationMultiplier |
float |
1.2 |
multiply the air's outer dimension by this value to get the shell's outer dimension |
cutName |
str |
"Air-Cut" |
name of the cut (cochain) to be used in the mesh |
shellVolumeName |
str |
"air-Shell" |
name of the shell volume to be used in the mesh |
generateGapAirWithFragment |
bool |
False |
generate the gap air with gmsh/model/occ/fragment if true (CAD related, not physical) |
Pancake3DGeometryContactLayer
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
thinShellApproximation |
bool |
Required | If True, the contact layer will be modeled with 2D shell elements (thin shell approximation), and if False, the contact layer will be modeled with 3D elements. |
thickness |
float |
Required | Thickness of the contact layer.It is the total thickness of the contact or insulation layer.In particular, for perfect insulation this would be the sum of the insulation layer of the two adjacent CC with an insulation layer of thickness t/2 on each side. |
name |
str |
"contactLayer" |
The name to be used in the mesh. |
Pancake3DGeometryInnerTerminal
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
thickness |
float |
Required | Thickness of the terminal's tube. |
name |
str |
"innerTerminal" |
The name to be used in the mesh. |
Pancake3DGeometryOuterTerminal
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
thickness |
float |
Required | Thickness of the terminal's tube. |
name |
str |
"outerTerminal" |
The name to be used in the mesh. |
Pancake3DGeometryTerminalBase
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
thickness |
float |
Required | Thickness of the terminal's tube. |
Pancake3DGeometryTerminals
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
inner |
Pancake3DGeometryInnerTerminal |
Required | |
outer |
Pancake3DGeometryOuterTerminal |
Required | |
firstName |
str |
"firstTerminal" |
name of the first terminal |
lastName |
str |
"lastTerminal" |
name of the last terminal |
Nested Models
Pancake3DGeometryInnerTerminal
| Field | Type | Default | Description |
|---|---|---|---|
thickness |
float |
Required | Thickness of the terminal's tube. |
name |
str |
"innerTerminal" |
The name to be used in the mesh. |
Pancake3DGeometryOuterTerminal
| Field | Type | Default | Description |
|---|---|---|---|
thickness |
float |
Required | Thickness of the terminal's tube. |
name |
str |
"outerTerminal" |
The name to be used in the mesh. |
Pancake3DGeometryWinding
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
innerRadius |
float |
Required | Inner radius of the winding. |
thickness |
float |
Required | Thickness of the winding. |
numberOfTurns |
float |
Required | Number of turns of the winding. |
height |
float |
Required | Height/width of the winding. |
name |
str |
"winding" |
The The name to be used in the mesh.. |
numberOfVolumesPerTurn |
int |
2 |
The number of volumes per turn (CAD related, not physical). |
Pancake3DMesh
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
winding |
Pancake3DMeshWinding |
Required | This dictionary contains the winding mesh information. |
contactLayer |
Pancake3DMeshContactLayer |
Required | This dictionary contains the contact layer mesh information. |
terminals |
Pancake3DMeshAirAndTerminals |
Pancake3DMeshAirAndTerminals() |
This dictionary contains the terminal mesh information. |
air |
Pancake3DMeshAirAndTerminals |
Pancake3DMeshAirAndTerminals() |
This dictionary contains the air mesh information. |
computeCohomologyForInsulating |
bool |
True |
Expert option only. If False, the cohomology regions needed for simulating an insulating coilwill not be computed. This will reduce the time spent for the meshing or more accurately the cohomology computing phase. BEWARE: The simulation will fail if set to False and a perfectlyInsulating coil is simulated. |
minimumElementSize |
float |
Required | The minimum mesh element size in terms of the largest mesh size in the winding. This mesh size will be used in the regions close the the winding, and then the mesh size will increate to maximum mesh element size as it gets away from the winding. |
maximumElementSize |
float |
Required | The maximum mesh element size in terms of the largest mesh size in the winding. This mesh size will be used in the regions close the the winding, and then the mesh size will increate to maximum mesh element size as it gets away from the winding. |
Nested Models
Pancake3DMeshAirAndTerminals
| Field | Type | Default | Description |
|---|---|---|---|
structured |
bool |
False |
If True, the mesh will be structured. If False, the mesh will be unstructured. |
radialElementSize |
float |
1 |
If structured mesh is used, the radial element size can be set. It is the radial element size in terms of the winding's radial element size. |
Pancake3DMeshContactLayer
| Field | Type | Default | Description |
|---|---|---|---|
radialNumberOfElementsPerTurn |
list |
Required | The number of radial elements per tape of the contact layer. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil. |
Pancake3DMeshWinding
| Field | Type | Default | Description |
|---|---|---|---|
axialNumberOfElements |
list | int |
Required | The number of axial elements for the whole height of the coil. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil. |
azimuthalNumberOfElementsPerTurn |
list | int |
Required | The number of azimuthal elements per turn of the coil. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil. |
radialNumberOfElementsPerTurn |
list | int |
Required | The number of radial elements per tape of the winding. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil. |
axialDistributionCoefficient |
list | float |
[...] (1 items) |
If 1, it won't affect anything. If smaller than 1, elements will get finer in the axial direction at the ends of the coil. If greater than 1, elements will get coarser in the axial direction at the ends of the coil. It can be either a list of floats to specify the value for each pancake coil separately or a float to use the same setting for each pancake coil. |
elementType |
list[Literal[str]] | Literal[str] |
[...] (1 items) |
The element type of windings and contact layers. It can be either a tetrahedron, hexahedron, or a prism. It can be either a list of strings to specify the value for each pancake coil separately or a string to use the same setting for each pancake coil. Available inputs: "tetrahedron", "hexahedron", "prism" |
Pancake3DMeshAirAndTerminals
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
structured |
bool |
False |
If True, the mesh will be structured. If False, the mesh will be unstructured. |
radialElementSize |
float |
1 |
If structured mesh is used, the radial element size can be set. It is the radial element size in terms of the winding's radial element size. |
Pancake3DMeshContactLayer
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
radialNumberOfElementsPerTurn |
list |
Required | The number of radial elements per tape of the contact layer. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil. |
Pancake3DMeshWinding
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
axialNumberOfElements |
list | int |
Required | The number of axial elements for the whole height of the coil. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil. |
azimuthalNumberOfElementsPerTurn |
list | int |
Required | The number of azimuthal elements per turn of the coil. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil. |
radialNumberOfElementsPerTurn |
list | int |
Required | The number of radial elements per tape of the winding. It can be either a list of integers to specify the value for each pancake coil separately or an integer to use the same setting for each pancake coil. |
axialDistributionCoefficient |
list | float |
[...] (1 items) |
If 1, it won't affect anything. If smaller than 1, elements will get finer in the axial direction at the ends of the coil. If greater than 1, elements will get coarser in the axial direction at the ends of the coil. It can be either a list of floats to specify the value for each pancake coil separately or a float to use the same setting for each pancake coil. |
elementType |
list[Literal[str]] | Literal[str] |
[...] (1 items) |
The element type of windings and contact layers. It can be either a tetrahedron, hexahedron, or a prism. It can be either a list of strings to specify the value for each pancake coil separately or a string to use the same setting for each pancake coil. Available inputs: "tetrahedron", "hexahedron", "prism" |
Pancake3DPostprocess
Module: DataFiQuSPancake3D
Description: TO BE UPDATED
Fields
| Field | Type | Default | Description |
|---|---|---|---|
timeSeriesPlots |
Optional[list] |
null |
Values can be plotted with respect to time. |
magneticFieldOnCutPlane |
Optional[Pancake3DPostprocessMagneticFieldOnPlane] |
null |
Color map of the magnetic field on the YZ plane can be plotted with streamlines. |
Nested Models
Pancake3DPositionInCoordinates
| Field | Type | Default | Description |
|---|---|---|---|
x |
float |
Required | x coordinate of the position. |
y |
float |
Required | y coordinate of the position. |
z |
float |
Required | z coordinate of the position. |
Pancake3DPositionInTurnNumbers
| Field | Type | Default | Description |
|---|---|---|---|
turnNumber |
float |
Required | Winding turn number as a position input. It starts from 0 and it can be a float. |
whichPancakeCoil |
Optional[int] |
null |
The first pancake coil is 1, the second is 2, etc. |
Pancake3DPostprocessMagneticFieldOnPlane
| Field | Type | Default | Description |
|---|---|---|---|
colormap |
str |
"viridis" |
Colormap for the plot. |
streamLines |
bool |
True |
If True, streamlines will be plotted. Note that magnetic field vectors may have components perpendicular to the plane, and streamlines will be drawn depending on the vectors' projection onto the plane. |
interpolationMethod |
Literal[str] |
"linear" |
Interpolation type for the plot.Because of the FEM basis function selections of FiQuS, each mesh element has a constant magnetic field vector. Therefore, for smooth 2D plots, interpolation can be used.Types:nearest: it will plot the nearest magnetic field value to the plotting point.linear: it will do linear interpolation to the magnetic field values.cubic: it will do cubic interpolation to the magnetic field values. Available inputs: "nearest", "linear", "cubic" |
timesToBePlotted |
Optional[list] |
null |
List of times that wanted to be plotted. If not given, all the time steps will be plotted. |
planeNormal |
list |
[...] (3 items) |
Normal vector of the plane. The default is YZ-plane (1, 0, 0). |
planeXAxisUnitVector |
list |
[...] (3 items) |
If an arbitrary plane is wanted to be plotted, the arbitrary plane's X axis unit vector must be specified. The dot product of the plane's X axis and the plane's normal vector must be zero. |
Pancake3DPostprocessTimeSeriesPlotPositionNotRequired
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] |
Required | Name of the quantity to be plotted. Available inputs: "currentThroughCoil" "voltageBetweenTerminals" "inductance" "timeConstant" "totalResistiveHeating" "magneticEnergy" "maximumTemperature" "cryocoolerAveragePower" "cryocoolerAverageTemperature" |
Pancake3DPostprocessTimeSeriesPlotPositionRequired
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] |
Required | Name of the quantity to be plotted. Available inputs: "magneticField" "magnitudeOfMagneticField" "currentDensity" "magnitudeOfCurrentDensity" "resistiveHeating" "temperature" "criticalCurrentDensity" "heatFlux" "resistivity" "thermalConductivity" "specificHeatCapacity" "jHTSOverjCritical" "criticalCurrent" "axialComponentOfTheMagneticField" "debug" "jHTS" "currentSharingIndex" "arcLength" "turnNumber" |
position |
Pancake3DPositionInCoordinates | Pancake3DPositionInTurnNumbers |
Required | Probing position of the quantity for time series plot. |
Pancake3DPostprocessTimeSeriesPlotBase
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
str |
Required |
Pancake3DSolve
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
time |
Pancake3DSolveTimeAdaptive |
Pancake3DSolveTimeFixed |
Required |
nonlinearSolver |
Optional[Pancake3DSolveNonlinearSolverSettings] |
Required | All the nonlinear solver related settings. |
winding |
Pancake3DSolveWindingMaterial |
Required | This dictionary contains the winding material properties. |
contactLayer |
Pancake3DSolveContactLayerMaterial |
Required | This dictionary contains the contact layer material properties. |
terminals |
Pancake3DSolveTerminalMaterialAndBoundaryCondition |
Required | This dictionary contains the terminals material properties and cooling condition. |
air |
Pancake3DSolveAir |
Required | This dictionary contains the air material properties. |
initialConditions |
Pancake3DSolveInitialConditions |
Required | Initial conditions of the problem. |
boundaryConditions |
str | Pancake3DSolveImposedField |
"vanishingTangentialElectricField" |
Boundary conditions of the problem. |
quantitiesToBeSaved |
list |
null |
List of quantities to be saved. |
type |
Literal[str] |
Required | FiQuS/Pancake3D can solve only electromagnetic and thermal or electromagnetic and thermal coupled. In the weaklyCoupled setting, thermal and electromagnetics systems will be put into different matrices, whereas in the stronglyCoupled setting, they all will be combined into the same matrix. The solution should remain the same. Available inputs: "electromagnetic", "thermal", "weaklyCoupled", "stronglyCoupled" |
proTemplate |
str |
"Pancake3D_template.pro" |
file name of the .pro template file |
localDefects |
Pancake3DSolveLocalDefects |
Pancake3DSolveLocalDefects() |
Local defects (like making a small part of the winding normal conductor at some time) can be introduced. |
initFromPrevious |
str |
"" |
The simulation is continued from an existing .res file. The .res file is from a previous computation on the same geometry and mesh. The .res file is taken from the folder Solution_< |
isothermalInAxialDirection |
bool |
False |
If True, the DoF along the axial direction will be equated. This means that the temperature will be the same along the axial direction reducing the number of DoF. This is only valid for the thermal analysis. |
voltageTapPositions |
Optional[list] |
[] |
List of voltage tap positions. The position can be given in the form of a list of [x, y, z] coordinates or as turnNumber and number of pancake coil. |
EECircuit |
Optional[Pancake3DSolveEECircuit] |
{...} (9 fields) |
This dictionary contains the detection circuit settings. |
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. |
resistiveHeatingTerminals |
bool |
True |
If True, terminals are subject to Joule heating. If False, terminal regions are not subject to Joule heating. In both cases, heat conduction through the terminal is considered. |
solveHeatEquationTerminalsTransitionNotch |
bool |
True |
If True, the heat equation is solved in the terminals and transition notch.If False, the heat equation is not solved in the terminals and transition notches.In the latter case, neither heat conduction nor generation are considered.In other words, the temperature is not an unknown of the problem in the terminals. |
heatFlowBetweenTurns |
bool |
True |
If True, heat flow between turns is considered. If False, it is not considered. In the latter case, heat conduction is only considered to the middle of the winding in the thin shell approximation in order to keep the thermal mass of the insulation included. In the middle between the turns, an adiabatic condition is applied. Between the turns refers to the region between the winding turns, NOT to the region between terminals and the first and last turn. This feature is only implemented for the thin shell approximation. |
convectiveCooling |
Optional[Pancake3DSolveConvectiveCooling] |
{...} (2 fields) |
This dictionary contains the convective cooling settings. |
imposedPowerDensity |
Optional[Pancake3DSolvePowerDensity] |
null |
The power density for an imposed power density in the winding. |
materialParametersUseCoilField |
bool |
True |
If True, the total field (i.e., coil field plus potentially imposed field)will be used for the material (default).If False, only the imposed field (can be zero) will be used. |
stopWhenTemperatureReaches |
Optional[float] |
0 |
If the maximum temperature reaches this value, the simulation will be stopped. |
Nested Models
Pancake3DPositionInCoordinates
| Field | Type | Default | Description |
|---|---|---|---|
x |
float |
Required | x coordinate of the position. |
y |
float |
Required | y coordinate of the position. |
z |
float |
Required | z coordinate of the position. |
Pancake3DPositionInTurnNumbers
| Field | Type | Default | Description |
|---|---|---|---|
turnNumber |
float |
Required | Winding turn number as a position input. It starts from 0 and it can be a float. |
whichPancakeCoil |
Optional[int] |
null |
The first pancake coil is 1, the second is 2, etc. |
Pancake3DSolveAdaptiveTimeLoopSettings
| Field | Type | Default | Description |
|---|---|---|---|
tolerances |
list |
Required | Time steps or nonlinear iterations will be refined until the tolerances are satisfied. |
initialStep |
float |
Required | Initial step for adaptive time stepping |
minimumStep |
float |
Required | The simulation will be aborted if a finer time step is required than this minimum step value. |
maximumStep |
float |
Required | Bigger steps than this won't be allowed |
integrationMethod |
Literal[str] |
"Euler" |
Integration method for transient analysis Available inputs: "Euler", "Gear_2", "Gear_3", "Gear_4", "Gear_5", "Gear_6" |
breakPoints_input |
list |
[...] (1 items) |
Make sure to solve the system for these times. |
Pancake3DSolveAir
| Field | Type | Default | Description |
|---|---|---|---|
permeability |
float |
Required | Permeability of air. |
Pancake3DSolveContactLayerMaterial
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
float | str |
null |
A scalar value or "perfectlyInsulating". If "perfectlyInsulating" is given, the contact layer will be perfectly insulating. If this value is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveNormalMaterial] |
null |
Material from STEAM material library. |
numberOfThinShellElements |
int |
1 |
Number of thin shell elements in the FE formulation (GetDP related, not physical and only used when TSA is set to True) |
Pancake3DSolveConvectiveCooling
| Field | Type | Default | Description |
|---|---|---|---|
heatTransferCoefficient |
Optional[float | str] |
0 |
The heat transfer coefficient for the heat transfer between the winding and the air. If zero, no heat transfer to the air is considered.This feature is only implemented for the thin shell approximation.At the moment, only constant values are supported. |
exteriorBathTemperature |
Optional[float] |
4.2 |
The temperature of the exterior bath for convective cooling boundary condition. |
Pancake3DSolveEECircuit
| Field | Type | Default | Description |
|---|---|---|---|
inductanceInSeriesWithPancakeCoil |
Optional[float] |
0 |
A lumped inductance in series with the pancake coil to model a bigger coil. |
enable |
bool |
False |
Enable the detection circuit for the pancake coil. |
ResistanceEnergyExtractionOpenSwitch |
Optional[float] |
1000000.0 |
The resistance of the energy extraction switch when modeled as open. |
ResistanceEnergyExtractionClosedSwitch |
Optional[float] |
1e-06 |
The resistance of the energy extraction switch when modeled as closed. |
ResistanceCrowbarOpenSwitch |
Optional[float] |
1000000.0 |
The resistance of the crowbar switch when modeled as open. |
ResistanceCrowbarClosedSwitch |
Optional[float] |
1e-06 |
The resistance of the crowbar switch when modeled as closed. |
stopSimulationAtCurrent |
Optional[float] |
0 |
If a quench is detected and the current reaches this value, the simulation will be stopped after. stopSimulationWaitingTime seconds. |
stopSimulationWaitingTime |
Optional[float] |
0 |
The time to wait after a quench is detected and the current reaches stopSimulationAtCurrent before stopping the simulation. |
TurnOffDeltaTimePowerSupply |
Optional[float] |
0 |
The time it takes for the power supply to be turned off after quench detection. A linear ramp-down is assumed between the time of quench detection and the time of power supply turn off. |
Pancake3DSolveFixedLoopInterval
| Field | Type | Default | Description |
|---|---|---|---|
startTime |
float |
Required | Start time of the interval. |
endTime |
float |
Required | End time of the interval. |
step |
float |
Required | Time step for the interval |
Pancake3DSolveFixedTimeLoopSettings
| Field | Type | Default | Description |
|---|---|---|---|
step |
float |
Required | Time step for fixed time stepping. |
Pancake3DSolveHTSNormalMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
Required | Available inputs: "Copper", "Hastelloy", "Silver", "Indium", "Stainless Steel", "Kapton", "G10" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
relativeThickness |
float |
Required | Winding tapes generally consist of more than one material. Therefore, when materials are given as a list in winding, their relative thickness, (thickness of the material) / (thickness of the bare conductor), should be specified. |
Pancake3DSolveHTSShuntLayerMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
"Copper" |
Available inputs: "Copper", "Hastelloy", "Silver", "Indium", "Stainless Steel", "Kapton", "G10" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
relativeHeight |
float |
0.0 |
HTS 2G coated conductor are typically plated, usually using copper. The relative height of the shunt layer is the width of the shunt layer divided by the width of the tape. 0 means no shunt layer. |
Pancake3DSolveHTSSuperconductingMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
Required | Available inputs: "HTSSuperPower", "HTSFujikura", "HTSSucci" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
nValue |
float |
30 |
N-value for E-J power law. |
IcAtTAndBref |
float | Pancake3DSolveIcVsLengthCSV | Pancake3DSolveIcVsLengthList |
Required | Critical current in A at reference temperature and magnetic field.The critical current value will change with temperature depending on the superconductor material.Either the same critical current for the whole tape or the critical current with respect to the tape length can be specified. To specify the same critical current for the entire tape, just use a scalar. To specify critical current with respect to the tape length: a CSV file can be used, or lengthValues and criticalCurrentValues can be given as lists. The data will be linearly interpolated.If a CSV file is to be used, the input should be the name of a CSV file (which is in the same folder as the input file) instead of a scalar. The first column of the CSV file will be the tape length in m, and the second column will be the critical current in A. |
electricFieldCriterion |
float |
0.0001 |
The electric field that defines the critical current density, i.e., the electric field at which the current density reaches the critical current density. |
jCriticalScalingNormalToWinding |
float |
1 |
Critical current scaling normal to winding, i.e., along the c_axis. We have Jc_cAxis = scalingFactor * Jc_abPlane. A factor of 1 means no scaling such that the HTS layer is isotropic. |
IcReferenceTemperature |
float |
77 |
Critical current reference temperature in Kelvin. |
IcReferenceBmagnitude |
float |
0.0 |
Critical current reference magnetic field magnitude in Tesla. |
IcReferenceBangle |
float |
90.0 |
Critical current reference magnetic field angle in degrees.0 degrees means the magnetic field is normal to the tape's wide surfaceand 90 degrees means the magnetic field is parallel to the tape's widesurface. |
relativeThickness |
float |
Required | Winding tapes generally consist of more than one material. Therefore, when materials are given as a list in winding, their relative thickness, (thickness of the material) / (thickness of the bare conductor), should be specified. |
Pancake3DSolveIcVsLengthCSV
| Field | Type | Default | Description |
|---|---|---|---|
csvFile |
str |
Required | The path of the CSV file that contains the critical current values. |
lengthUnit |
str |
Required | Unit of the critical current values. It can be either the arc length in meter or the number of turns. |
Pancake3DSolveIcVsLengthList
| Field | Type | Default | Description |
|---|---|---|---|
lengthValues |
list |
Required | Tape length values that corresponds to criticalCurrentValues. |
criticalCurrentValues |
list |
Required | Critical current values that corresponds to lengthValues. |
lengthUnit |
str |
Required | Unit of the critical current values. It can be either the arc length in meter or the number of turns. |
Pancake3DSolveImposedField
| Field | Type | Default | Description |
|---|---|---|---|
imposedAxialField |
float |
Required | Imposed axial magnetic field in Tesla. Only constant, purely axial magnetic fields are supported at the moment. |
Pancake3DSolveInitialConditions
| Field | Type | Default | Description |
|---|---|---|---|
temperature |
float |
Required | Initial temperature of the pancake coils. |
Pancake3DSolveLocalDefect
| Field | Type | Default | Description |
|---|---|---|---|
value |
float |
Required | Value of the local defect. |
startTurn |
float |
Required | Start turn of the local defect. |
endTurn |
float |
Required | End turn of the local defect. |
startTime |
float |
Required | Start time of the local defect. |
transitionDuration |
float |
0 |
Transition duration of the local defect. If not given, the transition will be instantly. |
whichPancakeCoil |
Optional[int] |
null |
The first pancake coil is 1, the second is 2, etc. |
Pancake3DSolveLocalDefects
| Field | Type | Default | Description |
|---|---|---|---|
criticalCurrentDensity |
Optional[Pancake3DSolveLocalDefect] |
null |
Set critical current density locally. |
Pancake3DSolveMaterial
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveNormalMaterial] |
null |
Material from STEAM material library. |
Pancake3DSolveNonlinearSolverSettings
| Field | Type | Default | Description |
|---|---|---|---|
tolerances |
list |
Required | Time steps or nonlinear iterations will be refined until the tolerances are satisfied. |
maximumNumberOfIterations |
int |
100 |
Maximum number of iterations allowed for the nonlinear solver. |
relaxationFactor |
float |
0.7 |
Calculated step changes of the solution vector will be multiplied with this value for better convergence. |
Pancake3DSolveNormalMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
Required | Available inputs: "Copper", "Hastelloy", "Silver", "Indium", "Stainless Steel", "Kapton", "G10" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
Pancake3DSolvePositionNotRequiredTolerance
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] | Literal[str] |
Required | Name of the quantity for tolerance. Available inputs: "electromagneticSolutionVector", "thermalSolutionVector", "coupledSolutionVector" |
relative |
float |
Required | Relative tolerance for the quantity. |
absolute |
float |
Required | Absolute tolerance for the quantity |
normType |
Literal[str] |
"L2Norm" |
Sometimes, tolerances return a vector instead of a scalar (ex, solutionVector). Then, the magnitude of the tolerance should be calculated with a method. Norm type selects this method. Available inputs: "L1Norm", "MeanL1Norm", "L2Norm", "MeanL2Norm", "LinfNorm" |
Pancake3DSolvePositionRequiredTolerance
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] |
Required | Name of the quantity for tolerance. Available inputs: "magneticField" "magnitudeOfMagneticField" "currentDensity" "magnitudeOfCurrentDensity" "resistiveHeating" "temperature" "criticalCurrentDensity" "heatFlux" "resistivity" "thermalConductivity" "specificHeatCapacity" "jHTSOverjCritical" "criticalCurrent" "axialComponentOfTheMagneticField" "debug" "jHTS" "currentSharingIndex" "arcLength" "turnNumber" |
relative |
float |
Required | Relative tolerance for the quantity. |
absolute |
float |
Required | Absolute tolerance for the quantity |
normType |
Literal[str] |
"L2Norm" |
Sometimes, tolerances return a vector instead of a scalar (ex, solutionVector). Then, the magnitude of the tolerance should be calculated with a method. Norm type selects this method. Available inputs: "L1Norm", "MeanL1Norm", "L2Norm", "MeanL2Norm", "LinfNorm" |
position |
Pancake3DPositionInCoordinates | Pancake3DPositionInTurnNumbers |
Required | Probing position of the quantity for tolerance. |
Pancake3DSolvePowerDensity
| Field | Type | Default | Description |
|---|---|---|---|
power |
Optional[float] |
0 |
The power in W for an imposed power density in the winding. 'startTime', 'endTime', 'startTurn', and 'endTurn' are also required to be set. |
startTime |
Optional[float] |
0 |
The start time for the imposed power density in the winding. 'power', 'endTime', 'startTurn', and 'endTurn' are also required to be set. |
endTime |
Optional[float] |
0 |
The end time for the imposed power density in the winding. 'power', 'startTime', 'startTurn', and 'endTurn' are also required to be set. |
startArcLength |
Optional[float] |
0 |
The start arc length in m for the imposed power density in the winding. 'power', 'startTime', 'endTime', and 'endArcLength' are also required to be set. |
endArcLength |
Optional[float] |
0 |
The end arc length in m for the imposed power density in the winding. 'power', 'startTime', 'endTime', and 'startArcLength' are also required to be set. |
Pancake3DSolveSaveQuantity
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] | Literal[str] |
Required | Name of the quantity to be saved. Available inputs: "currentThroughCoil" "voltageBetweenTerminals" "inductance" "timeConstant" "totalResistiveHeating" "magneticEnergy" "maximumTemperature" "cryocoolerAveragePower" "cryocoolerAverageTemperature" |
timesToBeSaved |
Optional[list] |
null |
List of times that wanted to be saved. If not given, all the time steps will be saved. |
Pancake3DSolveShuntLayerMaterial
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveHTSShuntLayerMaterial] |
{...} (16 fields) |
Material from STEAM material library. |
Pancake3DSolveTerminalMaterialAndBoundaryCondition
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveNormalMaterial] |
null |
Material from STEAM material library. |
cooling |
Literal[str] |
"fixedTemperature" |
Cooling condition of the terminal. It can be either adiabatic, fixed temperature, or cryocooler. Available inputs: "adiabatic", "fixedTemperature", "cryocooler" |
cryocoolerOptions |
Optional[Pancake3DTerminalCryocoolerBoundaryCondition] |
{...} (3 fields) |
Additional inputs for the cryocooler boundary condition. |
transitionNotch |
Pancake3DSolveMaterial |
Required | Material properties of the transition notch volume. |
terminalContactLayer |
Pancake3DSolveMaterial |
Required | Material properties of the transition layer between terminals and windings. |
Pancake3DSolveTimeAdaptive
| Field | Type | Default | Description |
|---|---|---|---|
start |
float |
Required | Start time of the simulation. |
end |
float |
Required | End time of the simulation. |
extrapolationOrder |
Literal[int] |
1 |
Before solving for the next time steps, the previous solutions can be extrapolated for better convergence. Available inputs: 0, 1, 2, 3 |
timeSteppingType |
str |
"adaptive" |
|
adaptiveSteppingSettings |
Pancake3DSolveAdaptiveTimeLoopSettings |
Required | Adaptive time loop settings (only used if stepping type is adaptive). |
Pancake3DSolveTimeFixed
| Field | Type | Default | Description |
|---|---|---|---|
start |
float |
Required | Start time of the simulation. |
end |
float |
Required | End time of the simulation. |
extrapolationOrder |
Literal[int] |
1 |
Before solving for the next time steps, the previous solutions can be extrapolated for better convergence. Available inputs: 0, 1, 2, 3 |
timeSteppingType |
str |
"fixed" |
|
fixedSteppingSettings |
list | Pancake3DSolveFixedTimeLoopSettings |
Required | Fixed time loop settings (only used if stepping type is fixed). |
Pancake3DSolveWindingMaterial
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[list] |
null |
List of materials of HTS CC. |
shuntLayer |
Pancake3DSolveShuntLayerMaterial |
Pancake3DSolveShuntLayerMaterial() |
Material properties of the shunt layer. |
isotropic |
Optional[bool] |
False |
If True, resistivity and thermal conductivity are isotropic. If False, they are anisotropic. The default is anisotropic material. |
minimumPossibleResistivity |
float |
1e-20 |
The resistivity of the winding won't be lower than this value, no matter what. |
maximumPossibleResistivity |
float |
0.01 |
The resistivity of the winding won't be higher than this value, no matter what. |
Pancake3DTerminalCryocoolerBoundaryCondition
| Field | Type | Default | Description |
|---|---|---|---|
coolingPowerMultiplier |
float |
1 |
Multiplier for the cooling power. It can be used to scale the cooling power given by the coldhead capacity map by a non-negative float factor. |
staticHeatLoadPower |
float |
0 |
Static heat load power in W. It can be used to add a static heat load to the cryocooler, i.e., decrease the power available for cooling. The actual cooling power is P(t) = P_cryocooler(T) - P_staticLoad. |
lumpedMass |
Pancake3DTerminalCryocoolerLumpedMass |
Pancake3DTerminalCryocoolerLumpedMass() |
Thermal lumped mass between second stage of the cryocooler and pancake coil modeled via TSA. |
Pancake3DTerminalCryocoolerLumpedMass
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveNormalMaterial] |
{...} (15 fields) |
Material from STEAM material library. |
volume |
float |
0 |
Volume of the lumped thermal mass between second stage of the cryocooler and pancake coil in m^3. A zero value effectively disables the lumped thermal mass between second stage of the cryocooler and pancake coil. |
numberOfThinShellElements |
int |
1 |
Number of thin shell elements in the FE formulation (GetDP related, not physical and only used when TSA is set to True) |
Pancake3DSolveAdaptiveTimeLoopSettings
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
tolerances |
list |
Required | Time steps or nonlinear iterations will be refined until the tolerances are satisfied. |
initialStep |
float |
Required | Initial step for adaptive time stepping |
minimumStep |
float |
Required | The simulation will be aborted if a finer time step is required than this minimum step value. |
maximumStep |
float |
Required | Bigger steps than this won't be allowed |
integrationMethod |
Literal[str] |
"Euler" |
Integration method for transient analysis Available inputs: "Euler", "Gear_2", "Gear_3", "Gear_4", "Gear_5", "Gear_6" |
breakPoints_input |
list |
[...] (1 items) |
Make sure to solve the system for these times. |
Nested Models
Pancake3DPositionInCoordinates
| Field | Type | Default | Description |
|---|---|---|---|
x |
float |
Required | x coordinate of the position. |
y |
float |
Required | y coordinate of the position. |
z |
float |
Required | z coordinate of the position. |
Pancake3DPositionInTurnNumbers
| Field | Type | Default | Description |
|---|---|---|---|
turnNumber |
float |
Required | Winding turn number as a position input. It starts from 0 and it can be a float. |
whichPancakeCoil |
Optional[int] |
null |
The first pancake coil is 1, the second is 2, etc. |
Pancake3DSolvePositionNotRequiredTolerance
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] | Literal[str] |
Required | Name of the quantity for tolerance. Available inputs: "electromagneticSolutionVector", "thermalSolutionVector", "coupledSolutionVector" |
relative |
float |
Required | Relative tolerance for the quantity. |
absolute |
float |
Required | Absolute tolerance for the quantity |
normType |
Literal[str] |
"L2Norm" |
Sometimes, tolerances return a vector instead of a scalar (ex, solutionVector). Then, the magnitude of the tolerance should be calculated with a method. Norm type selects this method. Available inputs: "L1Norm", "MeanL1Norm", "L2Norm", "MeanL2Norm", "LinfNorm" |
Pancake3DSolvePositionRequiredTolerance
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] |
Required | Name of the quantity for tolerance. Available inputs: "magneticField" "magnitudeOfMagneticField" "currentDensity" "magnitudeOfCurrentDensity" "resistiveHeating" "temperature" "criticalCurrentDensity" "heatFlux" "resistivity" "thermalConductivity" "specificHeatCapacity" "jHTSOverjCritical" "criticalCurrent" "axialComponentOfTheMagneticField" "debug" "jHTS" "currentSharingIndex" "arcLength" "turnNumber" |
relative |
float |
Required | Relative tolerance for the quantity. |
absolute |
float |
Required | Absolute tolerance for the quantity |
normType |
Literal[str] |
"L2Norm" |
Sometimes, tolerances return a vector instead of a scalar (ex, solutionVector). Then, the magnitude of the tolerance should be calculated with a method. Norm type selects this method. Available inputs: "L1Norm", "MeanL1Norm", "L2Norm", "MeanL2Norm", "LinfNorm" |
position |
Pancake3DPositionInCoordinates | Pancake3DPositionInTurnNumbers |
Required | Probing position of the quantity for tolerance. |
Pancake3DSolveAir
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
permeability |
float |
Required | Permeability of air. |
Pancake3DSolveContactLayerMaterial
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
float | str |
null |
A scalar value or "perfectlyInsulating". If "perfectlyInsulating" is given, the contact layer will be perfectly insulating. If this value is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveNormalMaterial] |
null |
Material from STEAM material library. |
numberOfThinShellElements |
int |
1 |
Number of thin shell elements in the FE formulation (GetDP related, not physical and only used when TSA is set to True) |
Nested Models
Pancake3DSolveNormalMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
Required | Available inputs: "Copper", "Hastelloy", "Silver", "Indium", "Stainless Steel", "Kapton", "G10" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
Pancake3DSolveHTSMaterialBase
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
relativeThickness |
float |
Required | Winding tapes generally consist of more than one material. Therefore, when materials are given as a list in winding, their relative thickness, (thickness of the material) / (thickness of the bare conductor), should be specified. |
Pancake3DSolveInitialConditions
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
temperature |
float |
Required | Initial temperature of the pancake coils. |
Pancake3DSolveLocalDefects
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
criticalCurrentDensity |
Optional[Pancake3DSolveLocalDefect] |
null |
Set critical current density locally. |
Nested Models
Pancake3DSolveLocalDefect
| Field | Type | Default | Description |
|---|---|---|---|
value |
float |
Required | Value of the local defect. |
startTurn |
float |
Required | Start turn of the local defect. |
endTurn |
float |
Required | End turn of the local defect. |
startTime |
float |
Required | Start time of the local defect. |
transitionDuration |
float |
0 |
Transition duration of the local defect. If not given, the transition will be instantly. |
whichPancakeCoil |
Optional[int] |
null |
The first pancake coil is 1, the second is 2, etc. |
Pancake3DSolveMaterial
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveNormalMaterial] |
null |
Material from STEAM material library. |
Nested Models
Pancake3DSolveNormalMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
Required | Available inputs: "Copper", "Hastelloy", "Silver", "Indium", "Stainless Steel", "Kapton", "G10" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
Pancake3DSolveMaterialBase
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
name |
str |
Required | |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
Pancake3DSolveQuantityBase
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] | Literal[str] |
Required | Name of the quantity to be saved. Available inputs: "currentThroughCoil" "voltageBetweenTerminals" "inductance" "timeConstant" "totalResistiveHeating" "magneticEnergy" "maximumTemperature" "cryocoolerAveragePower" "cryocoolerAverageTemperature" |
Pancake3DSolveSettingsWithTolerances
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
tolerances |
list |
Required | Time steps or nonlinear iterations will be refined until the tolerances are satisfied. |
Nested Models
Pancake3DPositionInCoordinates
| Field | Type | Default | Description |
|---|---|---|---|
x |
float |
Required | x coordinate of the position. |
y |
float |
Required | y coordinate of the position. |
z |
float |
Required | z coordinate of the position. |
Pancake3DPositionInTurnNumbers
| Field | Type | Default | Description |
|---|---|---|---|
turnNumber |
float |
Required | Winding turn number as a position input. It starts from 0 and it can be a float. |
whichPancakeCoil |
Optional[int] |
null |
The first pancake coil is 1, the second is 2, etc. |
Pancake3DSolvePositionNotRequiredTolerance
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] | Literal[str] |
Required | Name of the quantity for tolerance. Available inputs: "electromagneticSolutionVector", "thermalSolutionVector", "coupledSolutionVector" |
relative |
float |
Required | Relative tolerance for the quantity. |
absolute |
float |
Required | Absolute tolerance for the quantity |
normType |
Literal[str] |
"L2Norm" |
Sometimes, tolerances return a vector instead of a scalar (ex, solutionVector). Then, the magnitude of the tolerance should be calculated with a method. Norm type selects this method. Available inputs: "L1Norm", "MeanL1Norm", "L2Norm", "MeanL2Norm", "LinfNorm" |
Pancake3DSolvePositionRequiredTolerance
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
Literal[str] |
Required | Name of the quantity for tolerance. Available inputs: "magneticField" "magnitudeOfMagneticField" "currentDensity" "magnitudeOfCurrentDensity" "resistiveHeating" "temperature" "criticalCurrentDensity" "heatFlux" "resistivity" "thermalConductivity" "specificHeatCapacity" "jHTSOverjCritical" "criticalCurrent" "axialComponentOfTheMagneticField" "debug" "jHTS" "currentSharingIndex" "arcLength" "turnNumber" |
relative |
float |
Required | Relative tolerance for the quantity. |
absolute |
float |
Required | Absolute tolerance for the quantity |
normType |
Literal[str] |
"L2Norm" |
Sometimes, tolerances return a vector instead of a scalar (ex, solutionVector). Then, the magnitude of the tolerance should be calculated with a method. Norm type selects this method. Available inputs: "L1Norm", "MeanL1Norm", "L2Norm", "MeanL2Norm", "LinfNorm" |
position |
Pancake3DPositionInCoordinates | Pancake3DPositionInTurnNumbers |
Required | Probing position of the quantity for tolerance. |
Pancake3DSolveShuntLayerMaterial
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveHTSShuntLayerMaterial] |
{...} (16 fields) |
Material from STEAM material library. |
Nested Models
Pancake3DSolveHTSShuntLayerMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
"Copper" |
Available inputs: "Copper", "Hastelloy", "Silver", "Indium", "Stainless Steel", "Kapton", "G10" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
relativeHeight |
float |
0.0 |
HTS 2G coated conductor are typically plated, usually using copper. The relative height of the shunt layer is the width of the shunt layer divided by the width of the tape. 0 means no shunt layer. |
Pancake3DSolveSuperconductingMaterial
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
Required | Available inputs: "HTSSuperPower", "HTSFujikura", "HTSSucci" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
nValue |
float |
30 |
N-value for E-J power law. |
IcAtTAndBref |
float | Pancake3DSolveIcVsLengthCSV | Pancake3DSolveIcVsLengthList |
Required | Critical current in A at reference temperature and magnetic field.The critical current value will change with temperature depending on the superconductor material.Either the same critical current for the whole tape or the critical current with respect to the tape length can be specified. To specify the same critical current for the entire tape, just use a scalar. To specify critical current with respect to the tape length: a CSV file can be used, or lengthValues and criticalCurrentValues can be given as lists. The data will be linearly interpolated.If a CSV file is to be used, the input should be the name of a CSV file (which is in the same folder as the input file) instead of a scalar. The first column of the CSV file will be the tape length in m, and the second column will be the critical current in A. |
electricFieldCriterion |
float |
0.0001 |
The electric field that defines the critical current density, i.e., the electric field at which the current density reaches the critical current density. |
jCriticalScalingNormalToWinding |
float |
1 |
Critical current scaling normal to winding, i.e., along the c_axis. We have Jc_cAxis = scalingFactor * Jc_abPlane. A factor of 1 means no scaling such that the HTS layer is isotropic. |
IcReferenceTemperature |
float |
77 |
Critical current reference temperature in Kelvin. |
IcReferenceBmagnitude |
float |
0.0 |
Critical current reference magnetic field magnitude in Tesla. |
IcReferenceBangle |
float |
90.0 |
Critical current reference magnetic field angle in degrees.0 degrees means the magnetic field is normal to the tape's wide surfaceand 90 degrees means the magnetic field is parallel to the tape's widesurface. |
Nested Models
Pancake3DSolveIcVsLengthCSV
| Field | Type | Default | Description |
|---|---|---|---|
csvFile |
str |
Required | The path of the CSV file that contains the critical current values. |
lengthUnit |
str |
Required | Unit of the critical current values. It can be either the arc length in meter or the number of turns. |
Pancake3DSolveIcVsLengthList
| Field | Type | Default | Description |
|---|---|---|---|
lengthValues |
list |
Required | Tape length values that corresponds to criticalCurrentValues. |
criticalCurrentValues |
list |
Required | Critical current values that corresponds to lengthValues. |
lengthUnit |
str |
Required | Unit of the critical current values. It can be either the arc length in meter or the number of turns. |
Pancake3DSolveTerminalMaterialAndBoundaryCondition
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveNormalMaterial] |
null |
Material from STEAM material library. |
cooling |
Literal[str] |
"fixedTemperature" |
Cooling condition of the terminal. It can be either adiabatic, fixed temperature, or cryocooler. Available inputs: "adiabatic", "fixedTemperature", "cryocooler" |
cryocoolerOptions |
Optional[Pancake3DTerminalCryocoolerBoundaryCondition] |
{...} (3 fields) |
Additional inputs for the cryocooler boundary condition. |
transitionNotch |
Pancake3DSolveMaterial |
Required | Material properties of the transition notch volume. |
terminalContactLayer |
Pancake3DSolveMaterial |
Required | Material properties of the transition layer between terminals and windings. |
Nested Models
Pancake3DSolveMaterial
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveNormalMaterial] |
null |
Material from STEAM material library. |
Pancake3DSolveNormalMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
Required | Available inputs: "Copper", "Hastelloy", "Silver", "Indium", "Stainless Steel", "Kapton", "G10" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
Pancake3DTerminalCryocoolerBoundaryCondition
| Field | Type | Default | Description |
|---|---|---|---|
coolingPowerMultiplier |
float |
1 |
Multiplier for the cooling power. It can be used to scale the cooling power given by the coldhead capacity map by a non-negative float factor. |
staticHeatLoadPower |
float |
0 |
Static heat load power in W. It can be used to add a static heat load to the cryocooler, i.e., decrease the power available for cooling. The actual cooling power is P(t) = P_cryocooler(T) - P_staticLoad. |
lumpedMass |
Pancake3DTerminalCryocoolerLumpedMass |
Pancake3DTerminalCryocoolerLumpedMass() |
Thermal lumped mass between second stage of the cryocooler and pancake coil modeled via TSA. |
Pancake3DTerminalCryocoolerLumpedMass
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveNormalMaterial] |
{...} (15 fields) |
Material from STEAM material library. |
volume |
float |
0 |
Volume of the lumped thermal mass between second stage of the cryocooler and pancake coil in m^3. A zero value effectively disables the lumped thermal mass between second stage of the cryocooler and pancake coil. |
numberOfThinShellElements |
int |
1 |
Number of thin shell elements in the FE formulation (GetDP related, not physical and only used when TSA is set to True) |
Pancake3DSolveTimeBase
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
start |
float |
Required | Start time of the simulation. |
end |
float |
Required | End time of the simulation. |
extrapolationOrder |
Literal[int] |
1 |
Before solving for the next time steps, the previous solutions can be extrapolated for better convergence. Available inputs: 0, 1, 2, 3 |
Pancake3DSolveToleranceBase
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
quantity |
str |
Required | |
relative |
float |
Required | Relative tolerance for the quantity. |
absolute |
float |
Required | Absolute tolerance for the quantity |
normType |
Literal[str] |
"L2Norm" |
Sometimes, tolerances return a vector instead of a scalar (ex, solutionVector). Then, the magnitude of the tolerance should be calculated with a method. Norm type selects this method. Available inputs: "L1Norm", "MeanL1Norm", "L2Norm", "MeanL2Norm", "LinfNorm" |
Pancake3DSolveWindingMaterial
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[list] |
null |
List of materials of HTS CC. |
shuntLayer |
Pancake3DSolveShuntLayerMaterial |
Pancake3DSolveShuntLayerMaterial() |
Material properties of the shunt layer. |
isotropic |
Optional[bool] |
False |
If True, resistivity and thermal conductivity are isotropic. If False, they are anisotropic. The default is anisotropic material. |
minimumPossibleResistivity |
float |
1e-20 |
The resistivity of the winding won't be lower than this value, no matter what. |
maximumPossibleResistivity |
float |
0.01 |
The resistivity of the winding won't be higher than this value, no matter what. |
Nested Models
Pancake3DSolveHTSNormalMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
Required | Available inputs: "Copper", "Hastelloy", "Silver", "Indium", "Stainless Steel", "Kapton", "G10" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
relativeThickness |
float |
Required | Winding tapes generally consist of more than one material. Therefore, when materials are given as a list in winding, their relative thickness, (thickness of the material) / (thickness of the bare conductor), should be specified. |
Pancake3DSolveHTSShuntLayerMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
"Copper" |
Available inputs: "Copper", "Hastelloy", "Silver", "Indium", "Stainless Steel", "Kapton", "G10" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
relativeHeight |
float |
0.0 |
HTS 2G coated conductor are typically plated, usually using copper. The relative height of the shunt layer is the width of the shunt layer divided by the width of the tape. 0 means no shunt layer. |
Pancake3DSolveHTSSuperconductingMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
Required | Available inputs: "HTSSuperPower", "HTSFujikura", "HTSSucci" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |
nValue |
float |
30 |
N-value for E-J power law. |
IcAtTAndBref |
float | Pancake3DSolveIcVsLengthCSV | Pancake3DSolveIcVsLengthList |
Required | Critical current in A at reference temperature and magnetic field.The critical current value will change with temperature depending on the superconductor material.Either the same critical current for the whole tape or the critical current with respect to the tape length can be specified. To specify the same critical current for the entire tape, just use a scalar. To specify critical current with respect to the tape length: a CSV file can be used, or lengthValues and criticalCurrentValues can be given as lists. The data will be linearly interpolated.If a CSV file is to be used, the input should be the name of a CSV file (which is in the same folder as the input file) instead of a scalar. The first column of the CSV file will be the tape length in m, and the second column will be the critical current in A. |
electricFieldCriterion |
float |
0.0001 |
The electric field that defines the critical current density, i.e., the electric field at which the current density reaches the critical current density. |
jCriticalScalingNormalToWinding |
float |
1 |
Critical current scaling normal to winding, i.e., along the c_axis. We have Jc_cAxis = scalingFactor * Jc_abPlane. A factor of 1 means no scaling such that the HTS layer is isotropic. |
IcReferenceTemperature |
float |
77 |
Critical current reference temperature in Kelvin. |
IcReferenceBmagnitude |
float |
0.0 |
Critical current reference magnetic field magnitude in Tesla. |
IcReferenceBangle |
float |
90.0 |
Critical current reference magnetic field angle in degrees.0 degrees means the magnetic field is normal to the tape's wide surfaceand 90 degrees means the magnetic field is parallel to the tape's widesurface. |
relativeThickness |
float |
Required | Winding tapes generally consist of more than one material. Therefore, when materials are given as a list in winding, their relative thickness, (thickness of the material) / (thickness of the bare conductor), should be specified. |
Pancake3DSolveIcVsLengthCSV
| Field | Type | Default | Description |
|---|---|---|---|
csvFile |
str |
Required | The path of the CSV file that contains the critical current values. |
lengthUnit |
str |
Required | Unit of the critical current values. It can be either the arc length in meter or the number of turns. |
Pancake3DSolveIcVsLengthList
| Field | Type | Default | Description |
|---|---|---|---|
lengthValues |
list |
Required | Tape length values that corresponds to criticalCurrentValues. |
criticalCurrentValues |
list |
Required | Critical current values that corresponds to lengthValues. |
lengthUnit |
str |
Required | Unit of the critical current values. It can be either the arc length in meter or the number of turns. |
Pancake3DSolveShuntLayerMaterial
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveHTSShuntLayerMaterial] |
{...} (16 fields) |
Material from STEAM material library. |
Pancake3DTerminalCryocoolerLumpedMass
Module: DataFiQuSPancake3D
Fields
| Field | Type | Default | Description |
|---|---|---|---|
resistivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for resistivity. |
thermalConductivity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for thermal conductivity. |
specificHeatCapacity |
Optional[float] |
null |
A scalar value. If this is given, material properties won't be used for specific heat capacity. |
material |
Optional[Pancake3DSolveNormalMaterial] |
{...} (15 fields) |
Material from STEAM material library. |
volume |
float |
0 |
Volume of the lumped thermal mass between second stage of the cryocooler and pancake coil in m^3. A zero value effectively disables the lumped thermal mass between second stage of the cryocooler and pancake coil. |
numberOfThinShellElements |
int |
1 |
Number of thin shell elements in the FE formulation (GetDP related, not physical and only used when TSA is set to True) |
Nested Models
Pancake3DSolveNormalMaterial
| Field | Type | Default | Description |
|---|---|---|---|
name |
Literal[str] |
Required | Available inputs: "Copper", "Hastelloy", "Silver", "Indium", "Stainless Steel", "Kapton", "G10" |
RRR |
float |
100 |
Residual-resistivity ratio (also known as Residual-resistance ratio or just RRR) is the ratio of the resistivity of a material at reference temperature and at 0 K. |
RRRRefTemp |
float |
295 |
Reference temperature for residual resistance ratio |