vice.elements.yields.agb

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

New in version 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 \(M_\odot\) as the first parameter and the metallicity by mass \(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.
    1. [8]

New in version 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.

See also

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