bluemira.radiation_transport.neutronics.blanket_data
====================================================

.. py:module:: bluemira.radiation_transport.neutronics.blanket_data

.. autoapi-nested-parse::

   Create specific materials from known blanket data.



Classes
-------

.. autoapisummary::

   bluemira.radiation_transport.neutronics.blanket_data.TokamakGeometry


Functions
---------

.. autoapisummary::

   bluemira.radiation_transport.neutronics.blanket_data.get_preset_geometry
   bluemira.radiation_transport.neutronics.blanket_data.create_materials


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

.. py:class:: TokamakGeometry

   The thickness measurements for all of the generic components of the tokamak.

   :param inb_fw_thick: inboard first wall thickness [m]
   :param inb_bz_thick: inboard breeding zone thickness [m]
   :param inb_mnfld_thick: inboard manifold thickness [m]
   :param inb_vv_thick: inboard vacuum vessel thickness [m]
   :param tf_thick: toroidal field coil thickness [m]
   :param outb_fw_thick: outboard first wall thickness [m]
   :param outb_bz_thick: outboard breeding zone thickness [m]
   :param outb_mnfld_thick: outboard manifold thickness [m]
   :param outb_vv_thick: outboard vacuum vessel thickness [m]
   :param inb_gap: inboard gap [m]


   .. py:attribute:: inb_fw_thick
      :type:  float


   .. py:attribute:: inb_bz_thick
      :type:  float


   .. py:attribute:: inb_mnfld_thick
      :type:  float


   .. py:attribute:: inb_vv_thick
      :type:  float


   .. py:attribute:: tf_thick
      :type:  float


   .. py:attribute:: outb_fw_thick
      :type:  float


   .. py:attribute:: outb_bz_thick
      :type:  float


   .. py:attribute:: outb_mnfld_thick
      :type:  float


   .. py:attribute:: outb_vv_thick
      :type:  float


   .. py:attribute:: inb_gap
      :type:  float


.. py:function:: get_preset_geometry(params: bluemira.base.parameter_frame._frame.ParameterFrame) -> TokamakGeometry

   Get the tokamak geometry.

   :returns: tokamak geometry parameters
   :rtype: tokamak_geometry

   :raises ValueError: If the thickness of the sub-layers is incompatible with the totoal
       blanket thickness.


.. py:function:: create_materials(blanket_type: bluemira.materials.neutronics.BlanketType) -> bluemira.radiation_transport.neutronics.materials.NeutronicsMaterials

   Create Materials Library by specifying just the blanket type

   :param blanket_type: the blanket type

   :returns: Set of materials used for that specific type of reactor.