bluemira.builders.radiation_shield
==================================

.. py:module:: bluemira.builders.radiation_shield

.. autoapi-nested-parse::

   Radiation shield builder



Classes
-------

.. autoapisummary::

   bluemira.builders.radiation_shield.RadiationShieldBuilderParams
   bluemira.builders.radiation_shield.RadiationShieldBuilder


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

.. py:class:: RadiationShieldBuilderParams

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

   .. autoapi-inheritance-diagram:: bluemira.builders.radiation_shield.RadiationShieldBuilderParams
      :parts: 1
      :private-bases:


   Radiation Shield builder parameters


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


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


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


.. py:class:: RadiationShieldBuilder(params: bluemira.base.parameter_frame.typed.ParameterFrameLike, build_config: bluemira.base.builder.BuildConfig, cryo_vv: bluemira.geometry.face.BluemiraFace)

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

   .. autoapi-inheritance-diagram:: bluemira.builders.radiation_shield.RadiationShieldBuilder
      :parts: 1
      :private-bases:


   Radiation Shield builder


   .. py:attribute:: RS
      :value: 'RS'



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



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

      The class to hold this Builders's parameters.


   .. py:attribute:: params
      :type:  RadiationShieldBuilderParams


   .. py:attribute:: cryo_vv


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

      Build the radiation shield component.



   .. py:method:: build_xz() -> bluemira.base.components.PhysicalComponent

      Build the x-z components of the radiation shield.



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

      Build the x-y components of the radiation shield.



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

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