Skip to content

Commit 1a1a615

Browse files
jeffrileyjeffriley
authored
Merge pull request #681 from TeamCOMPAS/OptimisticCE
Fixing "surive" typos, updating documentation
2 parents ff0e0c6 + 1eea3f8 commit 1a1a615

File tree

10 files changed

+38
-27
lines changed

10 files changed

+38
-27
lines changed

‎docs/online-docs/pages/User guide/Program options/program-options-list-defaults.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,18 @@ Default = PESSIMISTIC
100100
Circularise binary when it enters a Mass Transfer episode. |br|
101101
Default = TRUE
102102

103+
**--common-envelope-allow-immediate-RLOF-post-CE-survive** |br|
104+
Allow binaries that experience Roche lobe overflow immediately at the end of the CE phase to survive. |br|
105+
Default = FALSE
106+
103107
**--common-envelope-allow-main-sequence-survive** |br|
104108
Allow main sequence donors to survive common envelope evolution. |br|
105109
Default = TRUE
106110

111+
**--common-envelope-allow-radiative-envelope-survive** |br|
112+
Allow binaries with an evolved component with a radiative envelope to survive the common envelope phase. |br|
113+
Deafult = FALSE
114+
107115
**--common-envelope-alpha** |br|
108116
Common Envelope efficiency alpha. |br|
109117
Default = 1.0

‎examples/methods_paper_plots/chirpmass_distribution/pythonSubmit.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ class pythonProgramOptions:
173173
common_envelope_mass_accretion_min = 0.04 # For 'MACLEOD+2014' [Msol]
174174
common_envelope_mass_accretion_max = 0.10 # For 'MACLEOD+2014' [Msol]
175175
envelope_state_prescription = 'LEGACY'
176-
common_envelope_allow_radiative_envelope_surive = False
176+
common_envelope_allow_radiative_envelope_survive = False
177177
common_envelope_allow_immediate_RLOF_post_CE_survive = False
178178

179179
mass_loss_prescription = 'VINK'
@@ -358,7 +358,7 @@ def booleanChoices(self):
358358
self.pulsation_pair_instability,
359359
self.quiet,
360360
self.common_envelope_allow_main_sequence_survive,
361-
self.common_envelope_allow_radiative_envelope_surive,
361+
self.common_envelope_allow_radiative_envelope_survive,
362362
self.common_envelope_allow_immediate_RLOF_post_CE_survive,
363363
self.evolvePulsars,
364364
self.debug_to_file,
@@ -386,7 +386,7 @@ def booleanCommands(self):
386386
'--pulsational-pair-instability',
387387
'--quiet',
388388
'--common-envelope-allow-main-sequence-survive',
389-
'--common-envelope-allow-radiative-envelope-surive',
389+
'--common-envelope-allow-radiative-envelope-survive',
390390
'--common-envelope-allow-immediate-rlof-post-ce-survive',
391391
'--evolve-pulsars',
392392
'--debug-to-file',

‎examples/methods_paper_plots/detailed_evolution/pythonSubmitDemo.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ class pythonProgramOptions:
180180
common_envelope_mass_accretion_min = 0.04 # For 'MACLEOD+2014' [Msol]
181181
common_envelope_mass_accretion_max = 0.10 # For 'MACLEOD+2014' [Msol]
182182
envelope_state_prescription = 'LEGACY'
183-
common_envelope_allow_radiative_envelope_surive = False
183+
common_envelope_allow_radiative_envelope_survive = False
184184
common_envelope_allow_immediate_RLOF_post_CE_survive = False
185185

186186
mass_loss_prescription = 'VINK'
@@ -365,7 +365,7 @@ def booleanChoices(self):
365365
self.pulsation_pair_instability,
366366
self.quiet,
367367
self.common_envelope_allow_main_sequence_survive,
368-
self.common_envelope_allow_radiative_envelope_surive,
368+
self.common_envelope_allow_radiative_envelope_survive,
369369
self.common_envelope_allow_immediate_RLOF_post_CE_survive,
370370
self.evolvePulsars,
371371
self.debug_to_file,
@@ -393,7 +393,7 @@ def booleanCommands(self):
393393
'--pulsational-pair-instability',
394394
'--quiet',
395395
'--common-envelope-allow-main-sequence-survive',
396-
'--common-envelope-allow-radiative-envelope-surive',
396+
'--common-envelope-allow-radiative-envelope-survive',
397397
'--common-envelope-allow-immediate-rlof-post-ce-survive',
398398
'--evolve-pulsars',
399399
'--debug-to-file',

