Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated MSP treatments. #1315

Open
wants to merge 8 commits into
base: dev
Choose a base branch
from
Open

Updated MSP treatments. #1315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4a948ae
code cleanup
yuzhesong Dec 18, 2024
0326c93
Merge branch 'dev' into MSP_NEW
yuzhesong Dec 18, 2024
557b059
update changelog.h
yuzhesong Dec 18, 2024
6d7a252
remove unnecessary files
yuzhesong Dec 18, 2024
a692e7d
further code cleanup
yuzhesong Dec 19, 2024
c938c8f
changes according to code review
yuzhesong Dec 19, 2024
a879403
Adding fix for issue #1257
yuzhesong Jan 7, 2025
cccc70d
merge from latest dev
yuzhesong Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 3 additions & 12 deletions compas_python_utils/preprocessing/compasConfigDefault.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
##~!!~## COMPAS option values
##~!!~## File Created Mon Oct 14 12:53:32 2024 by COMPAS v03.06.00
##~!!~## File Created Thu Dec 19 20:38:48 2024 by COMPAS v03.11.00
##~!!~##
##~!!~## The default COMPAS YAML file (``compasConfigDefault.yaml``), as distributed, has
##~!!~## all COMPAS option entries commented so that the COMPAS default value for the
Expand Down Expand Up @@ -41,7 +41,6 @@ booleanChoices:
# --allow-rlof-at-birth: True # Default: True # allow binaries that have one or both stars in RLOF at birth to evolve, particularly useful in the context of CHE binaries
# --circularise-binary-during-mass-transfer: True # Default: True
# --hmxr-binaries: False # Default: False
# --mass-transfer: True # Default: True
# --use-mass-transfer: True # Default: True
# --retain-core-mass-during-caseA-mass-transfer: True # Default: True

Expand Down Expand Up @@ -230,20 +229,14 @@ stringChoices:
# --timesteps-filename: '' # Default: ''

### STELLAR PROPERTIES
# --chemically-homogeneous-evolution: 'PESSIMISTIC' # Default: 'PESSIMISTIC' # Options: ['PESSIMISTIC','OPTIMISTIC','NONE'] # chemically homogeneous evolution
# --chemically-homogeneous-evolution-mode: 'PESSIMISTIC' # Default: 'PESSIMISTIC' # Options: ['PESSIMISTIC','OPTIMISTIC','NONE'] # chemically homogeneous evolution mode
# --envelope-state-prescription: 'LEGACY' # Default: 'LEGACY' # Options: ['FIXED_TEMPERATURE','HURLEY','LEGACY']
# --initial-mass-function: 'KROUPA' # Default: 'KROUPA' # Options: ['KROUPA','UNIFORM','POWERLAW','SALPETER']
# --LBV-mass-loss-prescription: 'HURLEY_ADD' # Default: 'HURLEY_ADD' # Options: ['BELCZYNSKI','HURLEY','HURLEY_ADD','ZERO','NONE']
# --luminous-blue-variable-prescription: 'HURLEY_ADD' # Default: 'HURLEY_ADD' # Options: ['BELCZYNSKI','HURLEY','HURLEY_ADD','ZERO','NONE']
# --mass-loss-prescription: 'MERRITT2024' # Default: 'MERRITT2024' # Options: ['MERRITT2024','BELCZYNSKI2010','HURLEY','ZERO','NONE']
# --OB-mass-loss: 'VINK2021' # Default: 'VINK2021' # Options: ['KRTICKA2018','BJORKLUND2022','VINK2021','VINK2001','ZERO','NONE']
# --OB-mass-loss-prescription: 'VINK2021' # Default: 'VINK2021' # Options: ['KRTICKA2018','BJORKLUND2022','VINK2021','VINK2001','ZERO','NONE']
# --RSG-mass-loss: 'DECIN2023' # Default: 'DECIN2023' # Options: ['NJ90','KEE2021','YANG2023','DECIN2023','BEASOR2020','VINKSABHAHIT2023','ZERO','NONE']
# --RSG-mass-loss-prescription: 'DECIN2023' # Default: 'DECIN2023' # Options: ['NJ90','KEE2021','YANG2023','DECIN2023','BEASOR2020','VINKSABHAHIT2023','ZERO','NONE']
# --VMS-mass-loss: 'SABHAHIT2023' # Default: 'SABHAHIT2023' # Options: ['SABHAHIT2023','BESTENLEHNER2020','VINK2011','ZERO','NONE']
# --VMS-mass-loss-prescription: 'SABHAHIT2023' # Default: 'SABHAHIT2023' # Options: ['SABHAHIT2023','BESTENLEHNER2020','VINK2011','ZERO','NONE']
# --WR-mass-loss: 'SANDERVINK2023' # Default: 'SANDERVINK2023' # Options: ['SHENAR2019','SANDERVINK2023','BELCZYNSKI2010']
# --WR-mass-loss-prescription: 'SANDERVINK2023' # Default: 'SANDERVINK2023' # Options: ['SHENAR2019','SANDERVINK2023','BELCZYNSKI2010']
# --metallicity-distribution: 'ZSOLAR' # Default: 'ZSOLAR' # Options: ['LOGUNIFORM','ZSOLAR']
# --pulsational-pair-instability-prescription: 'MARCHANT' # Default: 'MARCHANT' # Options: ['HENDRIKS','FARMER','MARCHANT','STARTRACK','COMPAS']
Expand All @@ -257,12 +250,11 @@ stringChoices:

