DataMultipole

Auto-generated documentation for DataMultipole.

Classes

BaseIron
Coil
CoilOrder
Collar
Coord
Domain
Geometry
GroupEntities
GroupType
Insulation
InsulationThickness
Iron
IsothermalNodes
MidLayerLine
MultipoleData
MultipoleRegionCoordinate
NeighbourNode
PhysicalGroup
Region
SymmetryBoundaries
SymmetryGroup
ThinShell
Wedge

BaseIron

Module: DataMultipole

Fields

Field	Type	Default	Description
`quadrants`	`dict`	`{}`

Nested Models

Region

Field	Type	Default
`points`	`dict`	`{}`
`lines`	`dict`	`{}`
`areas`	`dict`	`{}`

Coil

Module: DataMultipole

Fields

Field	Type	Default
`coils`	`dict`	`{}`
`physical_order`	`list`	`[]`
`anticlockwise_order`	`CoilOrder`	`CoilOrder()`
`concentric_coils`	`dict`	`{}`
`max_radius`	`float`	`0.0`

Nested Models

AnticlockwiseOrder

Field	Type	Default
`pole`	`Optional[int]`	`null`
`winding`	`Optional[int]`	`null`
`block`	`Optional[int]`	`null`

CoilOrder

Field	Type	Default	Description
`coils`	`dict`	`{}`

LayerOrder

Field	Type	Default	Description
`layers`	`dict`	`{}`

Region

Field	Type	Default
`points`	`dict`	`{}`
`lines`	`dict`	`{}`
`areas`	`dict`	`{}`

CoilOrder

Module: DataMultipole

Fields

Field	Type	Default	Description
`coils`	`dict`	`{}`

Nested Models

AnticlockwiseOrder

Field	Type	Default
`pole`	`Optional[int]`	`null`
`winding`	`Optional[int]`	`null`
`block`	`Optional[int]`	`null`

LayerOrder

Field	Type	Default	Description
`layers`	`dict`	`{}`

Collar

Module: DataMultipole

Fields

Field	Type	Default
`quadrants`	`dict`	`{}`
`inner_boundary_tags`	`dict`	`{}`
`cooling_tags`	`list`	`[]`
`outer_boundary_tags`	`dict`	`{}`

Nested Models

Region

Field	Type	Default
`points`	`dict`	`{}`
`lines`	`dict`	`{}`
`areas`	`dict`	`{}`

Coord

Module: DataMultipole

Fields

Field	Type	Default	Description
`x`	`Optional[float]`	`null`
`y`	`Optional[float]`	`null`

Domain

Module: DataMultipole

Fields

Field	Type	Default	Description
`groups_entities`	`GroupEntities`	`GroupEntities()`
`physical_groups`	`PhysicalGroup`	`PhysicalGroup()`

Nested Models

GroupEntities

Field	Type	Default
`air`	`list`	`[]`
`iron_yoke`	`dict`	`{}`
`collar`	`dict`	`{}`
`ref_mesh`	`dict`	`{}`
`poles`	`dict`	`{}`
`symmetric_boundaries`	`SymmetryBoundaries`	`SymmetryBoundaries()`

GroupType

Field	Type	Default	Description
`curves`	`dict`	`{}`
`surfaces`	`dict`	`{}`

MidLayerLine

Field	Type	Default	Description
`inner`	`dict`	`{}`
`outer`	`dict`	`{}`

PhysicalGroup

Field	Type	Default
`blocks`	`dict`	`{}`
`wedges`	`dict`	`{}`
`insulations`	`GroupType`	`GroupType()`
`iron_yoke`	`GroupType`	`GroupType()`
`collar`	`GroupType`	`GroupType()`
`poles`	`GroupType`	`GroupType()`
`ref_mesh`	`GroupType`	`GroupType()`
`air_inf`	`Optional[int]`	`null`
`air_inf_bnd`	`Optional[int]`	`null`
`air`	`Optional[int]`	`null`
`symmetric_boundaries`	`SymmetryGroup`	`SymmetryGroup()`
`half_turns_points`	`Optional[int]`	`null`
`inner_col`	`Optional[int]`	`null`
`outer_col`	`Optional[int]`	`null`
`collar_cooling`	`Optional[int]`	`null`

PoweredBlock

Field	Type	Default
`half_turns`	`dict`	`{}`
`current_sign`	`Optional[int]`	`null`
`conductor`	`Optional[str]`	`null`

PoweredGroup