‎examples/methods_paper_plots/fig_5_HR_diagram/pythonSubmit.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ class pythonProgramOptions:
170170
common_envelope_mass_accretion_min = 0.04 # For 'MACLEOD+2014' [Msol]
171171
common_envelope_mass_accretion_max = 0.10 # For 'MACLEOD+2014' [Msol]
172172
envelope_state_prescription = 'LEGACY'
173-
common_envelope_allow_radiative_envelope_surive = False
173+
common_envelope_allow_radiative_envelope_survive = False
174174
common_envelope_allow_immediate_RLOF_post_CE_survive = False
175175

176176
mass_loss_prescription = 'VINK'
@@ -354,7 +354,7 @@ def booleanChoices(self):
354354
self.pulsation_pair_instability,
355355
self.quiet,
356356
self.common_envelope_allow_main_sequence_survive,
357-
self.common_envelope_allow_radiative_envelope_surive,
357+
self.common_envelope_allow_radiative_envelope_survive,
358358
self.common_envelope_allow_immediate_RLOF_post_CE_survive,
359359
self.evolvePulsars,
360360
self.debug_to_file,
@@ -382,7 +382,7 @@ def booleanCommands(self):
382382
'--pulsational-pair-instability',
383383
'--quiet',
384384
'--common-envelope-allow-main-sequence-survive',
385-
'--common-envelope-allow-radiative-envelope-surive',
385+
'--common-envelope-allow-radiative-envelope-survive',
386386
'--common-envelope-allow-immediate-rlof-post-ce-survive',
387387
'--evolve-pulsars',
388388
'--debug-to-file',

‎examples/methods_paper_plots/fig_6_max_R/pythonSubmit.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ class pythonProgramOptions:
170170
common_envelope_mass_accretion_min = 0.04 # For 'MACLEOD+2014' [Msol]
171171
common_envelope_mass_accretion_max = 0.10 # For 'MACLEOD+2014' [Msol]
172172
envelope_state_prescription = 'LEGACY'
173-
common_envelope_allow_radiative_envelope_surive = False
173+
common_envelope_allow_radiative_envelope_survive = False
174174
common_envelope_allow_immediate_RLOF_post_CE_survive = False
175175

176176
mass_loss_prescription = 'VINK'
@@ -354,7 +354,7 @@ def booleanChoices(self):
354354
self.pulsation_pair_instability,
355355
self.quiet,
356356
self.common_envelope_allow_main_sequence_survive,
357-
self.common_envelope_allow_radiative_envelope_surive,
357+
self.common_envelope_allow_radiative_envelope_survive,
358358
self.common_envelope_allow_immediate_RLOF_post_CE_survive,
359359
self.evolvePulsars,
360360
self.debug_to_file,
@@ -382,7 +382,7 @@ def booleanCommands(self):
382382
'--pulsational-pair-instability',
383383
'--quiet',
384384
'--common-envelope-allow-main-sequence-survive',
385-
'--common-envelope-allow-radiative-envelope-surive',
385+
'--common-envelope-allow-radiative-envelope-survive',
386386
'--common-envelope-allow-immediate-rlof-post-ce-survive',
387387
'--evolve-pulsars',
388388
'--debug-to-file',

‎examples/methods_paper_plots/fig_8_initial_core_final_mass_relations/pythonSubmitDefaults.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ class pythonProgramOptions:
170170
common_envelope_mass_accretion_min = 0.04 # For 'MACLEOD+2014' [Msol]
171171
common_envelope_mass_accretion_max = 0.10 # For 'MACLEOD+2014' [Msol]
172172
envelope_state_prescription = 'LEGACY'
173-
common_envelope_allow_radiative_envelope_surive = False
173+
common_envelope_allow_radiative_envelope_survive = False
174174
common_envelope_allow_immediate_RLOF_post_CE_survive = False
175175