### MASS TRANSFER
# --case-BB-stability-prescription: 'ALWAYS_STABLE' # Default: 'ALWAYS_STABLE' # Options: ['ALWAYS_UNSTABLE','TREAT_AS_OTHER_MT','ALWAYS_STABLE_ONTO_NSBH','ALWAYS_STABLE']
# --critical-mass-ratio-prescription: 'NONE' # Default: 'NONE' # Options: ['HURLEY_HJELLMING_WEBBINK','GE20_IC','GE20','CLAEYS','NONE']
# --critical-mass-ratio-prescription: 'NONE' # Default: 'NONE' # Options: ['HURLEY_HJELLMING_WEBBINK','GE','GE_IC','CLAEYS','NONE']
# --stellar-zeta-prescription: 'SOBERMAN' # Default: 'SOBERMAN' # Options: ['ARBITRARY','HURLEY','SOBERMAN']
# --mass-transfer-angular-momentum-loss-prescription: 'ISOTROPIC' # Default: 'ISOTROPIC' # Options: ['ARBITRARY','MACLEOD_LINEAR','CIRCUMBINARY','ISOTROPIC','JEANS']
# --mass-transfer-accretion-efficiency-prescription: 'THERMAL' # Default: 'THERMAL' # Options: ['FIXED','THERMAL']
# --mass-transfer-rejuvenation-prescription: 'STARTRACK' # Default: 'STARTRACK' # Options: ['STARTRACK','HURLEY']
# --mass-transfer-thermal-limit-accretor: 'CFACTOR' # Default: 'CFACTOR' # Options: ['ROCHELOBE','CFACTOR']
# --mass-transfer-thermal-limit-accretor-multiplier: 'CFACTOR' # Default: 'CFACTOR' # Options: ['ROCHELOBE','CFACTOR']

### COMMON ENVELOPE
Expand All @@ -274,12 +266,11 @@ stringChoices:
# --tides-prescription: 'NONE' # Default: 'NONE' # Options: ['KAPIL2024','PERFECT','NONE']

### SUPERNOVAE, KICKS AND REMNANTS
# --black-hole-kicks: 'FALLBACK' # Default: 'FALLBACK' # Options: ['FALLBACK','ZERO','REDUCED','FULL']
# --black-hole-kicks-mode: 'FALLBACK' # Default: 'FALLBACK' # Options: ['FALLBACK','ZERO','REDUCED','FULL']
# --fryer-supernova-engine: 'DELAYED' # Default: 'DELAYED' # Options: ['DELAYED','RAPID']
# --kick-magnitude-distribution: 'MULLERMANDEL' # Default: 'MULLERMANDEL' # Options: ['MULLERMANDEL','MULLER2016MAXWELLIAN','MULLER2016','BRAYELDRIDGE','MAXWELLIAN','FLAT','FIXED','ZERO']
# --kick-direction: 'ISOTROPIC' # Default: 'ISOTROPIC' # Options: ['POLES','WEDGE','POWERLAW','PERPENDICULAR','INPLANE','ISOTROPIC']
# --kick-direction-distribution: 'ISOTROPIC' # Default: 'ISOTROPIC' # Options: ['POLES','WEDGE','POWERLAW','PERPENDICULAR','INPLANE','ISOTROPIC']
# --neutron-star-accretion-in-ce: 'ZERO' # Default: 'ZERO' # Options: ['DISK','SURFACE','ZERO']
# --neutron-star-equation-of-state: 'SSE' # Default: 'SSE' # Options: ['ARP3','SSE']
# --neutrino-mass-loss-BH-formation: 'FIXED_MASS' # Default: 'FIXED_MASS' # Options: ['FIXED_MASS','FIXED_FRACTION']
# --pulsar-birth-magnetic-field-distribution: 'ZERO' # Default: 'ZERO' # Options: ['LOGNORMAL','UNIFORM','FLATINLOG','ZERO']
Expand Down
8 changes: 8 additions & 0 deletions online-docs/pages/User guide/Program options/program-options-list-defaults.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -968,6 +968,14 @@ Default = FIXED_MASS
Amount of mass lost in neutrinos during BH formation (either as fraction or in solar masses, depending on the value of ``--neutrino-mass-loss-bh-formation``). |br|
Default = 0.1

**--neutron-star-accretion-in-ce** |br|
Assumption about neutron star accretion in CE. |br|
ZERO indicates no accretion onto NS in CE. |br|
DISK indicates a RLOF like disk accretion onto NS at Alfven radius. |br|
SURFACE indicates mass is directly accreted onto the surface of the NS. |br|
Options: { ZERO, DISK, SURFACE } |br|
Default = ZERO

