bluemira.builders.plasma
========================

.. py:module:: bluemira.builders.plasma

.. autoapi-nested-parse::

   Plasma builder.



Classes
-------

.. autoapisummary::

   bluemira.builders.plasma.Plasma
   bluemira.builders.plasma.PlasmaBuilderParams
   bluemira.builders.plasma.PlasmaBuilder


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

.. py:class:: Plasma(component: bluemira.base.components.ComponentT)

   Bases: :py:obj:`bluemira.base.reactor.ComponentManager`

   .. autoapi-inheritance-diagram:: bluemira.builders.plasma.Plasma
      :parts: 1
      :private-bases:


   Wrapper around a plasma component tree.


   .. py:method:: cad_construction_type() -> bluemira.base.tools.CADConstructionType
      :staticmethod:


      The CAD construction type for the plasma is to revolve the XZ face.

      :returns: The CAD construction



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

      :returns: A wire representing the last-closed flux surface.



.. py:class:: PlasmaBuilderParams

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

   .. autoapi-inheritance-diagram:: bluemira.builders.plasma.PlasmaBuilderParams
      :parts: 1
      :private-bases:


   Plasma builder parameters


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


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

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

   .. autoapi-inheritance-diagram:: bluemira.builders.plasma.PlasmaBuilder
      :parts: 1
      :private-bases:


   Builder for a poloidally symmetric plasma.


   .. py:attribute:: LCFS
      :value: 'LCFS'



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

      The class to hold this Builders's parameters.


   .. py:attribute:: params
      :type:  PlasmaBuilderParams


   .. py:attribute:: xz_lcfs


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

      Build the plasma component.



   .. py:method:: build_xz(lcfs: bluemira.geometry.wire.BluemiraWire) -> bluemira.base.components.PhysicalComponent

      Build the x-z components of the plasma.

      :param lcfs: LCFS wire



   .. py:method:: build_xy(lcfs: bluemira.geometry.wire.BluemiraWire) -> bluemira.base.components.PhysicalComponent

      Build the x-y components of the plasma.

      :param lcfs: LCFS wire



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

      Build the x-y-z components of the plasma.

      :param lcfs: LCFS wire
      :param degree: degrees to sweep the shape