Skip to content
Snippets Groups Projects
Select Git revision
  • development_0.9.5/2.2.2_post_merge_david_branch
  • dhendriks/versions/0.9.5/2.2.2_post_merge
  • feature/MC_sampling
  • push_test
  • development_0.9.5/2.2.2
  • fix/new_mac_fix
  • development_0.9.3/2.2.1_pre-merge
  • dhendriks/versions/0.9.3/2.2.1_pre_merge
  • master default protected
  • development_0.9.4/2.2.1
  • development_0.9.5/2.2.1
  • development_0.9.3/2.2.1
  • papers/JOSS_release
  • feature/binary_c_ensemble_manager_implementation
  • feature/HPC
  • development_0.9.2/2.2.1
  • development_0.9.2/2.2.0
  • auto_resolution
  • feature/generate_docs_script
  • feature/custom_system_generator_endpoint
  • 0.9.1
  • v2.2.0
  • archive/queue_solution
  • archive/capsules
  • archive/gitlab_pages
  • 0.3.1
  • 0.3
  • archive/population
  • archive/david_branch
  • archive/black_formatting
  • 2.1.6
  • archive/help_function
  • 0.21
  • 0.2
  • archive/restructure_module
  • 2.1.5
  • archive/readthedocs
  • archive/better_makefile
  • archive/src_location
  • 2.1.4
40 results
Blame Permalink
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
binary_c_parameters.rst 128.70 KiB

Binary_c parameters

The following chapter contains all the parameters that the current version of binary_c can handle, along with their descriptions and other properties.

This information was obtained by the following binary_c build:
binary_c git branch: branch_david binary_c git revision: 5542:20210311:f3401ead4 Built on: Mar 22 2021 12:07:51

Section: stars

