vice.yields.ccsne.engines.E16
=============================

Core collapse supernova explosion engine as calculated by Ertl et al.
(2016) [1]_ and studied in Griffith et al. (2021) [2]_.

**Signature**: from vice.yields.ccsne.engines import E16

.. versionadded:: 1.2.0

.. tip:: This object can be passed as the keyword argument ``explodability``
	to ``vice.yields.ccsne.fractional`` to calculate IMF-averaged yields
	assuming this black hole landscape.

Attributes
----------
masses : ``list``
	The stellar masses in :math:`M_\odot` on which the explosion engine is
	sampled.
m4 : ``list``
	The quantity :math:`M_4` at the time of core collapse for stars with
	ZAMS masses given by the attribute ``masses``. Values are taken from
	Sukhbold et al. (2016) [3]_. See `Notes`_.
mu4 : ``list``
	The quantity :math:`\mu_4` at the time of core collapse for stars with
	ZAMS masses given by the attribute ``masses``. Values are taken from
	Sukhbold et al. (2016). See `Notes`_.
slope : ``float`` [default : 0.283]
	The slope of the line in :math:`\mu_4-\mu_4M_4` space dividing
	progenitors which explode and collapse.
intercept : ``float`` [default : 0.043]
	The intercept of the line in :math:`\mu_4-\mu_4M_4` space dividing
	progenitors which explode and collapse.
frequencies : ``list``
	The fraction of stars at the sampled masses that explode as a core
	collapse supernova. Though this attribute has meaning for other
	``engine`` objects, here it simply returns the binary 0 or 1 describing
	whether or not each element of the attribute ``masses`` explodes under
	the current parameters.

Calling
-------
Call this object with progenitor mass as the only argument, and either 0 or
1 will be returned based on whether or not such a progenitor should explode
based on the current attributes of this object.

	Parameters:

		- mass : ``float``
			Progenitor zero age main sequence mass in :math:`M_\odot`.

	Returns:

		- explodability : ``float``
			1 if the star would produce a core collapse supernova under the
			current assumptions, and 0 if it would collapse to a black hole.

			.. note:: The base class ``engine`` will return non-binary
				values for masses between grid elements where the explosion
				frequency is 0 and 1. This derived class, however, will
				always return a binary value.

Notes
-----
The base class ``engine`` determines explodability by linearly
interpolating between elements of the grid defined by the attributes
``masses`` and ``frequencies``. This class, however, linearly interpolates
on the ``masses``-``m4`` and ``masses``-``mu4`` grids to determine
:math:`M_4` and :math:`\mu_4` at a given progenitor zero age main sequence
(ZAMS) mass. Whether or not this progenitor would explode is then
determined according to the following criterion:

.. math:: \mu_4 \leq a M_4 \mu_4 + b

where :math:`a` and :math:`b` are the attributes ``slope`` and
``intercept``. Default values of :math:`a` = 0.283 and :math:`b` = 0.043
are adopted from Ertl et al. (2016), while the ``m4`` and ``mu4`` tables
are taken from Sukhbold et al. (2016). The attribute ``frequencies`` plays
no role in this calculation.

Example Code
------------
>>> from vice.yields.ccsne.engines import E16
>>> E16.masses
[9.0,
 9.25,
 9.5,
 ...,
 80.0,
 100.0,
 120.0]
>>> E16.m4
[1.357,
 1.36955,
 1.38349,
 ...,
 1.66232,
 1.81718,
 1.60252]
>>> E16.mu4
[1.79891e-05,
 0.000933825,
 0.00210795,
 ...,
 0.0896075,
 0.103897,
 0.0759102]
>>> E16(20)
0.0
>>> E16(21)
1.0
>>> E16(22)
0.0

.. [1] Ertl et al. (2016), ApJ, 818, 124
.. [2] Griffith et al. (2021), ApJ, 921, 73
.. [3] Sukhbold et al. (2016), ApJ, 821, 38




.. toctree::
	:titlesonly:
	:maxdepth: 5

	vice.yields.ccsne.engines.E16.m4
	vice.yields.ccsne.engines.E16.mu4
	vice.yields.ccsne.engines.E16.slope
	vice.yields.ccsne.engines.E16.intercept