bluemira.builders.pf_coil

Builder for the PF coils

Classes

PFCoilBuilderParams

Parameters for the PFCoilBuilder class.

PFCoilBuilder

Builder for a single PF coil.

PFCoilPictureFrameParams

Parameters for the PFCoilPictureFrame designer.

PFCoilPictureFrame

Designer for the shape of a PF coil in the xz plane using a

Module Contents

class bluemira.builders.pf_coil.PFCoilBuilderParams

Bases: bluemira.base.parameter_frame.ParameterFrame

Inheritance diagram of bluemira.builders.pf_coil.PFCoilBuilderParams

Parameters for the PFCoilBuilder class.

n_TF: bluemira.base.parameter_frame.Parameter[int]
tk_insulation: bluemira.base.parameter_frame.Parameter[float]
tk_casing: bluemira.base.parameter_frame.Parameter[float]
ctype: bluemira.base.parameter_frame.Parameter[str]
class bluemira.builders.pf_coil.PFCoilBuilder(params: bluemira.base.parameter_frame.typed.ParameterFrameLike, build_config: bluemira.base.builder.BuildConfig, xz_cross_section: bluemira.geometry.wire.BluemiraWire)

Bases: bluemira.base.builder.Builder

Inheritance diagram of bluemira.builders.pf_coil.PFCoilBuilder

Builder for a single PF coil.

Parameters:
CASING = 'Casing'
GROUND_INSULATION = 'Ground Insulation'
INNER = 'Inner'
OUTER_INS = 'Outer Ins'
WINDING_PACK = 'Winding Pack'
param_cls: type[PFCoilBuilderParams]

The class to hold this Builders’s parameters.

params: PFCoilBuilderParams
xz_cross_section
build() → bluemira.base.components.Component

Build the PFCoil component.

Return type:

bluemira.base.components.Component

build_xy(shape: bluemira.geometry.wire.BluemiraWire) → list[bluemira.base.components.PhysicalComponent]

Build the xy cross-section of the PF coil.

Returns:

the winding pack, insulation and casing

Parameters:

shape (bluemira.geometry.wire.BluemiraWire)

Return type:

list[bluemira.base.components.PhysicalComponent]

build_xz(shape: bluemira.geometry.wire.BluemiraWire) → list[bluemira.base.components.PhysicalComponent]

Build the xz cross-section of the PF coil.

Returns:

the winding pack, insulation and casing

Parameters:

shape (bluemira.geometry.wire.BluemiraWire)

Return type:

list[bluemira.base.components.PhysicalComponent]

build_xyz(shape: bluemira.geometry.wire.BluemiraWire, degree: float = 360.0) → list[bluemira.base.components.PhysicalComponent]

Build the xyz representation of the PF coil.

Parameters:

  • shape (bluemira.geometry.wire.BluemiraWire) – The xz cross-section shape of the coil.

  • degree (float) – The angle [°] around which to build the components, by default 360.0.

Returns:

The component grouping the results in 3D (xyz).

Return type:

list[bluemira.base.components.PhysicalComponent]

class bluemira.builders.pf_coil.PFCoilPictureFrameParams

Bases: bluemira.base.parameter_frame.ParameterFrame

Inheritance diagram of bluemira.builders.pf_coil.PFCoilPictureFrameParams

Parameters for the PFCoilPictureFrame designer.

r_corner: bluemira.base.parameter_frame.Parameter[float]
class bluemira.builders.pf_coil.PFCoilPictureFrame(params: bluemira.base.parameter_frame.typed.ParameterFrameLike, coil: bluemira.equilibria.coils.Coil)

Bases: bluemira.base.designer.Designer

Inheritance diagram of bluemira.builders.pf_coil.PFCoilPictureFrame

Designer for the shape of a PF coil in the xz plane using a PictureFrame parameterisation.

Parameters:

  • params (bluemira.base.parameter_frame.typed.ParameterFrameLike)

  • coil (bluemira.equilibria.coils.Coil)

param_cls: type[PFCoilPictureFrameParams]

The ParameterFrame class defining this designer’s parameters.

params: PFCoilPictureFrameParams
coil
run() → bluemira.geometry.wire.BluemiraWire

Run the design step

Returns:

The PictureFrame shape as a wire.

Return type:

bluemira.geometry.wire.BluemiraWire