conflux.bsg.CoulombFunctions
============================

.. py:module:: conflux.bsg.CoulombFunctions


Functions
---------

.. autoapisummary::

   conflux.bsg.CoulombFunctions.gamma_k
   conflux.bsg.CoulombFunctions.generalizedFermiFunction
   conflux.bsg.CoulombFunctions.lambda_2
   conflux.bsg.CoulombFunctions.lambda_k
   conflux.bsg.CoulombFunctions.calcQ_k
   conflux.bsg.CoulombFunctions.calcN2
   conflux.bsg.CoulombFunctions.calcNCoul2
   conflux.bsg.CoulombFunctions.calcLambda_k_scr


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

.. py:function:: gamma_k(k, Z)

.. py:function:: generalizedFermiFunction(W, Z, R, k)

   Implementation of the generalized Fermi function F_{k-1} according to Behrens et al.

   :param W: Total electron energy in units of its rest mass
   :param Z: Proton number of daughter
   :param R: nuclear radius in natural units
   :param k: absolute value of kappa



.. py:function:: lambda_2(W, Z, R)

.. py:function:: lambda_k(W, Z, R, k)

   Coulomb function $\lambda_k$ as per Behrens et al.

   :param W: Total electron energy in units of its rest mass
   :param Z: Proton number of daughter
   :param k: absolute value of kappa



.. py:function:: calcQ_k(k, Z, W, beta)

   Calculate the Q screening ratio according to Buehring (1984)

   :param k: absolute value of kappa
   :param Z: Proton number of daughter
   :param W: Total electron energy in units of its rest mass
   :param beta: screening exponent at r=0



.. py:function:: calcN2(kappa, Z, W, beta)

   Calculate the square of the normalization function according to Buehring (1984)

   :param k: absolute value of kappa
   :param Z: Proton number of daughter
   :param W: Total electron energy in units of its rest mass
   :param beta: screening exponent at r=0
   :param kappa:



.. py:function:: calcNCoul2(kappa, Z, W)

   Calculate the square of the normalization function for a simple point charge, according to Buehring (1984)

   :param kappa: absolute value of kappa
   :param Z: Proton number of daughter
   :param W: Total electron energy in units of its rest mass



.. py:function:: calcLambda_k_scr(k, Z, W, beta)

   Calculate the screening correction to the $\lambda_k$ Coulomb function

   :param k: absolute value of kappa
   :param Z: Proton number of daughter
   :param W: Total electron energy in units of its rest mass
   :param beta: Screening exponent at r=0