176176
mass_loss_prescription = 'VINK'
@@ -354,7 +354,7 @@ def booleanChoices(self):
354354
self.pulsation_pair_instability,
355355
self.quiet,
356356
self.common_envelope_allow_main_sequence_survive,
357-
self.common_envelope_allow_radiative_envelope_surive,
357+
self.common_envelope_allow_radiative_envelope_survive,
358358
self.common_envelope_allow_immediate_RLOF_post_CE_survive,
359359
self.evolvePulsars,
360360
self.debug_to_file,
@@ -382,7 +382,7 @@ def booleanCommands(self):
382382
'--pulsational-pair-instability',
383383
'--quiet',
384384
'--common-envelope-allow-main-sequence-survive',
385-
'--common-envelope-allow-radiative-envelope-surive',
385+
'--common-envelope-allow-radiative-envelope-survive',
386386
'--common-envelope-allow-immediate-rlof-post-ce-survive',
387387
'--evolve-pulsars',
388388
'--debug-to-file',

‎examples/methods_paper_plots/fig_8_initial_core_final_mass_relations/pythonSubmitFryerRapid.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ class pythonProgramOptions:
170170
common_envelope_mass_accretion_min = 0.04 # For 'MACLEOD+2014' [Msol]
171171
common_envelope_mass_accretion_max = 0.10 # For 'MACLEOD+2014' [Msol]
172172
envelope_state_prescription = 'LEGACY'
173-
common_envelope_allow_radiative_envelope_surive = False
173+
common_envelope_allow_radiative_envelope_survive = False
174174
common_envelope_allow_immediate_RLOF_post_CE_survive = False
175175

176176
mass_loss_prescription = 'VINK'
@@ -354,7 +354,7 @@ def booleanChoices(self):
354354
self.pulsation_pair_instability,
355355
self.quiet,
356356
self.common_envelope_allow_main_sequence_survive,
357-
self.common_envelope_allow_radiative_envelope_surive,
357+
self.common_envelope_allow_radiative_envelope_survive,
358358
self.common_envelope_allow_immediate_RLOF_post_CE_survive,
359359
self.evolvePulsars,
360360
self.debug_to_file,
@@ -382,7 +382,7 @@ def booleanCommands(self):
382382
'--pulsational-pair-instability',
383383
'--quiet',
384384
'--common-envelope-allow-main-sequence-survive',
385-
'--common-envelope-allow-radiative-envelope-surive',
385+
'--common-envelope-allow-radiative-envelope-survive',
386386
'--common-envelope-allow-immediate-rlof-post-ce-survive',
387387
'--evolve-pulsars',
388388
'--debug-to-file',

‎examples/methods_paper_plots/fig_8_initial_core_final_mass_relations/pythonSubmitMandelMueller.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ class pythonProgramOptions:
170170
common_envelope_mass_accretion_min = 0.04 # For 'MACLEOD+2014' [Msol]
171171
common_envelope_mass_accretion_max = 0.10 # For 'MACLEOD+2014' [Msol]
172172
envelope_state_prescription = 'LEGACY'
173-
common_envelope_allow_radiative_envelope_surive = False
173+
common_envelope_allow_radiative_envelope_survive = False
174174
common_envelope_allow_immediate_RLOF_post_CE_survive = False
175175

176176
mass_loss_prescription = 'VINK'
@@ -354,7 +354,7 @@ def booleanChoices(self):
354354
self.pulsation_pair_instability,
355355
self.quiet,
356356
self.common_envelope_allow_main_sequence_survive,
357-
self.common_envelope_allow_radiative_envelope_surive,
357+
self.common_envelope_allow_radiative_envelope_survive,
358358
self.common_envelope_allow_immediate_RLOF_post_CE_survive,
359359
self.evolvePulsars,
360360
self.debug_to_file,
@@ -382,7 +382,7 @@ def booleanCommands(self):
382382
'--pulsational-pair-instability',
383383
'--quiet',
384384
'--common-envelope-allow-main-sequence-survive',
385-
'--common-envelope-allow-radiative-envelope-surive',
385+
'--common-envelope-allow-radiative-envelope-survive',
386386
'--common-envelope-allow-immediate-rlof-post-ce-survive',
387387
'--evolve-pulsars',
388388
'--debug-to-file',

