bluemira.codes.openmc.material
==============================

.. py:module:: bluemira.codes.openmc.material

.. autoapi-nested-parse::

   OpenMC CSG neutronics materials



Classes
-------

.. autoapisummary::

   bluemira.codes.openmc.material.CellType
   bluemira.codes.openmc.material.MaterialsLibrary


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

.. py:class:: CellType(*args, **kwds)

   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: bluemira.codes.openmc.material.CellType
      :parts: 1
      :private-bases:


   The five layers of the blanket as used in the neutronics simulation.

   Variables
   ---------
   Surface
       The surface layer of the first wall.
   First wall
       Typically made of tungsten or Eurofer
   BreedingZone
       Where tritium is bred
   Manifold
       The pipe works and supporting structure
   VacuumVessel
       The vacuum vessel keeping the plasma from mixing with outside air.
   RadiationShield
       The radiation shield surrounding the reactor, also called a bio shield.



   .. py:attribute:: BlanketSurface


   .. py:attribute:: BlanketFirstWall


   .. py:attribute:: BlanketBreedingZone


   .. py:attribute:: BlanketManifold


   .. py:attribute:: VacuumVessel


   .. py:attribute:: DivertorBulk


   .. py:attribute:: DivertorFirstWall


   .. py:attribute:: DivertorSurface


   .. py:attribute:: TFCoil


   .. py:attribute:: CSCoil


   .. py:attribute:: RadiationShield


.. py:class:: MaterialsLibrary

   A dictionary of materials according to the type of blanket used


   .. py:attribute:: inb_vv_mat
      :type:  openmc.Material


   .. py:attribute:: inb_fw_mat
      :type:  openmc.Material


   .. py:attribute:: inb_bz_mat
      :type:  openmc.Material


   .. py:attribute:: inb_mani_mat
      :type:  openmc.Material


   .. py:attribute:: divertor_mat
      :type:  openmc.Material


   .. py:attribute:: div_fw_mat
      :type:  openmc.Material


   .. py:attribute:: outb_fw_mat
      :type:  openmc.Material


   .. py:attribute:: outb_bz_mat
      :type:  openmc.Material


   .. py:attribute:: outb_mani_mat
      :type:  openmc.Material


   .. py:attribute:: outb_vv_mat
      :type:  openmc.Material


   .. py:attribute:: tf_coil_mat
      :type:  openmc.Material


   .. py:attribute:: container_mat
      :type:  openmc.Material


   .. py:attribute:: inb_sf_mat
      :type:  openmc.Material


   .. py:attribute:: outb_sf_mat
      :type:  openmc.Material


   .. py:attribute:: div_sf_mat
      :type:  openmc.Material


   .. py:attribute:: rad_shield
      :type:  openmc.Material


   .. py:method:: from_neutronics_materials(materials_lib: bluemira.radiation_transport.neutronics.materials.NeutronicsMaterials, op_cond: matproplib.conditions.OperationalConditions)
      :classmethod:


      Initialise from neutronics materials



   .. py:method:: match_material(cell_type: CellType, *, inboard: bool = False)

      Choose the appropriate blanket material for the given blanket cell type.

      :returns: The blanket material



   .. py:method:: export_to_xml(path: str | pathlib.Path = 'materials.xml')

      Exports material defintions to xml

      :returns: The xml representation



   .. py:method:: get_all_materials() -> tuple[openmc.Material]

      Get all of the materials stored in self, as a tuple.

      :returns: The tuple of all dataclass fields