bluemira.codes.openmc.sources
=============================

.. py:module:: bluemira.codes.openmc.sources

.. autoapi-nested-parse::

   Neutronics sources



Functions
---------

.. autoapisummary::

   bluemira.codes.openmc.sources.make_tokamak_source
   bluemira.codes.openmc.sources.make_ring_source
   bluemira.codes.openmc.sources.create_ring_source


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

.. py:function:: make_tokamak_source(eq: bluemira.equilibria.equilibrium.Equilibrium, source_parameters: bluemira.codes.openmc.params.PlasmaSourceParameters, cell_side_length: float = 0.1) -> tuple[list[openmc.Source], float, float]

   Make a tokamak neutron source using an equilibrium and PlasmaSourceParameters
   for PROCESS parabolic-pedestal profiles.

   :param eq: Equilibrium description
   :param source_parameters: PlasmaSourceParameters
   :param cell_side_length: The dimension of the squares with which to discretise the neutron source

   :returns: * *source* -- Fusion source for OpenMC
             * *source_rate* -- Absolute neutron production rate (used for tallying)
             * *source_T_rate* -- Absolute plasma T consumption rate (used for tallying)


.. py:function:: make_ring_source(source_parameters: bluemira.codes.openmc.params.PlasmaSourceParameters) -> openmc.Source

   Create the ring source


.. py:function:: create_ring_source(major_r_cm: float, shaf_shift_cm: float) -> openmc.Source

   Creating simple line ring source lying on the Z=0 plane,
   at r = major radius + shafranov shift,
   producing 14.1 MeV neutrons with no variation in energy.
   A more accurate source will slightly affect the wall loadings and dpa profiles.

   :param major_r_cm: major radius [cm]
   :param shaf_shift_cm: shafranov shift [cm]