Field	Type	Default
`tag`	`Optional[int]`	`null`
`group`	`Optional[str]`	`null`
`lines`	`dict`	`{}`
`mid_layer_lines`	`MidLayerLine`	`MidLayerLine()`
`mid_pole_lines`	`dict`	`{}`
`mid_winding_lines`	`dict`	`{}`
`mid_turn_lines`	`dict`	`{}`
`aux_lines`	`dict`	`{}`
`single_node`	`Optional[int]`	`null`

SymmetryBoundaries

Field	Type	Default	Description
`x`	`list`	`[]`
`y`	`list`	`[]`

SymmetryGroup

Field	Type	Default	Description
`normal_free`	`Optional[int]`	`null`
`tangential_free`	`Optional[int]`	`null`

WedgeGroup

Field	Type	Default
`tag`	`Optional[int]`	`null`
`group`	`Optional[str]`	`null`
`lines`	`dict`	`{}`
`mid_layer_lines`	`MidLayerLine`	`MidLayerLine()`
`mid_turn_lines`	`dict`	`{}`
`aux_lines`	`dict`	`{}`

Geometry

Module: DataMultipole

Fields

Field	Type	Default
`coil`	`Coil`	`Coil()`
`wedges`	`Wedge`	`Wedge()`
`air`	`Region`	`Region()`
`air_inf`	`Region`	`Region()`
`symmetric_boundaries`	`Region`	`Region()`
`thin_shells`	`ThinShell`	`ThinShell()`
`insulation`	`Insulation`	`Insulation()`
`iron_yoke`	`Iron`	`Iron()`
`collar`	`Collar`	`Collar()`
`poles`	`BaseIron`	`BaseIron()`

Nested Models

AnticlockwiseOrder

Field	Type	Default
`pole`	`Optional[int]`	`null`
`winding`	`Optional[int]`	`null`
`block`	`Optional[int]`	`null`

BaseIron

Field	Type	Default	Description
`quadrants`	`dict`	`{}`

CoilOrder

Field	Type	Default	Description
`coils`	`dict`	`{}`

Collar

Field	Type	Default
`quadrants`	`dict`	`{}`
`inner_boundary_tags`	`dict`	`{}`
`cooling_tags`	`list`	`[]`
`outer_boundary_tags`	`dict`	`{}`

InsulationGroup

Field	Type	Default	Description
`group`	`dict`	`{}`

InsulationRegion

Field	Type	Default
`ins`	`Region`	`Region()`
`blocks`	`list`	`[]`
`wedges`	`list`	`[]`

InsulationThickness

Field	Type	Default
`mid_pole`	`dict`	`{}`
`mid_layer`	`dict`	`{}`
`mid_winding`	`dict`	`{}`
`collar`	`dict`	`{}`
`poles`	`dict`	`{}`

LayerOrder

Field	Type	Default	Description
`layers`	`dict`	`{}`

MidLayer

Field	Type	Default
`half_turn_lists`	`dict`	`{}`
`point_angles`	`dict`	`{}`
`mid_layers`	`Region`	`Region()`

Region

Field	Type	Default
`points`	`dict`	`{}`
`lines`	`dict`	`{}`
`areas`	`dict`	`{}`

ThinShell

Field	Type	Default
`mid_layers_ht_to_ht`	`dict`	`{}`
`mid_layers_wdg_to_ht`	`dict`	`{}`
`mid_layers_ht_to_wdg`	`dict`	`{}`
`mid_layers_wdg_to_wdg`	`dict`	`{}`
`mid_poles`	`dict`	`{}`
`mid_windings`	`dict`	`{}`
`mid_turn_blocks`	`dict`	`{}`
`mid_wedge_turn`	`dict`	`{}`
`mid_layers_aux`	`dict`	`{}`
`collar_layers`	`dict`	`{}`
`pole_layers`	`dict`	`{}`
`ins_thickness`	`InsulationThickness`	`InsulationThickness()`

WedgeLayer

Field	Type	Default	Description
`layers`	`dict`	`{}`

WedgeRegion

Field	Type	Default
`wedges`	`dict`	`{}`
`block_prev`	`dict`	`{}`
`block_next`	`dict`	`{}`

GroupEntities

Module: DataMultipole

Fields

Field	Type	Default
`air`	`list`	`[]`
`iron_yoke`	`dict`	`{}`
`collar`	`dict`	`{}`
`ref_mesh`	`dict`	`{}`
`poles`	`dict`	`{}`
`symmetric_boundaries`	`SymmetryBoundaries`	`SymmetryBoundaries()`

