bluemira.radiation_transport.neutronics.constants
=================================================

.. py:module:: bluemira.radiation_transport.neutronics.constants

.. autoapi-nested-parse::

   constants used for the neutronics module



Attributes
----------

.. autoapisummary::

   bluemira.radiation_transport.neutronics.constants.DTOL_CM
   bluemira.radiation_transport.neutronics.constants.ALHPA_MOLAR_MASS
   bluemira.radiation_transport.neutronics.constants.DT_NEUTRON_ENERGY
   bluemira.radiation_transport.neutronics.constants.TOLERANCE_DEGREES
   bluemira.radiation_transport.neutronics.constants.DISCRETISATION_LEVEL
   bluemira.radiation_transport.neutronics.constants.FE_DPA_THRESHOLD_EV
   bluemira.radiation_transport.neutronics.constants.FE_MOLAR_MASS_G
   bluemira.radiation_transport.neutronics.constants.FE_DENSITY_G_CC


Functions
---------

.. autoapisummary::

   bluemira.radiation_transport.neutronics.constants.to_cm
   bluemira.radiation_transport.neutronics.constants.to_m
   bluemira.radiation_transport.neutronics.constants.to_cm3
   bluemira.radiation_transport.neutronics.constants.get_dpa_coefficients


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

.. py:data:: DTOL_CM

.. py:function:: to_cm(m)

   Converter for m to cm

   :param : quantity in m

   :returns: same quantity but expressed in cm


.. py:function:: to_m(cm)

   Converter for cm to m

   :param : quantity in cm

   :returns: same quantity but expressed in m


.. py:function:: to_cm3(m3)

   Converter for m3 to cm3

   :param : quantity in m3

   :returns: same quantity but expressed in cm^3


.. py:data:: ALHPA_MOLAR_MASS

.. py:data:: DT_NEUTRON_ENERGY

.. py:data:: TOLERANCE_DEGREES
   :value: 6.0


.. py:data:: DISCRETISATION_LEVEL
   :value: 10


.. py:data:: FE_DPA_THRESHOLD_EV
   :value: 40


.. py:data:: FE_MOLAR_MASS_G

.. py:data:: FE_DENSITY_G_CC

.. py:function:: get_dpa_coefficients(density_g_cc: float | numpy.typing.NDArray = FE_DENSITY_G_CC, molar_mass_g: float | numpy.typing.NDArray = FE_MOLAR_MASS_G, dpa_threshold_eV: float | numpy.typing.NDArray = FE_DPA_THRESHOLD_EV) -> tuple[float | numpy.typing.NDArray, float | numpy.typing.NDArray]

   Get the displacements per atom (DPA) coefficients.

   :param density_g_cc: density of the wall material,
                        where the damage (in DPA) would be calculated later.
   :type density_g_cc: float [g/cm^3]
   :param molar_mass_g: molar mass of the wall material,
                        where the damage (in DPA) would be calculated later.
   :type molar_mass_g: float [g/mole]
   :param dpa_threshold_eV: the average amount of energy dispersed
                            by displacing one atom in the wall material's lattice.
   :type dpa_threshold_eV: float [eV/count]

   :returns: * *atoms_per_cc* -- number density, given in cgs.
             * *displacements_per_damage_eV*
             * *To convert the number of damage into the number of displacements.*
             * *number of atoms in region = avogadro * density * volume / molecular mass*
             * *number of atoms in 1 cc   = avogadro * density          / molecular mass*
             * *dpa_per_second_of_operation = src_rate * displacements / atoms*
             * *dpa_fpy = dpa_per_second_of_operation / S_TO_YEAR*

   .. rubric:: Notes

   Uses CGS units!

   .. doi:: 10.1016/j.rinp.2019.102835
       :title: Shengli Chena, David Bernard,
               "On the calculation of atomic displacements using damage energy"
               Results in Physics 16 (2020)