bluemira.codes.plasmod.params
=============================

.. py:module:: bluemira.codes.plasmod.params

.. autoapi-nested-parse::

   Parameter definitions for Plasmod.



Classes
-------

.. autoapisummary::

   bluemira.codes.plasmod.params.PlasmodSolverParams


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

.. py:class:: PlasmodSolverParams

   Bases: :py:obj:`bluemira.codes.params.MappedParameterFrame`

   .. autoapi-inheritance-diagram:: bluemira.codes.plasmod.params.PlasmodSolverParams
      :parts: 1
      :private-bases:


   Parameters required in :class:`bluemira.codes.plasmod.api._solver.Solver`.


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

      Plasma aspect ratio [dimensionless].


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

      Toroidal field at plasma center [T].


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

      Plasma triangularity at 95% flux [dimensionless].


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

      Plasma elongation at 95% flux [dimensionless].


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

      Plasma major radius [m].


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

      Constrained plasma volume (set negative value to disable volume constraining) [m3].


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

      NBI energy [keV].


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

      Required fraction of non inductive current, if 0, dont use CD [dimensionless].


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

      Fixed auxiliary heating power required for control [MW].


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

      Divertor challenging criterion Psep * Bt / (q95 * A * R_0) [MW.T/m]


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

      Plasma edge triangularity (used only for first iteration, then
      iterated to constrain delta95) [dimensionless].


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

      Plasma edge elongation (used only for first iteration, then
      iterated to constrain kappa95) [dimensionless].


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

      Plasma current (used if i_equiltype == 2. Otherwise Ip is
      calculated and q95 is used as input) [MA].


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

      Safety factor at 95% flux surface (used if i_equiltype == 1.
      Otherwise q95 is calculated and Ip is used as input) [dimensionless].


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

      Electrons/ions temperature at pedestal (ignored if i_pedestal = 2) [keV].


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

      Poloidal beta [dimensionless].


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

      Normalised beta [dimensionless].


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

      Plasma bootstrap current fraction [dimensionless].


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

      Normalised plasma internal inductance [dimensionless].


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

      Radiation-corrected H-factor [dimensionless].


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

      Global energy confinement time [s].


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

      Plasma resistance [Ohm].


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

      DD fusion power [W].


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

      DT fusion power [W].


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

      Fusion power [W].


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

      Total radiation power [W].


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

      Total power across plasma separatrix [W].


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

      Synchrotron radiation power [W].


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

      Bremsstrahlung radiation power [W].


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

      Line radiation power [W].


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

      LH transition power [W].


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

      Ohmic heating power [W].


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

      Plasma effective charge [dimensionless].


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

      Target loop voltage (if lower than -1e-3, ignored)-> plasma loop voltage [V].


   .. py:attribute:: _mappings


   .. py:attribute:: _defaults


   .. py:property:: mappings
      :type: dict[str, bluemira.codes.utilities.ParameterMapping]


      Define mappings between these parameters and Plasmod's.


   .. py:property:: defaults
      :type: dict[str, float | enum.Enum]


      Defaults for Plasmod


   .. py:method:: from_defaults() -> bluemira.codes.params.MappedParameterFrame
      :classmethod:


      Initialise from defaults