bluemira.builders.pf_coil
=========================

.. py:module:: bluemira.builders.pf_coil

.. autoapi-nested-parse::

   Builder for the PF coils



Classes
-------

.. autoapisummary::

   bluemira.builders.pf_coil.PFCoilBuilderParams
   bluemira.builders.pf_coil.PFCoilBuilder
   bluemira.builders.pf_coil.PFCoilPictureFrameParams
   bluemira.builders.pf_coil.PFCoilPictureFrame


Module Contents
---------------

.. py:class:: PFCoilBuilderParams

   Bases: :py:obj:`bluemira.base.parameter_frame.ParameterFrame`

   .. autoapi-inheritance-diagram:: bluemira.builders.pf_coil.PFCoilBuilderParams
      :parts: 1
      :private-bases:


   Parameters for the `PFCoilBuilder` class.


   .. py:attribute:: n_TF
      :type:  bluemira.base.parameter_frame.Parameter[int]


   .. py:attribute:: tk_insulation
      :type:  bluemira.base.parameter_frame.Parameter[float]


   .. py:attribute:: tk_casing
      :type:  bluemira.base.parameter_frame.Parameter[float]


   .. py:attribute:: ctype
      :type:  bluemira.base.parameter_frame.Parameter[str]


.. py:class:: PFCoilBuilder(params: bluemira.base.parameter_frame.typed.ParameterFrameLike, build_config: bluemira.base.builder.BuildConfig, xz_cross_section: bluemira.geometry.wire.BluemiraWire)

   Bases: :py:obj:`bluemira.base.builder.Builder`

   .. autoapi-inheritance-diagram:: bluemira.builders.pf_coil.PFCoilBuilder
      :parts: 1
      :private-bases:


   Builder for a single PF coil.


   .. py:attribute:: CASING
      :value: 'Casing'



   .. py:attribute:: GROUND_INSULATION
      :value: 'Ground Insulation'



   .. py:attribute:: INNER
      :value: 'Inner'



   .. py:attribute:: OUTER_INS
      :value: 'Outer Ins'



   .. py:attribute:: WINDING_PACK
      :value: 'Winding Pack'



   .. py:attribute:: param_cls
      :type:  type[PFCoilBuilderParams]

      The class to hold this Builders's parameters.


   .. py:attribute:: params
      :type:  PFCoilBuilderParams


   .. py:attribute:: xz_cross_section


   .. py:method:: build() -> bluemira.base.components.Component

      Build the PFCoil component.



   .. py:method:: 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



   .. py:method:: 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



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

      Build the xyz representation of the PF coil.

      :param shape: The xz cross-section shape of the coil.
      :param degree: The angle [°] around which to build the components, by default 360.0.

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



.. py:class:: PFCoilPictureFrameParams

   Bases: :py:obj:`bluemira.base.parameter_frame.ParameterFrame`

   .. autoapi-inheritance-diagram:: bluemira.builders.pf_coil.PFCoilPictureFrameParams
      :parts: 1
      :private-bases:


   Parameters for the `PFCoilPictureFrame` designer.


   .. py:attribute:: r_corner
      :type:  bluemira.base.parameter_frame.Parameter[float]


.. py:class:: PFCoilPictureFrame(params: bluemira.base.parameter_frame.typed.ParameterFrameLike, coil: bluemira.equilibria.coils.Coil)

   Bases: :py:obj:`bluemira.base.designer.Designer`

   .. autoapi-inheritance-diagram:: bluemira.builders.pf_coil.PFCoilPictureFrame
      :parts: 1
      :private-bases:


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


   .. py:attribute:: param_cls
      :type:  type[PFCoilPictureFrameParams]

      The ParameterFrame class defining this designer's parameters.


   .. py:attribute:: params
      :type:  PFCoilPictureFrameParams


   .. py:attribute:: coil


   .. py:method:: run() -> bluemira.geometry.wire.BluemiraWire

      Run the design step

      :returns: The PictureFrame shape as a wire.