vice.singlezone¶
An object designed to run simulations of chemical enrichment under the single-zone approximation for user-specified parameters. The parameters of the simulation are implemented as attributes of this class.
Signature: Signature: vice.singlezone(**kwargs)
Parameters¶
- kwargsvarying types
Every attribute of this class can be assigned via a keyword argument.
Attributes¶
- name
str
[default“onezonemodel”] The name of the simulation. Output will be stored in a directory under this name.
- func
<function>
[defaultvice._globals._DEFAULT_FUNC_] A function of time describing some evolutionary parameter. Physical interpretation set by the attribute
mode
.- mode
str
[default“ifr”] The interpretation of the attribute
func
. Either “ifr” for infall rate, “sfr” for star formation rate, or “gas” for the mass of gas.- verbose
bool
[defaultFalse] Whether or not to print to the console as the simulation runs.
New in version 1.1.0.
- elements
tuple
[default(“fe”, “sr”, “o”)] A tuple of strings holding the symbols of the elements to be simulated.
- IMF
str
[case-insensitive] or<function>
[default“kroupa”] The stellar initial mass function (IMF) to adopt. Either a string denoting a built-in IMF or a function containing a user-constructed IMF.
Recognized built-in IMFs:
- etareal number [default2.5]
The mass-loading parameter: the ratio of outflow to star formation rates. This changes when the attribute
smoothing
is nonzero.- enhancementreal number or
<function>
[default1] The ratio of outflow to ISM metallicities. Numbers are interpreted as constants. Functions must accept time in Gyr as a parameter.
- Zinreal number,
<function>
, ordataframe
[default0] The infall metallicity, which can be a constant, time-vary, or have element-by-element specifications.
- recycling
str
[case-insensitive] or real number [default : “continuous”] Either the string “continuous” or a real number between 0 and 1. Denotes the prescription for recycling of previously produced heavy nuclei.
- binsarray-like [default[-3.0, -2.95, -2.9, … , 0.9, 0.95, 1.0]]
The binspace within which to sort the normalized stellar metallicity distribution function in each [X/H] and [X/Y] abundance ratio measurement.
- delayreal number [default0.15]
The minimum delay time in Gyr before the onset of type Ia supernovae associated with a single stellar population
- RIa
str
[case-insensitive] or<function>
[default“plaw”] The SN Ia delay-time distribution (DTD) to adopt. Strings denote built-in DTDs and functions must accept time in Gyr as a parameter.
- Mg0real number [default6.0e+09]
The initial gas supply of the galaxy in solar masses. This is only relevant when the simulation is ran in infall mode (i.e. mode == “ifr”).
- smoothingreal number [default0]
The outflow smoothing timescale in Gyr. 3
- tau_iareal number [default1.5]
The e-folding timescale of type Ia supernovae in gyr when the attribute
RIa
== “exp”.- tau_starreal number or
<function>
[default2.0] The star formation rate per unit gas mass in the galaxy in Gyr. This can be either a number which will be treated as a constant, or a function of time in Gyr. This changes when the attribute
schmidt
== True.- dtreal number [default0.01]
The timestep size in Gyr.
- schmidt
bool
[defaultFalse] A boolean describing whether or not to implement a gas-dependent star formation efficiency.
- schmidt_indexreal number [default0.5]
The power-law index of gas-dependent star formation efficiency.
- MgSchmidtreal umber [default6.0e+09]
The normalization of the gas-supply when the attribute
schmidt
== True.- m_upperreal number [default100]
The upper mass limit on star formation in solar masses
- m_lowerreal number [default0.08]
The lower mass limit on star formation in solar masses
- postMSreal number [default0.1]
The lifetime ratio of the post main sequence to main sequence phases of stellar evolution.
New in version 1.1.0.
- Z_solarreal number [default0.014]
The adopted metallicity by mass of the sun.
- agb_model
str
[case-insensitive] [default“cristallo11”] A keyword denoting which table of nucleosynthetic yields from AGB stars to adopt.
Recognized Keywords:
Functions¶
- run[instancemethod]
Run the simulation
- from_output[classmethod]
Obtain a
singlezone
object with the parameters of the one that produced an output.
Example Code¶
>>> import vice
>>> sz = vice.singlezone()
>>> sz
vice.singlezone{
name -----------> onezonemodel
func -----------> <function _DEFAULT_FUNC_ at 0x112180ae8>
mode -----------> ifr
verbose --------> False
elements -------> ('fe', 'sr', 'o')
IMF ------------> kroupa
eta ------------> 2.5
enhancement ----> 1.0
entrainment ----> <entrainment settings>
Zin ------------> 0.0
recycling ------> continuous
delay ----------> 0.15
RIa ------------> plaw
Mg0 ------------> 6000000000.0
smoothing ------> 0.0
tau_ia ---------> 1.5
tau_star -------> 2.0
schmidt --------> False
schmidt_index --> 0.5
MgSchmidt ------> 6000000000.0
dt -------------> 0.01
m_upper --------> 100.0
m_lower --------> 0.08
postMS ---------> 0.1
Z_solar --------> 0.014
bins -----------> [-3, -2.95, -2.9, ... , 0.9, 0.95, 1]
}
- 1
Kroupa (2001), MNRAS, 231, 322
- 2
Salpeter (1955), ApJ, 121, 161
- 3
Johnson & Weinberg (2020), arxiv:1911.02598
- 4
Cristallo et al. (2011), ApJS, 197, 17
- 5
Karakas (2010), MNRAS, 403, 1413
- vice.singlezone.run
- vice.singlezone.from_output
- vice.singlezone.name
- vice.singlezone.func
- vice.singlezone.mode
- vice.singlezone.verbose
- vice.singlezone.elements
- vice.singlezone.IMF
- vice.singlezone.eta
- vice.singlezone.enhancement
- vice.singlezone.Zin
- vice.singlezone.recycling
- vice.singlezone.bins
- vice.singlezone.delay
- vice.singlezone.RIa
- vice.singlezone.Mg0
- vice.singlezone.smoothing
- vice.singlezone.tau_ia
- vice.singlezone.tau_star
- vice.singlezone.dt
- vice.singlezone.schmidt
- vice.singlezone.schmidt_index
- vice.singlezone.MgSchmidt
- vice.singlezone.m_upper
- vice.singlezone.m_lower
- vice.singlezone.postMS
- vice.singlezone.Z_solar
- vice.singlezone.agb_model