bluemira.codes.openmc.params
============================

.. py:module:: bluemira.codes.openmc.params

.. autoapi-nested-parse::

   dataclasses containing parameters used to set up the openmc model.



Classes
-------

.. autoapisummary::

   bluemira.codes.openmc.params.OpenMCNeutronicsSolverParams
   bluemira.codes.openmc.params.PlasmaSourceParameters


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

.. py:class:: OpenMCNeutronicsSolverParams

   Bases: :py:obj:`bluemira.base.parameter_frame.ParameterFrame`

   .. autoapi-inheritance-diagram:: bluemira.codes.openmc.params.OpenMCNeutronicsSolverParams
      :parts: 1
      :private-bases:


   OpenMC neutronics solver workflow parameters.

   :param major_radius: Major radius of the machine
   :param profile_rho_ped: Pedestal location in normalized (minor) radius
   :param reactor_power: total reactor fusion power when operating at 100%
   :param n_profile_alpha: Electron density profile alpha exponent
   :param n_e_core: Core electron density
   :param n_e_ped: Pedestal electron density
   :param n_e_sep: Separatrix electron density
   :param T_profile_alpha: Electron temperature profile alpha exponent
   :param T_profile_beta: Electron temperature profile beta exponent
   :param T_e_core: Core electron temperature
   :param T_e_ped: Pedestal electron temperature
   :param T_e_sep: Separatrix electron temperature
   :param T_ie_ratio: Ion to electron temperature ratio (volume-averaged)
   :param n_i_fuel: Volume-averaged fuel ion density
   :param n_e: Volume-averaged electron density
   :param shaf_shift: Radial Shafranov shift


   .. py:attribute:: R_0
      :type:  bluemira.base.parameter_frame.Parameter[float]

      Pedestal location in normalized (minor) radius


   .. py:attribute:: profile_rho_ped
      :type:  bluemira.base.parameter_frame.Parameter[float]

      Reactor power


   .. py:attribute:: P_fus
      :type:  bluemira.base.parameter_frame.Parameter[float]

      Electron density profile descriptors


   .. py:attribute:: n_profile_alpha
      :type:  bluemira.base.parameter_frame.Parameter[float]


   .. py:attribute:: n_e_core
      :type:  bluemira.base.parameter_frame.Parameter[float]


   .. py:attribute:: n_e_ped
      :type:  bluemira.base.parameter_frame.Parameter[float]


   .. py:attribute:: n_e_sep
      :type:  bluemira.base.parameter_frame.Parameter[float]

      Electron temperature profile descriptors


   .. py:attribute:: T_profile_alpha
      :type:  bluemira.base.parameter_frame.Parameter[float]


   .. py:attribute:: T_profile_beta
      :type:  bluemira.base.parameter_frame.Parameter[float]


   .. py:attribute:: T_e_core
      :type:  bluemira.base.parameter_frame.Parameter[float]


   .. py:attribute:: T_e_ped
      :type:  bluemira.base.parameter_frame.Parameter[float]


   .. py:attribute:: T_e_sep
      :type:  bluemira.base.parameter_frame.Parameter[float]

      Ion to electron temperature ratio (volume-averaged).


   .. py:attribute:: T_ie_ratio
      :type:  bluemira.base.parameter_frame.Parameter[float]

      Volume-averaged fuel ion density [1/metre^3].


   .. py:attribute:: n_i_fuel
      :type:  bluemira.base.parameter_frame.Parameter[float]

      Volumed-averaged plasma electron density [1/metre^3].


   .. py:attribute:: n_e
      :type:  bluemira.base.parameter_frame.Parameter[float]

      Shafranov shift


   .. py:attribute:: shaf_shift
      :type:  bluemira.base.parameter_frame.Parameter[float]


.. py:class:: PlasmaSourceParameters

   Parameters describing the plasma source,
   i.e. where the plasma is positioned (and therefore where the power is concentrated),
   and what temperature the plasma is at.


   .. py:attribute:: rho_pedestal
      :type:  float


   .. py:attribute:: reactor_power
      :type:  float


   .. py:attribute:: electron_density_alpha
      :type:  float


   .. py:attribute:: electron_density_core
      :type:  float


   .. py:attribute:: electron_density_ped
      :type:  float


   .. py:attribute:: electron_density_sep
      :type:  float


   .. py:attribute:: electron_temperature_alpha
      :type:  float


   .. py:attribute:: electron_temperature_beta
      :type:  float


   .. py:attribute:: electron_temperature_core
      :type:  float


   .. py:attribute:: electron_temperature_ped
      :type:  float


   .. py:attribute:: electron_temperature_sep
      :type:  float

      Ion to electron temperature ratio (volume-averaged).


   .. py:attribute:: ie_temperature_ratio
      :type:  bluemira.base.parameter_frame.Parameter[float]

      Volume-averaged fuel ion density [1/metre^3].


   .. py:attribute:: va_fuel_ion_density
      :type:  bluemira.base.parameter_frame.Parameter[float]

      Volumed-averaged plasma electron density [1/metre^3].


   .. py:attribute:: va_electron_density
      :type:  bluemira.base.parameter_frame.Parameter[float]


   .. py:attribute:: _unit
      :type:  ClassVar[collections.abc.Mapping[str, str]]


   .. py:attribute:: _mapping
      :type:  ClassVar[collections.abc.Mapping[str, str]]


   .. py:method:: from_parameterframe(params: bluemira.base.parameter_frame.ParameterFrame)
      :classmethod:


      Create an object of this class (PlasmaSourceParameters) from a ParameterFrame
      (specifically, an object of the class OpenMCNeutronicsSolverParams), with the
      appropriate units.

      :returns: A PlasmaSourceParameters dataclass.
      :rtype: self