bluemira.builders.thermal_shield
================================

.. py:module:: bluemira.builders.thermal_shield

.. autoapi-nested-parse::

   Thermal shield builders



Classes
-------

.. autoapisummary::

   bluemira.builders.thermal_shield.VVTSBuilderParams
   bluemira.builders.thermal_shield.VVTSBuilder
   bluemira.builders.thermal_shield.CryostatTSBuilderParams
   bluemira.builders.thermal_shield.CryostatTSBuilder


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

.. py:class:: VVTSBuilderParams

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

   .. autoapi-inheritance-diagram:: bluemira.builders.thermal_shield.VVTSBuilderParams
      :parts: 1
      :private-bases:


   VVTS builder parameters


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


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


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


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

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

   .. autoapi-inheritance-diagram:: bluemira.builders.thermal_shield.VVTSBuilder
      :parts: 1
      :private-bases:


   Vacuum vessel thermal shield builder


   .. py:attribute:: VVTS
      :value: 'VVTS'



   .. py:attribute:: VOID
      :value: 'VVTS voidspace'



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

      The class to hold this Builders's parameters.


   .. py:attribute:: params
      :type:  VVTSBuilderParams


   .. py:attribute:: keep_out_zone


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

      Build the vacuum vessel thermal shield component.



   .. py:method:: build_xz(koz: bluemira.geometry.wire.BluemiraWire) -> tuple[bluemira.base.components.PhysicalComponent, Ellipsis]

      Build the x-z components of the vacuum vessel thermal shield.

      :param koz: keep out zone for the thermal shield

      :returns: * The xz shape
                * The xz void



   .. py:method:: build_xy(vvts_face: bluemira.geometry.face.BluemiraFace) -> list[bluemira.base.components.PhysicalComponent]
      :staticmethod:


      Build the x-y components of the vacuum vessel thermal shield.

      :param vvts_face: xz face to build vvts



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

      Build the x-y-z components of the vacuum vessel thermal shield

      :param vvts_face: xz face to build vvts
      :param degree: Revolution degrees



.. py:class:: CryostatTSBuilderParams

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

   .. autoapi-inheritance-diagram:: bluemira.builders.thermal_shield.CryostatTSBuilderParams
      :parts: 1
      :private-bases:


   Cryostat thermal shield builder parameters


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


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


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


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


.. py:class:: CryostatTSBuilder(params: bluemira.base.parameter_frame.typed.ParameterFrameLike, build_config: bluemira.base.builder.BuildConfig, pf_keep_out_zones: list[bluemira.geometry.wire.BluemiraWire], tf_keep_out_zone: bluemira.geometry.wire.BluemiraWire)

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

   .. autoapi-inheritance-diagram:: bluemira.builders.thermal_shield.CryostatTSBuilder
      :parts: 1
      :private-bases:


   Cryostat thermal shield builder


   .. py:attribute:: CRYO_TS
      :value: 'Cryostat TS'



   .. py:attribute:: VOID
      :value: 'Cryostat voidspace'



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

      The class to hold this Builders's parameters.


   .. py:attribute:: params
      :type:  CryostatTSBuilderParams


   .. py:attribute:: pf_keep_out_zones


   .. py:attribute:: tf_keep_out_zone


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

      Build the cryostat thermal shield component.



   .. py:method:: build_xz(pf_kozs: list[bluemira.geometry.wire.BluemiraWire], tf_koz: bluemira.geometry.wire.BluemiraWire) -> tuple[bluemira.base.components.PhysicalComponent, Ellipsis]

      Build the x-z components of the thermal shield.

      :returns: * The xz shape
                * The xz void



   .. py:method:: build_xy(cts_face: bluemira.geometry.face.BluemiraFace) -> bluemira.base.components.PhysicalComponent

      Build the x-y components of the thermal shield.



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

      Build the x-y-z components of the thermal shield.