‎preProcessing/pythonSubmit.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ class pythonProgramOptions:
173173
common_envelope_mass_accretion_min = 0.04 # For 'MACLEOD+2014' [Msol]
174174
common_envelope_mass_accretion_max = 0.10 # For 'MACLEOD+2014' [Msol]
175175
envelope_state_prescription = 'LEGACY'
176-
common_envelope_allow_radiative_envelope_surive = False
176+
common_envelope_allow_radiative_envelope_survive = False
177177
common_envelope_allow_immediate_RLOF_post_CE_survive = False
178178

179179

@@ -358,7 +358,7 @@ def booleanChoices(self):
358358
self.pulsation_pair_instability,
359359
self.quiet,
360360
self.common_envelope_allow_main_sequence_survive,
361-
self.common_envelope_allow_radiative_envelope_surive,
361+
self.common_envelope_allow_radiative_envelope_survive,
362362
self.common_envelope_allow_immediate_RLOF_post_CE_survive,
363363
self.evolvePulsars,
364364
self.debug_to_file,
@@ -387,7 +387,7 @@ def booleanCommands(self):
387387
'--pulsational-pair-instability',
388388
'--quiet',
389389
'--common-envelope-allow-main-sequence-survive',
390-
'--common-envelope-allow-radiative-envelope-surive',
390+
'--common-envelope-allow-radiative-envelope-survive',
391391
'--common-envelope-allow-immediate-rlof-post-ce-survive',
392392
'--evolve-pulsars',
393393
'--debug-to-file',

‎src/changelog.h‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -809,8 +809,8 @@
809809
// - Added additional checks for bad string -> number conversions throughout (for stoi(), stod(), etc.)
810810
// - Performance enhancement to BaseBinaryStar::CalculateTimeToCoalescence() (return early if e = 0.0)
811811
// - Fixed a few typos in comments
812-
// 02.25.01 IM - Nov 1, 2021 - Enhancements:
813-
// - Introduced common-envelope-allow-radiative-envelope-surive and common-envelope-allow-immediate-rlof-post-ce-survive options
812+
// 02.25.01 IM - Nov 1, 2021 - Enhancements:
813+
// - Introduced common-envelope-allow-radiative-envelope-survive and common-envelope-allow-immediate-rlof-post-ce-survive options
814814
// - Addresses issue # 637
815815
// 02.25.02 JR - Nov 1 , 2021 - Minor fixes:
816816
// - reinstated "_n" suffix for BSE detailed filenames (inadvertently removed in v02.25.00)
@@ -827,7 +827,10 @@
827827
// - fixed typo in Options.cpp for option --common-envelope-allow-immediate-RLOF-post-CE-survive (was typed common-envelope-allow-immediate-RLOF-post-CE_survive)
828828
// - fixed typo in Options.cpp for option --common-envelope-allow-radiative-envelope-survive (was typed common-envelope-allow-radiative-envelope-surive)
829829
// (neither of these caused problems because Boost matches only as many characters as necessary to determine the option name - would have if the names were not unique up to the typos)
830+
// 02.25.04 IM - Nov 4, 2021 - Minor fixes
831+
// - More surive->survive typo fixes in python files to address issue #660
832+
// - Documentation edits to reflect new options common-envelope-allow-radiative-envelope-survive and common-envelope-allow-immediate-rlof-post-ce-survive options
830833

831-
const std::string VERSION_STRING = "02.25.03";
834+
const std::string VERSION_STRING = "02.25.04";
832835

833836
# endif // __changelog_h__

0 commit comments

Comments
 (0)