**--neutron-star-equation-of-state** |br|
Neutron star equation of state. |br|
Options: { SSE, ARP3 } |br|
Expand Down
6 changes: 6 additions & 0 deletions online-docs/pages/whats-new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ What's new

Following is a brief list of important updates to the COMPAS code. A complete record of changes can be found in the file ``changelog.h``.

**03.11.00 Dec 19, 2024**

Updated neutron star recycling/spin-up treatments.
* New command line option `--neutron-star-accretion-in-ce` to determine how a NS accretes mass in common envelope.


**03.10.00 Nov 29, 2024**

Added functionality to log stellar mergers in the BSE switchlog file.
Expand Down
2 changes: 2 additions & 0 deletions src/ErrorCatalog.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ enum class ERROR: int {
UNKNOWN_MT_REJUVENATION_PRESCRIPTION, // unknown mass transfer rejuvenation prescription
UNKNOWN_MT_THERMALLY_LIMITED_VARIATION, // unknown mass transfer thermally limited variation
UNKNOWN_NEUTRINO_MASS_LOSS_PRESCRIPTION, // unknown neutrino mass loss prescription
UNKNOWN_NS_ACCRETION_IN_CE, // unknown NS accretion in common envelope
UNKNOWN_NS_EOS, // unknown NS equation-of-state
UNKNOWN_OB_MASS_LOSS_PRESCRIPTION, // unknown OB mass loss prescription
UNKNOWN_PPI_PRESCRIPTION, // unknown pulsational pair instability prescription
Expand Down Expand Up @@ -344,6 +345,7 @@ const COMPASUnorderedMap<ERROR, std::tuple<ERROR_SCOPE, std::string>> ERROR_CATA
{ ERROR::UNKNOWN_MT_THERMALLY_LIMITED_VARIATION, { ERROR_SCOPE::ALWAYS, "Unknown mass transfer thermally limited variation" }},
{ ERROR::UNKNOWN_MASS_LOSS_PRESCRIPTION, { ERROR_SCOPE::ALWAYS, "Unknown mass loss prescription" }},
{ ERROR::UNKNOWN_NEUTRINO_MASS_LOSS_PRESCRIPTION, { ERROR_SCOPE::ALWAYS, "Unknown neutrino mass loss prescription" }},
{ ERROR::UNKNOWN_NS_ACCRETION_IN_CE, { ERROR_SCOPE::ALWAYS, "Unknown NS accretion in common envelope" }},
{ ERROR::UNKNOWN_NS_EOS, { ERROR_SCOPE::ALWAYS, "Unknown NS equation-of-state" }},
{ ERROR::UNKNOWN_OB_MASS_LOSS_PRESCRIPTION, { ERROR_SCOPE::ALWAYS, "Unknown OB mass loss prescription" }},
{ ERROR::UNKNOWN_PPI_PRESCRIPTION, { ERROR_SCOPE::ALWAYS, "Unknown pulsational pair instability prescription" }},
Expand Down
3 changes: 3 additions & 0 deletions src/LogTypedefs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -860,6 +860,7 @@ enum class PROGRAM_OPTION: int {

NOTES,

NS_ACCRETION_IN_CE,
NS_EOS,

ORBITAL_PERIOD,
Expand Down Expand Up @@ -1081,6 +1082,7 @@ const COMPASUnorderedMap<PROGRAM_OPTION, std::string> PROGRAM_OPTION_LABEL = {

{ PROGRAM_OPTION::NOTES, "NOTES" },

{ PROGRAM_OPTION::NS_ACCRETION_IN_CE, "NS_ACCRETION_IN_CE" },
{ PROGRAM_OPTION::NS_EOS, "NS_EOS" },

{ PROGRAM_OPTION::ORBITAL_PERIOD, "ORBITAL_PERIOD" },
Expand Down Expand Up @@ -1623,6 +1625,7 @@ const std::map<PROGRAM_OPTION, PROPERTY_DETAILS> PROGRAM_OPTION_DETAIL = {
{ PROGRAM_OPTION::NEUTRINO_MASS_LOSS_ASSUMPTION_BH, { TYPENAME::INT, "PO_Neutrino_Mass_Loss_Assmptn", "-", 4, 1 }},
{ PROGRAM_OPTION::NEUTRINO_MASS_LOSS_VALUE_BH, { TYPENAME::DOUBLE, "PO_Neutrino_Mass_Loss_Value", "-", 24, 15}},

{ PROGRAM_OPTION::NS_ACCRETION_IN_CE, { TYPENAME::INT, "PO_NS_ACCRETION_IN_CE", "-", 4, 1 }},
{ PROGRAM_OPTION::NS_EOS, { TYPENAME::INT, "PO_NS_EOS", "-", 4, 1 }},

{ PROGRAM_OPTION::ORBITAL_PERIOD, { TYPENAME::DOUBLE, "PO_Orbital_Period", "days", 24, 15}},
Expand Down
Loading
Loading