vice.core.dataframe.agb_yield_settings

The VICE dataframe: derived class (inherits from yield_settings)

Stores the current nucleosynthetic yield settings for asymptotic giant branch (AGB) stars.

New in version 1.2.0.

Note

Modifying yield settings through these dataframes is equivalent to going through the vice.elements module.

Allowed Data Types

  • Keys
    • str [case-insensitive]elemental symbols

      The symbols of the elements as they appear on the periodic table.

  • Values
    • str [case-insensitive]keywords

      Denote a built-in table of net yields published in a nucleosynthesis study.

      Recognized Keywords:

      • “cristallo11” : Cristallo et al. (2011) [1]

      • “karakas10” : Karakas (2010) [2]

      • “ventura13” : Ventura et al. (2013) [3]

      • “karakas16”: Karakas & Lugaro (2016) [4]; Karakas et al. (2018) [5]

    • <function>Mathematical function describing the yield.

      Must accept the stellar mass in \(M_\odot\) and the metallicity by mass \(Z\) as parameters, in that order.

      Note

      Functions of mass and metallicity to describe these yields can significantly increase the required integration time in simulations, especially for fine timestepping.

Indexing

  • str [case-insensitive]elemental symbols

    Must be indexed by the symbol of an element recognized by VICE as it appears on the periodic table.

Functions

  • keys

  • todict

  • restore_defaults

  • factory_settings

  • save_defaults

Built-In Instances

  • vice.yields.agb.settings

    The user’s current nucleosynthetic yield settings for asymptotic giant branch stars.

Example Code

>>> import math
>>> from vice.yields.agb import settings as example
>>> example["c"] = "karakas10"
>>> def f(m, z):
        return 1e-3 * m * math.exp(-m / 2) * (z / 0.014)
>>> example["C"] = f

Signature: vice.core.dataframe.agb_yield_settings(frame, name, allow_funcs, config_field)

Warning

Users should avoid creating new instances of derived classes of the VICE dataframe and instead use the base class. Instances of this class are created automatically.

Parameters

framedict

A dictionary from which to construct the dataframe.

namestr

String denoting a description of the values stored in this dataframe.

allow_funcsbool

If True, functional attributes will be allowed.

config_fieldstr

The name of the “.config” file that is stored in VICE’s install directory whenever the user saves new default yield settings.