bluemira.radiation_transport.neutronics.geometry
================================================

.. py:module:: bluemira.radiation_transport.neutronics.geometry

.. autoapi-nested-parse::

   dataclasses containing parameters used to set up the openmc model.



Classes
-------

.. autoapisummary::

   bluemira.radiation_transport.neutronics.geometry.BlanketThickness
   bluemira.radiation_transport.neutronics.geometry.DivertorThickness
   bluemira.radiation_transport.neutronics.geometry.ToroidalFieldCoilDimension
   bluemira.radiation_transport.neutronics.geometry.RadiationShieldThickness
   bluemira.radiation_transport.neutronics.geometry.TokamakDimensions


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

.. py:class:: BlanketThickness

   Give the depth of the interfaces between blanket layers.

   :param surface: Thickness of the surface layer of the blanket. Can be zero.
                   Only used for tallying purpose, i.e. not a physical component.
   :param first_wall: Thickness of the first wall.
   :param breeding_zone: Thickness of the breedng zone. Could be zero if the breeding zone is absent.

   .. note::

      Thickness of the vacuum vessel is not required because we we assume it fills up the
      remaining space between the manifold's end and the outer_boundary.


   .. py:attribute:: surface
      :type:  float


   .. py:attribute:: first_wall
      :type:  float


   .. py:attribute:: breeding_zone
      :type:  float


   .. py:attribute:: manifold
      :type:  float


   .. py:method:: get_interface_depths()

      Depth of at each interface layers = the thickness of all the layers before it.

      :returns: Depths of the interface between layers.



.. py:class:: DivertorThickness

   Divertor dimensions.
   For now it only has 1 value: the surface layer thickness.

   :param surface: The surface layer of the divertor, which we expect to be made of a different
                   material (e.g. Tungsten or alloy of Tungsten) from the bulk support & cooling
                   structures of the divertor.


   .. py:attribute:: surface
      :type:  float


.. py:class:: ToroidalFieldCoilDimension

   Gives the toroidal field coil diameters. Working with the simplest assumption, we
   assume that the tf coil is circular for now.

   :param inner_diameter: (i.e. inner diameter of the windings.)
   :param outer_diameter: Outer diameter of the windings.


   .. py:attribute:: thickness
      :type:  float


   .. py:attribute:: inner_radius
      :type:  float


.. py:class:: RadiationShieldThickness

   Radiation shield dimensions.
   For now it only has 1 value: the wall layer thickness.

   :param wall: The wall thickness of the radiation shield.


   .. py:attribute:: wall
      :type:  float


.. py:class:: TokamakDimensions

   The dimensions of the simplest axis-symmetric case of the tokamak.

   :param inboard: thicknesses of the inboard blanket
   :param outboard: thicknesses of the outboard blanket
   :param divertor: thicknesses of the divertor components
   :param cs_coil: diameters of the toroidal field coil in the


   .. py:attribute:: inboard
      :type:  BlanketThickness


   .. py:attribute:: inboard_outboard_transition_radius
      :type:  float


   .. py:attribute:: outboard
      :type:  BlanketThickness


   .. py:attribute:: divertor
      :type:  DivertorThickness


   .. py:attribute:: cs_coil
      :type:  ToroidalFieldCoilDimension


   .. py:attribute:: rad_shield
      :type:  RadiationShieldThickness


   .. py:method:: from_parameterframe(params: bluemira.radiation_transport.neutronics.neutronics_axisymmetric.NeutronicsReactorParameterFrame, r_inner_cut: float)
      :classmethod:


      Setup tokamak dimensions

      :param params: parameter frame containing all the relevant thickness parameters
      :param r_inner_cut: Major radius value beyond which it's considered the "outboard", and within
                          which it's considered the inboard part of the tokamak.

      :returns: TokamakDimensions object with the appropriate dimensions extracted from
                params.