bluemira.builders.cryostat
==========================

.. py:module:: bluemira.builders.cryostat

.. autoapi-nested-parse::

   Cryostat builder



Classes
-------

.. autoapisummary::

   bluemira.builders.cryostat.CryostatDesignerParams
   bluemira.builders.cryostat.CryostatBuilderParams
   bluemira.builders.cryostat.CryostatDesigner
   bluemira.builders.cryostat.CryostatBuilder


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

.. py:class:: CryostatDesignerParams

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

   .. autoapi-inheritance-diagram:: bluemira.builders.cryostat.CryostatDesignerParams
      :parts: 1
      :private-bases:


   Cryostat designer parameters


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

      Gap between Cyrostat and Cryostat thermal shield [m]


.. py:class:: CryostatBuilderParams

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

   .. autoapi-inheritance-diagram:: bluemira.builders.cryostat.CryostatBuilderParams
      :parts: 1
      :private-bases:


   Cryostat builder parameters


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

      Gap between Cyrostat and Cryostat thermal shield [m]


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

      Number of TF coils


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

      Cryostat VV thickness [m], usual value = 5


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

      cryostat well depth [m]


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

      x_g_support [m]


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

      Lower port kink radius offset from the gravity support radius [m],
      usual value = 2


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

      Gravity support vertical position at the ground [m], usual value = 15.


.. py:class:: CryostatDesigner(params: bluemira.base.parameter_frame.typed.ParameterFrameLike, cryo_ts_xz: bluemira.geometry.face.BluemiraFace)

   Bases: :py:obj:`bluemira.base.designer.Designer`\ [\ :py:obj:`tuple`\ [\ :py:obj:`float`\ , :py:obj:`float`\ ]\ ]

   .. autoapi-inheritance-diagram:: bluemira.builders.cryostat.CryostatDesigner
      :parts: 1
      :private-bases:


   Designer for the cryostat


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

      The ParameterFrame class defining this designer's parameters.


   .. py:attribute:: cryo_ts_xz


   .. py:method:: run() -> tuple[float, float]

      Cryostat designer run method

      :returns: * the maximum x of the bounding box including thicknesses
                * the maximum z of the bounding box including thicknesses



.. py:class:: CryostatBuilder(params: bluemira.base.parameter_frame.typed.ParameterFrameLike, build_config: bluemira.base.builder.BuildConfig, x_out: float, z_top: float)

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

   .. autoapi-inheritance-diagram:: bluemira.builders.cryostat.CryostatBuilder
      :parts: 1
      :private-bases:


   Builder for the cryostat


   .. py:attribute:: params
      :type:  CryostatBuilderParams


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

      The class to hold this Builders's parameters.


   .. py:attribute:: CRYO
      :value: 'Cryostat VV'



   .. py:attribute:: BODY
      :value: 'Body'



   .. py:attribute:: x_out


   .. py:attribute:: z_top


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

      Build the cryostat component.



   .. py:method:: build_xz(x_out: float, z_top: float) -> bluemira.base.components.PhysicalComponent

      Build the x-z components of the cryostat.

      :param x_out: x coordinate extremity
      :param z_top: z coordinate extremity

      :raises ValueError: Only internal kink supported

      .. rubric:: Notes

      Only designed for an inward kink, outward kinks will fail



   .. py:method:: build_xy(x_out: float) -> bluemira.base.components.PhysicalComponent

      Build the x-y components of the cryostat.

      :param x_out: x coordinate extremity



   .. py:method:: build_xyz(xz_cross_section: bluemira.geometry.face.BluemiraFace, degree=360) -> list[bluemira.base.components.PhysicalComponent]

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

      :param xz_cross_section: xz cross section of cryostat
      :param degree: Revolution degree