Nested Models

SymmetryBoundaries

Field	Type	Default	Description
`x`	`list`	`[]`
`y`	`list`	`[]`

GroupType

Module: DataMultipole

Fields

Field	Type	Default	Description
`curves`	`dict`	`{}`
`surfaces`	`dict`	`{}`

Insulation

Module: DataMultipole

Fields

Field	Type	Default	Description
`coils`	`dict`	`{}`

Nested Models

InsulationGroup

Field	Type	Default	Description
`group`	`dict`	`{}`

InsulationRegion

Field	Type	Default
`ins`	`Region`	`Region()`
`blocks`	`list`	`[]`
`wedges`	`list`	`[]`

Region

Field	Type	Default
`points`	`dict`	`{}`
`lines`	`dict`	`{}`
`areas`	`dict`	`{}`

InsulationThickness

Module: DataMultipole

Fields

Field	Type	Default
`mid_pole`	`dict`	`{}`
`mid_layer`	`dict`	`{}`
`mid_winding`	`dict`	`{}`
`collar`	`dict`	`{}`
`poles`	`dict`	`{}`

Iron

Module: DataMultipole

Fields

Field	Type	Default	Description
`quadrants`	`dict`	`{}`
`max_radius`	`float`	`0.0`

Nested Models

Region

Field	Type	Default
`points`	`dict`	`{}`
`lines`	`dict`	`{}`
`areas`	`dict`	`{}`

IsothermalNodes

Module: DataMultipole

Fields

Field	Type	Default
`conductors`	`dict`	`{}`
`wedges`	`dict`	`{}`
`thin_shells`	`dict`	`{}`

MidLayerLine

Module: DataMultipole

Fields

Field	Type	Default	Description
`inner`	`dict`	`{}`
`outer`	`dict`	`{}`

MultipoleData

Module: DataMultipole

Fields

Field	Type	Default	Description
`geometries`	`Geometry`	`Geometry()`
`domains`	`Domain`	`Domain()`

Nested Models

AnticlockwiseOrder

Field	Type	Default
`pole`	`Optional[int]`	`null`
`winding`	`Optional[int]`	`null`
`block`	`Optional[int]`	`null`

BaseIron

Field	Type	Default	Description
`quadrants`	`dict`	`{}`

CoilOrder

Field	Type	Default	Description
`coils`	`dict`	`{}`

Collar

Field	Type	Default
`quadrants`	`dict`	`{}`
`inner_boundary_tags`	`dict`	`{}`
`cooling_tags`	`list`	`[]`
`outer_boundary_tags`	`dict`	`{}`

Domain

Field	Type	Default	Description
`groups_entities`	`GroupEntities`	`GroupEntities()`
`physical_groups`	`PhysicalGroup`	`PhysicalGroup()`

Geometry

Field	Type	Default
`coil`	`Coil`	`Coil()`
`wedges`	`Wedge`	`Wedge()`
`air`	`Region`	`Region()`
`air_inf`	`Region`	`Region()`
`symmetric_boundaries`	`Region`	`Region()`
`thin_shells`	`ThinShell`	`ThinShell()`
`insulation`	`Insulation`	`Insulation()`
`iron_yoke`	`Iron`	`Iron()`
`collar`	`Collar`	`Collar()`
`poles`	`BaseIron`	`BaseIron()`

GroupEntities

Field	Type	Default
`air`	`list`	`[]`
`iron_yoke`	`dict`	`{}`
`collar`	`dict`	`{}`
`ref_mesh`	`dict`	`{}`
`poles`	`dict`	`{}`
`symmetric_boundaries`	`SymmetryBoundaries`	`SymmetryBoundaries()`

GroupType

Field	Type	Default	Description
`curves`	`dict`	`{}`
`surfaces`	`dict`	`{}`

InsulationGroup

Field	Type	Default	Description
`group`	`dict`	`{}`

InsulationRegion

Field	Type	Default
`ins`	`Region`	`Region()`
`blocks`	`list`	`[]`
`wedges`	`list`	`[]`

InsulationThickness

Field	Type	Default
`mid_pole`	`dict`	`{}`
`mid_layer`	`dict`	`{}`
`mid_winding`	`dict`	`{}`
`collar`	`dict`	`{}`
`poles`	`dict`	`{}`

LayerOrder

Field	Type	Default	Description
`layers`	`dict`	`{}`

MidLayer