Parameter: metallicity
Description: This sets the metallicity of the stars, i.e. the amount (by mass) of matter which is not hydrogen or helium. If you are using the BSE algorithm, this must be 1e-4 <= metallicity <= 0.03. See also nucsyn_metallicity and effective_metallicity.
Parameter input type: Float
Default value: 0.02
Parameter: effective_metallicity
Description: This sets effective metallicity of stars as used in routines like the Schneider wind loss. If not set, or set to DEFAULT_TO_METALLICITY (==-1, the default), this is just the same as metallicity. The main difference between effective_metallicity and metallicity is the range of validity: 0 <= effective_metallicity <= 1, while metallicity's range of validity is limited by the stellar evolution algorithm (so, for BSE, is 1e-4 <= metallicity <= 0.03).
Parameter input type: Float
Default value: -1
Macros: ['DEFAULT_TO_METALLICITY = -1']
Parameter: M_1
Description: The initial mass of star one (in solar units, internally this is star index 0).
Parameter input type: Float
Default value: 0
Parameter: M_2
Description: The initial mass of star two (in solar units, internally this is star index 1).
Parameter input type: Float
Default value: 0
Parameter: M_3
Description: The initial mass of star three (in solar units, internally this is star index 2).
Parameter input type: Float
Default value: 0
Parameter: M_4
Description: The initial mass of star four (in solar units, internally this is star index 3).
Parameter input type: Float
Default value: 0
Parameter: vrot1
Description: Equatorial rotational speed of star 1 (km/s). If 0.0, the Hurley et al 2000/2002 prescription is used to set the main-sequence velocity, so for a truly non-rotating star, set to something small (e.g. 0.001). Requires MANUAL_VROT. See also vrot2.
Parameter input type: Float
Default value: 0
Macros: ['VROT_BSE = 0', 'VROT_NON_ROTATING = 1e-10', 'VROT_BREAKUP = -1', 'VROT_SYNC = -2', 'binary_c help for variable : vrot1 <Float>', 'Equatorial rotational speed of star 1 (km/s). If 0.0, the Hurley et al 2000/2002 prescription is used to set the main-sequence velocity, so for a truly non-rotating star, set to something small (e.g. 0.001). Requires MANUAL_VROT. See also vrot2.', 'Default : 0']
Parameter: vrot2
Description: Equatorial rotational speed of star 2 (km/s). If 0.0, the Hurley et al 2000/2002 prescription is used to set the main-sequence velocity, so for a truly non-rotating star, set to something small (e.g. 0.001). Requires MANUAL_VROT. See also vrot1.
Parameter input type: Float
Default value: 0
Macros: ['VROT_BSE = 0', 'VROT_NON_ROTATING = 1e-10', 'VROT_BREAKUP = -1', 'VROT_SYNC = -2', 'binary_c help for variable : vrot2 <Float>', 'Equatorial rotational speed of star 2 (km/s). If 0.0, the Hurley et al 2000/2002 prescription is used to set the main-sequence velocity, so for a truly non-rotating star, set to something small (e.g. 0.001). Requires MANUAL_VROT. See also vrot1.', 'Default : 0']
Parameter: vrot3
Description: The initial equatorial rotational velocity of star three (in km/s, internally this is star index 2). If 0.0, the Hurley et al 2000/2002 prescription is used to set the main-sequence velocity, so for a truly non-rotating star, set to something small (e.g. 0.001). Requires MANUAL_VROT. See also vrot1,2,4.
Parameter input type: Float
Default value: 0
Parameter: vrot4
Description: The initial equatorial rotational velocity of star four (in km/s, internally this is star index 3). If 0.0, the Hurley et al 2000/2002 prescription is used to set the main-sequence velocity, so for a truly non-rotating star, set to something small (e.g. 0.001). Requires MANUAL_VROT. See also vrot1,2,3.
Parameter input type: Float
Default value: 0
Parameter: inclination1
Description: The initial inclination of star one (in degrees).
Parameter input type: Float
Default value: 0
Parameter: inclination2
Description: The initial inclination of star two (in degrees).
Parameter input type: Float
Default value: 0
Parameter: inclination3
Description: The initial inclination of star three (in degrees).
Parameter input type: Float
Default value: 0
Parameter: inclination4
Description: The initial inclination of star four (in degrees).
Parameter input type: Float
Default value: 0
Parameter: B_1
Description: The initial magnetic field of star one (in Gauss, internally this is star index 0).
Parameter input type: Float
Default value: 0
Parameter: B_2
Description: The initial magnetic field of star two (in Gauss, internally this is star index 1).
Parameter input type: Float
Default value: 0
Parameter: B_3
Description: The initial magnetic field of star three (in Gauss, internally this is star index 2).
Parameter input type: Float
Default value: 0
Parameter: B_4
Description: The initial magnetic field of star four (in Gauss, internally this is star index 3).
Parameter input type: Float
Default value: 0
Parameter: B_inclination1
Description: The initial inclination of the magnetic field of star one (in degrees).
Parameter input type: Float
Default value: 0
Parameter: B_inclination2
Description: The initial inclination of the magnetic field of star two (in degrees).
Parameter input type: Float
Default value: 0
Parameter: B_inclination3
Description: The initial inclination of the magnetic field of star three (in degrees).
Parameter input type: Float
Default value: 0
Parameter: B_inclination4
Description: The initial inclination of the magnetic field of star four (in degrees).
Parameter input type: Float
Default value: 0
Parameter: stellar_type_1
Description: Set the stellar type of star 1 (internal index 0), usually MAIN_SEQUENCE (main sequence). Note that setting the stellar type only works for stars with both age=0 and core_mass=0, i.e. main sequence (hydrogen or helium), white dwarfs, black holes and neutrn stars.
Parameter input type: Integer
Default value: 0
Macros: ['LOW_MASS_MAIN_SEQUENCE = 0', 'LOW_MASS_MS = 0', 'MAIN_SEQUENCE = 1', 'MS = 1', 'HG = 2', 'HERTZSPRUNG_GAP = 2', 'GIANT_BRANCH = 3', 'FIRST_GIANT_BRANCH = 3', 'CHeB = 4', 'CORE_HELIUM_BURNING = 4', 'EAGB = 5', 'EARLY_ASYMPTOTIC_GIANT_BRANCH = 5', 'TPAGB = 6', 'THERMALLY_PULSING_ASYMPTOTIC_GIANT_BRANCH = 6', 'HeMS = 7', 'NAKED_MAIN_SEQUENCE_HELIUM_STAR = 7', 'HeHG = 8', 'NAKED_HELIUM_STAR_HERTZSPRUNG_GAP = 8', 'HeGB = 9', 'NAKED_HELIUM_STAR_GIANT_BRANCH = 9', 'HeWD = 10', 'HELIUM_WHITE_DWARF = 10', 'COWD = 11', 'CARBON_OXYGEN_WHITE_DWARF = 11', 'ONeWD = 12', 'OXYGEN_NEON_WHITE_DWARF = 12', 'NS = 13', 'NEUTRON_STAR = 13', 'BH = 14', 'BLACK_HOLE = 14', 'MASSLESS_REMNANT = 15']
Parameter: stellar_type_2
Description: Set the stellar type of star 2 (internal index 1), usually MAIN_SEQUENCE (main sequence). Note that setting the stellar type only works for stars with both age=0 and core_mass=0, i.e. main sequence (hydrogen or helium), white dwarfs, black holes and neutrn stars.
Parameter input type: Integer
Default value: 0
Macros: ['LOW_MASS_MAIN_SEQUENCE = 0', 'LOW_MASS_MS = 0', 'MAIN_SEQUENCE = 1', 'MS = 1', 'HG = 2', 'HERTZSPRUNG_GAP = 2', 'GIANT_BRANCH = 3', 'FIRST_GIANT_BRANCH = 3', 'CHeB = 4', 'CORE_HELIUM_BURNING = 4', 'EAGB = 5', 'EARLY_ASYMPTOTIC_GIANT_BRANCH = 5', 'TPAGB = 6', 'THERMALLY_PULSING_ASYMPTOTIC_GIANT_BRANCH = 6', 'HeMS = 7', 'NAKED_MAIN_SEQUENCE_HELIUM_STAR = 7', 'HeHG = 8', 'NAKED_HELIUM_STAR_HERTZSPRUNG_GAP = 8', 'HeGB = 9', 'NAKED_HELIUM_STAR_GIANT_BRANCH = 9', 'HeWD = 10', 'HELIUM_WHITE_DWARF = 10', 'COWD = 11', 'CARBON_OXYGEN_WHITE_DWARF = 11', 'ONeWD = 12', 'OXYGEN_NEON_WHITE_DWARF = 12', 'NS = 13', 'NEUTRON_STAR = 13', 'BH = 14', 'BLACK_HOLE = 14', 'MASSLESS_REMNANT = 15']
Parameter: stellar_type_3
Description: Set the stellar type of star 3 (internal index 2), usually MAIN_SEQUENCE (main sequence). Note that setting the stellar type only works for stars with both age=0 and core_mass=0, i.e. main sequence (hydrogen or helium), white dwarfs, black holes and neutrn stars.
Parameter input type: Integer
Default value: 0
Parameter: stellar_type_4
Description: Set the stellar type of star 4 (internal index 3), usually MAIN_SEQUENCE (main sequence). Note that setting the stellar type only works for stars with both age=0 and core_mass=0, i.e. main sequence (hydrogen or helium), white dwarfs, black holes and neutrn stars.
Parameter input type: Integer
Default value: 0
Parameter: probability
Description: The probability is a weighting applied to the star based on, say, the initial mass function. When running a grid of stars to simulate all stars, the summed probability of all the stars should be 1.0.
Parameter input type: Float
Default value: 1
Parameter: phasevol
Description: The system's phase volume, used by binary_grid.
Parameter input type: Float
Default value: NULL
Parameter: stellar_structure_algorithm
Description: Set the stellar structure algorithm. 0=modified BSE (default), 1=none, 2=external function (must be defined by the calling code), 3=binary_c (not yet implemented).
Parameter input type: Integer
Default value: 0
Macros: ['STELLAR_STRUCTURE_ALGORITHM_MODIFIED_BSE = 0', 'STELLAR_STRUCTURE_ALGORITHM_NONE = 1', 'STELLAR_STRUCTURE_ALGORITHM_EXTERNAL_FUNCTION = 2', 'STELLAR_STRUCTURE_ALGORITHM_MINT = 3']
Parameter: solver
Description: The type of solver. Default is the Forward-Euler (0), but could be RK2 (1), RK4 (2) or a predictor-corretor (3).
Parameter input type: Integer
Default value: 0
Macros: ['SOLVER_FORWARD_EULER = 0', 'SOLVER_RK2 = 1', 'SOLVER_RK4 = 2', 'SOLVER_PREDICTOR_CORRECTOR = 3']
Parameter: max_evolution_time
Description: Set the maximum age for the stars (Myr).
Parameter input type: Float
Default value: 15000
Parameter: max_model_number
Description: Set the maximum number of models, ignored if 0 (default is 0).
Parameter input type: Integer
Default value: 0
Parameter: monte_carlo_kicks
Description: Turn on Monte-Carlo SN kicks. On (True) by default, and indeed other algorithms are probably broken.
Parameter input type: True|False
Default value: True
Parameter: timestep_logging
Description: Turn on timestep logging (default is False).
Parameter input type: True|False
Default value: False
Parameter: vandenHeuvel_logging
Description: Turn on van den Heuvel logging (default is False).
Parameter input type: True|False
Default value: False
Parameter: evolution_splitting
Description: If True, turn on splitting of an evolutionary run if splitpoint (e.g. supernova) occurs.
Parameter input type: True|False
Default value: False
Parameter: disable_events
Description: Whether to disable the new events code (defaults to False, so we use events by default)
Parameter input type: True|False
Default value: False
Parameter: evolution_splitting_sn_n
Description: Number of runs to split into when a SN occurs.
Parameter input type: Integer
Default value: 10
Parameter: evolution_splitting_maxdepth
Description: Max number of splits in an evolutionary run.
Parameter input type: Integer
Default value: 2
Parameter: equation_of_state_algorithm
Description: Set the equation of state algorithm. 0 = Paczynski.
Parameter input type: Integer
Default value: NULL
Macros: ['EQUATION_OF_STATE_PACZYNSKI = 0']
Parameter: opacity_algorithm
Description: Set the opacity algorithm. 0 = Paczynski, 1 = Ferguson/Opal.
Parameter input type: Integer
Default value: NULL
Macros: ['OPACITY_ALGORITHM_PACZYNSKI = 0', 'OPACITY_ALGORITHM_FERGUSON_OPAL = 1', 'OPACITY_ALGORITHM_STARS = 2']
Parameter: wind_mass_loss
Description: Defines the algorithm used for stellar winds. 0 = none, 1 = Hurley et al. (2002), 2 = Schneider (2018).
Parameter input type: Unsigned integer
Default value: 3
Macros: ['WIND_ALGORITHM_NONE = 0', 'WIND_ALGORITHM_HURLEY2002 = 1', 'WIND_ALGORITHM_SCHNEIDER2018 = 2', 'WIND_ALGORITHM_BINARY_C_2020 = 3']
Extra: 0
Parameter: gbwind
Description: Wind prescription for first red giant branch stars. 0=Reimers (Hurley et al 2000/2002; choose gb_reimers_eta=0.5 for their mass loss rate), 1=Schroeder+Cuntz 2005 (set gb_reimers_eta=1.0 for their mass loss rate).
Parameter input type: Integer
Default value: 0
Macros: ['GB_WIND_REIMERS = 0', 'GB_WIND_SCHROEDER_CUNTZ_2005 = 1', 'GB_WIND_GOLDMAN_ETAL_2017 = 2', 'GB_WIND_BEASOR_ETAL_2020 = 3']
Parameter: mattsson_Orich_tpagbwind
Description: Experimental: turns on Mattsson's TPAGB wind when the star is oxygen rich. Requires MATTSSON_MASS_LOSS.
Parameter input type: Integer
Default value: NULL
Parameter: magnetic_braking_factor
Description: Multiplier for the magnetic braking angular momentum loss rate.
Parameter input type: Float
Default value: 1
Parameter: magnetic_braking_gamma
Description: gamma factor in Rappaport style magnetic braking expression.
Parameter input type: Float
Default value: 3
Parameter: magnetic_braking_algorithm
Description: Algorithm for the magnetic braking angular momentum loss rate. 0 = Hurley et al. 2002, 1 = Andronov, Pinnsonneault and Sills 2003, 2 = Barnes and Kim 2010
Parameter input type: Integer
Default value: 0
Macros: ['MAGNETIC_BRAKING_ALGORITHM_HURLEY_2002 = 0', 'MAGNETIC_BRAKING_ALGORITHM_ANDRONOV_2003 = 1', 'MAGNETIC_BRAKING_ALGORITHM_BARNES_2010 = 2', 'MAGNETIC_BRAKING_ALGORITHM_RAPPAPORT_1983 = 3']
Parameter: helium_flash_mass_loss
Description: Mass to be lost at the helium flash.
Parameter input type: Float
Default value: 0
Parameter: gb_reimers_eta
Description: First red giant branch wind multiplication factor, cf. eta in Reimers' mass loss formula. (This multiplies the 4e-13 in Reimers' formula, or the 8e-14 in Schroeder and Cuntz.)
Parameter input type: Float
Default value: 0.4
Parameter: gbwindfac
Description: Multiplier for the giant branch wind mass loss rate
Parameter input type: Float
Default value: 1
Parameter: tpagbwindfac
Description: Multiplier for the TPAGB wind mass loss rate
Parameter input type: Float
Default value: 1
Parameter: eagbwindfac
Description: Multiplier for the EAGB wind mass loss rate
Parameter input type: Float
Default value: 1
Parameter: nieuwenhuijzen_windfac
Description: Multiplier for the Nieuwenhuijzen & de Jager wind mass loss rate
Parameter input type: Float
Default value: 1
Parameter: tpagbwind
Description: Wind prescription during the TPAGB. 0=Karakas 2002 (a modified Vassiliadis and Wood 1993), 1=Hurley et al 2000/2002 (Vassiliadis and Wood 1993), 2=Reimers, 3=Bloecker, 4=Van Loon, 5=Rob's C-wind (broken?), 6,7=Vassiliadis and Wood 1993 (Karakas,Hurley variants respectively) when C/O>1, 8=Mattsson, 9 = Goldman et al. (2017), 10 = Beasor et al. (2020).
Parameter input type: Integer
Default value: 0
Macros: ['TPAGB_WIND_BLOECKER = 3', 'TPAGB_WIND_VW93_KARAKAS = 0', 'TPAGB_WIND_VW93_ORIG = 1', 'TPAGB_WIND_REIMERS = 2', 'TPAGB_WIND_VAN_LOON = 4', 'TPAGB_WIND_ROB_CWIND = 5', 'TPAGB_WIND_VW93_KARAKAS_CARBON_STARS = 6', 'TPAGB_WIND_VW93_ORIG_CARBON_STARS = 7', 'TPAGB_WIND_MATTSSON = 8', 'TPAGB_WIND_GOLDMAN_ETAL_2017 = 9', 'TPAGB_WIND_BEASOR_ETAL_2020 = 10']
Parameter: eagbwind
Description: Wind prescription during the EAGB. 0=BSE (Hurley+2002, based on VW93), 1 = Goldman et al. (2017), 2 = Beasor et al. (2020).
Parameter input type: Integer
Default value: 0
Macros: ['EAGB_WIND_BSE = 0', 'EAGB_WIND_GOLDMAN_ETAL_2017 = 1', 'EAGB_WIND_BEASOR_ETAL_2020 = 2']