MultiDim

class cosmic.sample.sampler.multidim.MultiDim

Bases: object

Methods Summary

initial_sample([M1min, M2min, M1max, M2max, ...])	Sample initial binary distribution according to Moe & Di Stefano (2017) <http://adsabs.harvard.edu/abs/2017ApJS..230...15M>`_
sample_SFH([SF_start, SF_duration, met, size])	Sample an evolution time for each binary based on a user-specified time at the start of star formation and the duration of star formation.
set_kstar(mass)	Initialize stellar types according to BSE classification kstar=1 if M>=0.7 Msun; kstar=0 if M<0.7 Msun

Methods Documentation

initial_sample(M1min=0.08, M2min=0.08, M1max=150.0, M2max=150.0, porb_lo=0.15, porb_hi=8.0, rand_seed=0, size=None, nproc=1, pool=None, mp_seeds=None)

Sample initial binary distribution according to Moe & Di Stefano (2017) <http://adsabs.harvard.edu/abs/2017ApJS..230…15M>`_

Parameters:

M1minfloat

minimum primary mass to sample [Msun] DEFAULT: 0.08

M2minfloat

minimum secondary mass to sample [Msun] DEFAULT: 0.08

M1maxfloat

maximum primary mass to sample [Msun] DEFAULT: 150.0

M2maxfloat

maximum primary mass to sample [Msun] DEFAULT: 150.0

porb_lofloat

minimum orbital period to sample [log10(days)]

porb_hifloat

maximum orbital period to sample [log10(days)]

rand_seedint

random seed generator DEFAULT: 0

sizeint, optional

number of evolution times to sample NOTE: this is set in cosmic-pop call as Nstep

Returns:

primary_mass_listarray

array of primary masses with size=size

secondary_mass_listarray

array of secondary masses with size=size

porb_listarray

array of orbital periods in days with size=size

ecc_listarray

array of eccentricities with size=size

single_mass_listarray

array of mass of single stars

mass_singlesfloat

Total mass in single stars needed to generate population

mass_binariesfloat

Total mass in binaries needed to generate population

n_singlesint

Number of single stars needed to generate a population

n_binariesint

Number of binaries needed to generate a population

binfrac_listarray

array of binary probabilities based on primary mass and period with size=size

sample_SFH(SF_start=13700.0, SF_duration=0.0, met=0.02, size=None)

Sample an evolution time for each binary based on a user-specified time at the start of star formation and the duration of star formation. The default is a burst of star formation 13,700 Myr in the past.

Parameters:

SF_startfloat

Time in the past when star formation initiates in Myr

SF_durationfloat

Duration of constant star formation beginning from SF_Start in Myr

metfloat

metallicity of the population [Z_sun = 0.02] Default: 0.02

sizeint, optional

number of evolution times to sample NOTE: this is set in cosmic-pop call as Nstep

Returns:

tphysarray

array of evolution times of size=size

metallicityarray

array of metallicities

set_kstar(mass)

Initialize stellar types according to BSE classification kstar=1 if M>=0.7 Msun; kstar=0 if M<0.7 Msun

Parameters:

massarray

array of masses

Returns:

kstararray

array of initial stellar types