vice.singlezone.agb_model
=========================

**[DEPRECATED]**

Type : ``str`` [case-insensitive]

Default : None

.. deprecated:: 1.2.0
	Users should instead use the ``vice.yields.agb.settings``
	``dataframe`` to declare their yields. These allow the same
	keywords as this attribute as well as user-constructed functions
	of stellar mass and metallicity.

A keyword denoting which stellar mass-metallicity grid of fractional
nucleosynthetic yields from asymptotic giant branch (AGB) stars to
adopt.

Recognized Keywords:

- "cristallo11" [1]_
- "karakas10" [2]_

.. note::

	If the Karakas (2010) set of yields are adopted and any elements
	tracked by the simulation are heavier than nickel, a LookupError
	will be raised. The Karakas (2010) study did not report yields for
	elements heavier than nickel.

Example Code
------------
>>> import vice
>>> sz = vice.singlezone(name = "example", elements = ["c", "n", "o"])
>>> sz.agb_model = "karakas10"
>>> sz.agb_model = "cristallo11"

.. [1] Cristallo et al. (2011), ApJS, 197, 17
.. [2] Karakas (2010), MNRAS, 403, 1413