bluemira.radiation_transport.midplane_temperature_density
=========================================================

.. py:module:: bluemira.radiation_transport.midplane_temperature_density

.. autoapi-nested-parse::

   1-D radiation model inspired by the PROCESS function "plot_radprofile" in plot_proc.py.



Classes
-------

.. autoapisummary::

   bluemira.radiation_transport.midplane_temperature_density.MidplaneProfilesParams
   bluemira.radiation_transport.midplane_temperature_density.MidplaneProfiles


Functions
---------

.. autoapisummary::

   bluemira.radiation_transport.midplane_temperature_density.midplane_profiles
   bluemira.radiation_transport.midplane_temperature_density.collect_rho_core_values
   bluemira.radiation_transport.midplane_temperature_density.core_electron_density_temperature_profile


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

.. py:class:: MidplaneProfilesParams

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

   .. autoapi-inheritance-diagram:: bluemira.radiation_transport.midplane_temperature_density.MidplaneProfilesParams
      :parts: 1
      :private-bases:


   Midplane profiles parameters


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

      Density profile factor


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

      Temperature profile index


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

      Electron density on axis


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

      Electron density pedestal height


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

      Electron density at separatrix


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

      Density pedestal r/a location


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

      Temperature pedestal r/a location


   .. py:attribute:: n_points_core_95
      :type:  bluemira.base.parameter_frame.Parameter[int]

      rho discretisation to 95% of core


   .. py:attribute:: n_points_core_99
      :type:  bluemira.base.parameter_frame.Parameter[int]

      rho discretisation to 99% of core


   .. py:attribute:: n_points_mantle
      :type:  bluemira.base.parameter_frame.Parameter[int]

      rho discretisation to separatrix


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

      Temperature profile index beta


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

      Electron temperature on axis


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

      Electron temperature pedestal height


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

      Electron temperature at separatrix


.. py:class:: MidplaneProfiles

   midplane profiles


   .. py:attribute:: psi_n
      :type:  numpy.typing.NDArray[numpy.float64]

      squared dimensionless core radius


   .. py:attribute:: ne
      :type:  numpy.typing.NDArray[numpy.float64]

      electron densities at the mid-plane. Unit [1/m^3]


   .. py:attribute:: te
      :type:  numpy.typing.NDArray[numpy.float64]

      electron temperature at the mid-plane. Unit [keV]


.. py:function:: midplane_profiles(params: bluemira.base.parameter_frame.typed.ParameterFrameLike) -> MidplaneProfiles

   Calculate the core radiation source profiles.

   Temperature and density are assumed to be constant along a
   single flux tube.

   :returns: Electron density and electron temperature as function of rho, from the magnetic
             axis to the separatrix along the midplane.


.. py:function:: collect_rho_core_values(rho_ped: numpy.ndarray, n_points_core_95: int, n_points_core_99: int, n_points_mantle: int) -> numpy.ndarray

   Calculation of core dimensionless radial coordinate rho (between 0 and 1).

   :param rho_ped: dimensionless pedestal radius. Values between 0 and 1
   :param n_points_core_95: no of discretisation points to 95% of core
   :param n_points_core_99: no of discretisation points to 99% of core
   :param n_points_mantle: no of discretisation points to separatrix

   :returns: radial coordinate rho [dimensionless].

   .. rubric:: Notes

   The plasma bulk is divided into plasma core and plasma mantle according to rho
   rho is a nondimensional radial coordinate: rho = r/a (r varies from 0 to a)


.. py:function:: core_electron_density_temperature_profile(params: MidplaneProfilesParams, rho_core: numpy.ndarray, rho_ped: numpy.ndarray) -> MidplaneProfiles

   Calculation of electron density and electron temperature,
   as function of rho, from the magnetic axis to the separatrix,
   along the midplane.

   :param params: midplane parameters
   :param rho_core: dimensionless core radius. Values between 0 and 1
   :param rho_ped: dimensionless pedestal radius. Values between 0 and 1

   :returns: electron density and electron temperature, stored as a MidplaneProfiles object.

   .. rubric:: Notes

   The region that extends through the plasma core until its
   outer layer is referred as core.
   The region that extends from the pedestal to the separatrix
   is referred as pedestal.