vice.elements.yields.agb
========================

Type : ``str`` [case-insensitive] or <function>

.. versionadded:: 1.2.0
	Prior to version 1.2.0, individual functions and objects required
	an attribute or keyword argument ``agb_model``. With version 1.2.0,
	this was changed to a global yield setting like the supernova
	yields.

The current yield setting for asymptotic giant branch stars. If this
is a string, it will be interpreted as a keyword denoting the built-in
table from a nucleosynthesis study to adopt. If this is a <function>,
it must accept stellar mass in :math:`M_\odot` as the first parameter
and the metallicity by mass :math:`Z` as the second.

	Keywords and their Associated Studies:

		- "cristallo11" : Cristallo et al. (2011) [1]_
		- "karakas10" : Karakas (2010) [2]_
		- "ventura13" : Ventura et al. (2013, 2014, 2018, 2020) [3]_
			[4]_ [5]_ [6]_
		- "karakas16" : Karakas & Lugaro (2016) [7]_, Karakas et al.
			(2018) [8]_

	.. versionadded:: 1.3.0
		The "ventura13" and "karakas16" yield models were introduced
		in version 1.3.0.

Internal yield tables can be analyzed by calling vice.yields.agb.grid.

.. note:: Modifying yield settings here is equivalent to modifying
	vice.yields.agb.settings.

.. seealso:: vice.yields.agb.settings
	vice.yields.agb.grid

Example Code
------------
>>> import vice
>>> vice.elements.C.yields.agb = "cristallo11"
>>> vice.elements.N.yields.agb = "cristallo11"
>>> vice.elements.Ne.yields.agb = "ventura13"
>>> vice.elements.Mg.yields.agb = "karakas16"
>>> vice.elements.O.yields.agb = "karakas10"
>>> def my_n_yield(m, z):
	return 9.0e-4 * m * (z / 0.014)
>>> vice.elements.N.yields.agb = my_n_yield

.. [1] Cristallo et al. (2011), ApJS, 197, 17
.. [2] Karakas (2010), MNRAS, 403, 1413
.. [3] Ventura et al. (2013), MNRAS, 431, 3642
.. [4] Ventura et al. (2014), MNRAS, 437, 3274
.. [5] Ventura et al. (2018), MNRAS, 475, 2282
.. [6] Ventura et al. (2020), A&A, 641, A103
.. [7] Karakas & Lugaro (2016), ApJ, 825, 26
.. [8] Karakas et al. (2018), MNRAS, 477, 421