Field	Type	Default
`half_turn_lists`	`dict`	`{}`
`point_angles`	`dict`	`{}`
`mid_layers`	`Region`	`Region()`

MidLayerLine

Field	Type	Default	Description
`inner`	`dict`	`{}`
`outer`	`dict`	`{}`

PhysicalGroup

Field	Type	Default
`blocks`	`dict`	`{}`
`wedges`	`dict`	`{}`
`insulations`	`GroupType`	`GroupType()`
`iron_yoke`	`GroupType`	`GroupType()`
`collar`	`GroupType`	`GroupType()`
`poles`	`GroupType`	`GroupType()`
`ref_mesh`	`GroupType`	`GroupType()`
`air_inf`	`Optional[int]`	`null`
`air_inf_bnd`	`Optional[int]`	`null`
`air`	`Optional[int]`	`null`
`symmetric_boundaries`	`SymmetryGroup`	`SymmetryGroup()`
`half_turns_points`	`Optional[int]`	`null`
`inner_col`	`Optional[int]`	`null`
`outer_col`	`Optional[int]`	`null`
`collar_cooling`	`Optional[int]`	`null`

PoweredBlock

Field	Type	Default
`half_turns`	`dict`	`{}`
`current_sign`	`Optional[int]`	`null`
`conductor`	`Optional[str]`	`null`

PoweredGroup

Field	Type	Default
`tag`	`Optional[int]`	`null`
`group`	`Optional[str]`	`null`
`lines`	`dict`	`{}`
`mid_layer_lines`	`MidLayerLine`	`MidLayerLine()`
`mid_pole_lines`	`dict`	`{}`
`mid_winding_lines`	`dict`	`{}`
`mid_turn_lines`	`dict`	`{}`
`aux_lines`	`dict`	`{}`
`single_node`	`Optional[int]`	`null`

Region

Field	Type	Default
`points`	`dict`	`{}`
`lines`	`dict`	`{}`
`areas`	`dict`	`{}`

SymmetryBoundaries

Field	Type	Default	Description
`x`	`list`	`[]`
`y`	`list`	`[]`

SymmetryGroup

Field	Type	Default	Description
`normal_free`	`Optional[int]`	`null`
`tangential_free`	`Optional[int]`	`null`

ThinShell

Field	Type	Default
`mid_layers_ht_to_ht`	`dict`	`{}`
`mid_layers_wdg_to_ht`	`dict`	`{}`
`mid_layers_ht_to_wdg`	`dict`	`{}`
`mid_layers_wdg_to_wdg`	`dict`	`{}`
`mid_poles`	`dict`	`{}`
`mid_windings`	`dict`	`{}`
`mid_turn_blocks`	`dict`	`{}`
`mid_wedge_turn`	`dict`	`{}`
`mid_layers_aux`	`dict`	`{}`
`collar_layers`	`dict`	`{}`
`pole_layers`	`dict`	`{}`
`ins_thickness`	`InsulationThickness`	`InsulationThickness()`

WedgeGroup

Field	Type	Default
`tag`	`Optional[int]`	`null`
`group`	`Optional[str]`	`null`
`lines`	`dict`	`{}`
`mid_layer_lines`	`MidLayerLine`	`MidLayerLine()`
`mid_turn_lines`	`dict`	`{}`
`aux_lines`	`dict`	`{}`

WedgeLayer

Field	Type	Default	Description
`layers`	`dict`	`{}`

WedgeRegion

Field	Type	Default
`wedges`	`dict`	`{}`
`block_prev`	`dict`	`{}`
`block_next`	`dict`	`{}`

MultipoleRegionCoordinate

Module: DataMultipole

Fields

Field	Type	Default
`isothermal_nodes`	`IsothermalNodes`	`IsothermalNodes()`
`neighbouring_nodes`	`NeighbourNode`	`NeighbourNode()`
`coordinates_per_half_turn`	`dict`	`{}`

Nested Models

IsothermalNodes

Field	Type	Default
`conductors`	`dict`	`{}`
`wedges`	`dict`	`{}`
`thin_shells`	`dict`	`{}`

NeighbourNode

Field	Type	Default	Description
`groups`	`dict`	`{}`

NeighbourNode

Module: DataMultipole

Fields

Field	Type	Default	Description
`groups`	`dict`	`{}`

PhysicalGroup

Module: DataMultipole

Fields

