:py:mod:`profiley.pressure`
===========================

.. py:module:: profiley.pressure


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

Classes
~~~~~~~

.. autoapisummary::

   profiley.pressure.PressureGNFW
   profiley.pressure.Arnaud10




.. py:class:: PressureGNFW(mass, P0, c, alpha, beta, gamma, z=0, pm_params=(1.45e-11 * u.erg / u.cm**3, 1000000000000000.0, 2 / 3, 8 / 3), cosmo=Planck15, **kwargs)


   Bases: :py:obj:`profiley.nfw.BaseNFW`

   Generalized NFW profile, with the parameterization commonly used
   to define pressure profiles in galaxy clusters (Nagai et al.
   2007)

   *New in version 1.2.0*

   Parameters
   ----------
   mass : float or np.ndarray
       cluster mass. If defin
   P0, c, alpha, beta, gamma : float or np.ndarray
       parameters of the dimensionless universal pressure profile, as
       defined in Eq. (11) of Arnaud et al. (2010)

   Optional parameters
   -------------------
   z : float or np.ndarray
       redshift
   normalization_name : {'M500','P500'}
       specifies to what parameter ``normalization`` corresponds
   pm_params : list-like, length=4
       the four parameters that determine the scaling relation between
       M500 and P500 (or any other overdensity). See ``P500_from_M500``
   cosmo : astropy.cosmology.FLRW
       cosmology object

   .. py:method:: upp(x)

      Dimensionless universal pressure profile

      .. math::

          p(x) = \frac{P_0}
              {(cx)^\gamma\left[1+(cx)^\alpha\right]^(\beta-\gamma)/\alpha}

      where :math:`x=r/r_{500}`


   .. py:method:: P500_from_M500(a=1.45e-11 * u.erg / u.cm**3, b=1000000000000000.0, c=2 / 3, d=8 / 3)

      Calculate P500 given M500 using a redshift-corrected power-law:

      .. math::

          P_{500} = a \left(\frac{M_{500}}{b}\right)^c\,E(z)^d

      where :math:`b` is in :math:`\mathrm{M}_\odot`. Default parameters
      correspond to those derived by Nagain et al. (2007).

      Both P500 and M500 may actually refer to any overdensity; the function
      name simply reflects the usual parameterization


   .. py:method:: profile(r)



.. py:class:: Arnaud10(mass, P0=8.403, c=1.177, alpha=1.051, beta=5.4905, gamma=0.3081, z=0, pm_params=(0.00165 * u.keV / u.cm**3, 300000000000000.0, 2 / 3 + 0.12, 8 / 3), cosmo=Planck15, **kwargs)


   Bases: :py:obj:`PressureGNFW`

   GNFW profile with the best-fit parameters from Arnaud et al.
   (2010)

   All parameters can be modified as desired, but default parameters
   correspond to equations 12 and 13 from Arnaud et al. (2010), which
   makes it convenient for modifying only one or a few parameters at a
   time