Field	Type	Default
`blocks`	`dict`	`{}`
`wedges`	`dict`	`{}`
`insulations`	`GroupType`	`GroupType()`
`iron_yoke`	`GroupType`	`GroupType()`
`collar`	`GroupType`	`GroupType()`
`poles`	`GroupType`	`GroupType()`
`ref_mesh`	`GroupType`	`GroupType()`
`air_inf`	`Optional[int]`	`null`
`air_inf_bnd`	`Optional[int]`	`null`
`air`	`Optional[int]`	`null`
`symmetric_boundaries`	`SymmetryGroup`	`SymmetryGroup()`
`half_turns_points`	`Optional[int]`	`null`
`inner_col`	`Optional[int]`	`null`
`outer_col`	`Optional[int]`	`null`
`collar_cooling`	`Optional[int]`	`null`

Nested Models

GroupType

Field	Type	Default	Description
`curves`	`dict`	`{}`
`surfaces`	`dict`	`{}`

MidLayerLine

Field	Type	Default	Description
`inner`	`dict`	`{}`
`outer`	`dict`	`{}`

PoweredBlock

Field	Type	Default
`half_turns`	`dict`	`{}`
`current_sign`	`Optional[int]`	`null`
`conductor`	`Optional[str]`	`null`

PoweredGroup

Field	Type	Default
`tag`	`Optional[int]`	`null`
`group`	`Optional[str]`	`null`
`lines`	`dict`	`{}`
`mid_layer_lines`	`MidLayerLine`	`MidLayerLine()`
`mid_pole_lines`	`dict`	`{}`
`mid_winding_lines`	`dict`	`{}`
`mid_turn_lines`	`dict`	`{}`
`aux_lines`	`dict`	`{}`
`single_node`	`Optional[int]`	`null`

SymmetryGroup

Field	Type	Default	Description
`normal_free`	`Optional[int]`	`null`
`tangential_free`	`Optional[int]`	`null`

WedgeGroup

Field	Type	Default
`tag`	`Optional[int]`	`null`
`group`	`Optional[str]`	`null`
`lines`	`dict`	`{}`
`mid_layer_lines`	`MidLayerLine`	`MidLayerLine()`
`mid_turn_lines`	`dict`	`{}`
`aux_lines`	`dict`	`{}`

Region

Module: DataMultipole

Fields

Field	Type	Default
`points`	`dict`	`{}`
`lines`	`dict`	`{}`
`areas`	`dict`	`{}`

SymmetryBoundaries

Module: DataMultipole

Fields

Field	Type	Default	Description
`x`	`list`	`[]`
`y`	`list`	`[]`

SymmetryGroup

Module: DataMultipole

Fields

Field	Type	Default	Description
`normal_free`	`Optional[int]`	`null`
`tangential_free`	`Optional[int]`	`null`

ThinShell

Module: DataMultipole

Fields

Field	Type	Default
`mid_layers_ht_to_ht`	`dict`	`{}`
`mid_layers_wdg_to_ht`	`dict`	`{}`
`mid_layers_ht_to_wdg`	`dict`	`{}`
`mid_layers_wdg_to_wdg`	`dict`	`{}`
`mid_poles`	`dict`	`{}`
`mid_windings`	`dict`	`{}`
`mid_turn_blocks`	`dict`	`{}`
`mid_wedge_turn`	`dict`	`{}`
`mid_layers_aux`	`dict`	`{}`
`collar_layers`	`dict`	`{}`
`pole_layers`	`dict`	`{}`
`ins_thickness`	`InsulationThickness`	`InsulationThickness()`

Nested Models

InsulationThickness

Field	Type	Default
`mid_pole`	`dict`	`{}`
`mid_layer`	`dict`	`{}`
`mid_winding`	`dict`	`{}`
`collar`	`dict`	`{}`
`poles`	`dict`	`{}`

MidLayer

Field	Type	Default
`half_turn_lists`	`dict`	`{}`
`point_angles`	`dict`	`{}`
`mid_layers`	`Region`	`Region()`

Region

Field	Type	Default
`points`	`dict`	`{}`
`lines`	`dict`	`{}`
`areas`	`dict`	`{}`

Wedge

Module: DataMultipole

Fields

Field	Type	Default	Description
`coils`	`dict`	`{}`

Nested Models

Region

Field	Type	Default
`points`	`dict`	`{}`
`lines`	`dict`	`{}`
`areas`	`dict`	`{}`

WedgeLayer

Field	Type	Default	Description
`layers`	`dict`	`{}`

WedgeRegion

Field	Type	Default
`wedges`	`dict`	`{}`
`block_prev`	`dict`	`{}`
`block_next`	`dict`	`{}`