Skip to content

Commit e47dcad

Browse files
jeffrileyjeffriley
authored
Merge pull request #1438 from TeamCOMPAS/minor-repairs
Minor repairs
2 parents fdff67f + 64cb1d7 commit e47dcad

File tree

5 files changed

+27
-20
lines changed

5 files changed

+27
-20
lines changed

‎compas_python_utils/preprocessing/compasConfigDefault.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
##~!!~## COMPAS option values
2-
##~!!~## File Created Mon Oct 27 09:51:18 2025 by COMPAS v03.26.02
2+
##~!!~## File Created Mon Oct 27 18:34:22 2025 by COMPAS v03.27.01
33
##~!!~##
44
##~!!~## The default COMPAS YAML file (``compasConfigDefault.yaml``), as distributed, has
55
##~!!~## all COMPAS option entries commented so that the COMPAS default value for the
@@ -57,7 +57,7 @@ booleanChoices:
5757
# --allow-non-stripped-ECSN: False # Default: False
5858
# --pair-instability-supernovae: True # Default: True
5959
# --pulsational-pair-instability: True # Default: True
60-
# --USSN-kicks-override-Mandel-Muller: False # Default: False
60+
# --USSN-kicks-override-mandel-muller: False # Default: False
6161

6262
### PULSAR PARAMETERS
6363
# --evolve-pulsars: False # Default: False

‎src/Options.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1029,7 +1029,7 @@ bool Options::AddOptions(OptionValues *p_Options, po::options_description *p_Opt
10291029
("Enable mass transfer (default = " + std::string(p_Options->m_UseMassTransfer ? "TRUE" : "FALSE") + ")").c_str()
10301030
)
10311031
(
1032-
"USSN-kicks-override-Mandel-Muller",
1032+
"USSN-kicks-override-mandel-muller",
10331033
po::value<bool>(&p_Options->m_USSNKicksOverrideMandelMuller)->default_value(p_Options->m_USSNKicksOverrideMandelMuller)->implicit_value(true),
10341034
("Whether to use user-defined USSN kicks (as a fixed value) in lieu of the Mandel & Muller kick prescription for USSNe (default = " + std::string(p_Options->m_USSNKicksOverrideMandelMuller ? "TRUE" : "FALSE") + ")").c_str()
10351035
)
@@ -5130,7 +5130,7 @@ COMPAS_VARIABLE Options::OptionValue(const T_ANY_PROPERTY p_Property) const {
51305130
case PROGRAM_OPTION::STELLAR_ZETA_PRESCRIPTION : value = static_cast<int>(StellarZetaPrescription()); break;
51315131

51325132
case PROGRAM_OPTION::TIDES_PRESCRIPTION : value = static_cast<int>(TidesPrescription()); break;
5133-
case PROGRAM_OPTION::USSN_KICKS_OVERRIDE_MANDEL_MULLER : value = static_cast<int>(USSNKicksOverrideMandelMuller()); break;
5133+
case PROGRAM_OPTION::USSN_KICKS_OVERRIDE_MANDEL_MULLER : value = USSNKicksOverrideMandelMuller(); break;
51345134

51355135
case PROGRAM_OPTION::WR_FACTOR : value = WolfRayetFactor(); break;
51365136

‎src/Options.h‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -224,14 +224,15 @@ class Options {
224224
// deprecation date. Datestring format is yyyymmdd (e.g.20251107 indicates November 07, 2025).
225225

226226
std::vector<std::tuple<std::string, std::string, bool, std::string>> deprecatedOptionStrings = {
227-
{ "retain-core-mass-during-caseA-mass-transfer", "", false, "20250116" },
228-
{ "minimum-secondary-mass", "minimum-sampled-secondary-mass", false, "20250808" },
229-
{ "initial-mass-max", "initial-mass-function-max", false, "20250808" },
230-
{ "initial-mass-min", "initial-mass-function-min", false, "20250808" },
231-
{ "initial-mass-power", "initial-mass-function-power", false, "20250808" },
232-
{ "use-mass-loss", "mass-loss-prescription", false, "20250809" },
233-
{ "mass-transfer-jloss-macleod-linear-fraction-degen", "mass-transfer-jloss-linear-fraction-degen", false, "20250819" },
234-
{ "mass-transfer-jloss-macleod-linear-fraction-non-degen", "mass-transfer-jloss-linear-fraction-non-degen", false, "20250819" },
227+
{ "retain-core-mass-during-caseA-mass-transfer", "", false, "20250116" },
228+
{ "minimum-secondary-mass", "minimum-sampled-secondary-mass", false, "20250808" },
229+
{ "initial-mass-max", "initial-mass-function-max", false, "20250808" },
230+
{ "initial-mass-min", "initial-mass-function-min", false, "20250808" },
231+
{ "initial-mass-power", "initial-mass-function-power", false, "20250808" },
232+
{ "use-mass-loss", "mass-loss-prescription", false, "20250809" },
233+
{ "mass-transfer-jloss-macleod-linear-fraction-degen", "mass-transfer-jloss-linear-fraction-degen", false, "20250819" },
234+
{ "mass-transfer-jloss-macleod-linear-fraction-non-degen", "mass-transfer-jloss-linear-fraction-non-degen", false, "20250819" },
235+
{ "scale-CHE-mass-loss-with-surface-helium-abundance", "scale-mass-loss-with-surface-helium-abundance", false, "20251027" },
235236
};
236237

237238
std::vector<std::tuple<std::string, std::string, std::string, bool, std::string>> deprecatedOptionValues = {
@@ -241,15 +242,15 @@ class Options {
241242
{ "pulsar-birth-spin-period-distribution", "ZERO", "NOSPIN", false, "20250303" },
242243
{ "tides-prescription", "KAPIL2024", "KAPIL2025", false, "20250525" },
243244
{ "mass-loss-prescription", "MERRITT2024", "MERRITT2025", false, "20250717" },
244-
{ "main-sequence-core-mass-prescription", "ZERO", "HURLEY", false, "20251024" },
245245
{ "use-mass-loss", "TRUE", "MERRITT2025", true, "20250809" },
246246
{ "use-mass-loss", "ON", "MERRITT2025", true, "20250809" },
247247
{ "use-mass-loss", "YES", "MERRITT2025", true, "20250809" },
248248
{ "use-mass-loss", "1", "MERRITT2025", true, "20250809" },
249249
{ "use-mass-loss", "FALSE", "ZERO", true, "20250809" },
250250
{ "use-mass-loss", "OFF", "ZERO", true, "20250809" },
251251
{ "use-mass-loss", "NO", "ZERO", true, "20250809" },
252-
{ "use-mass-loss", "0", "ZERO", true, "20250809" }
252+
{ "use-mass-loss", "0", "ZERO", true, "20250809" },
253+
{ "main-sequence-core-mass-prescription", "ZERO", "HURLEY", false, "20251024" }
253254
};
254255

255256
// the following vector is used to replace deprecated options in the logfile-definitions file
@@ -553,7 +554,6 @@ class Options {
553554
"rocket-kick-theta-1",
554555
"rocket-kick-theta-2",
555556

556-
"scale-CHE-mass-loss-with-surface-helium-abundance",
557557
"semi-major-axis", "a",
558558
"semi-major-axis-distribution",
559559
"semi-major-axis-max",
@@ -695,7 +695,7 @@ class Options {
695695
"rlof-printing",
696696
"rotational-velocity-distribution",
697697

698-
"scale-CHE-mass-loss-with-surface-helium-abundance",
698+
"scale-mass-loss-with-surface-helium-abundance",
699699
"semi-major-axis-distribution",
700700
"stellar-zeta-prescription",
701701
"store-input-files",
@@ -1738,7 +1738,7 @@ class Options {
17381738
double RotationalFrequency2() const { return OPT_VALUE("rotational-frequency-2", m_RotationalFrequency2, true); }
17391739
RSG_MASS_LOSS_PRESCRIPTION RSGMassLossPrescription() const { return OPT_VALUE("RSG-mass-loss-prescription", m_RSGMassLossPrescription.type, true); }
17401740

1741-
bool ScaleMassLossWithSurfaceHeliumAbundance() const { return OPT_VALUE("scale-mass-loss-with-surface-helium-abundance", m_ScaleMassLossWithSurfaceHeliumAbundance, false); }
1741+
bool ScaleMassLossWithSurfaceHeliumAbundance() const { return OPT_VALUE("scale-mass-loss-with-surface-helium-abundance", m_ScaleMassLossWithSurfaceHeliumAbundance, true); }
17421742
double ScaleTerminalWindVelocityWithMetallicityPower() const { return OPT_VALUE("scale-terminal-wind-velocity-with-metallicity-power", m_ScaleTerminalWindVelocityWithMetallicityPower, true);}
17431743
double SemiMajorAxis() const { return OPT_VALUE("semi-major-axis", m_SemiMajorAxis, true); }
17441744
SEMI_MAJOR_AXIS_DISTRIBUTION SemiMajorAxisDistribution() const { return OPT_VALUE("semi-major-axis-distribution", m_SemiMajorAxisDistribution.type, true); }
@@ -1774,7 +1774,7 @@ class Options {
17741774
bool UseMassTransfer() const { return OPT_VALUE("use-mass-transfer", m_UseMassTransfer, true); }
17751775
bool UsePairInstabilitySupernovae() const { return OPT_VALUE("pair-instability-supernovae", m_UsePairInstabilitySupernovae, true); }
17761776
bool UsePulsationalPairInstability() const { return OPT_VALUE("pulsational-pair-instability", m_UsePulsationalPairInstability, true); }
1777-
bool USSNKicksOverrideMandelMuller() const { return OPT_VALUE("USSN-kicks-override-Mandel-Muller", m_USSNKicksOverrideMandelMuller, true); }
1777+
bool USSNKicksOverrideMandelMuller() const { return OPT_VALUE("USSN-kicks-override-mandel-muller", m_USSNKicksOverrideMandelMuller, true); }
17781778

17791779
VMS_MASS_LOSS_PRESCRIPTION VMSMassLossPrescription() const { return OPT_VALUE("VMS-mass-loss-prescription", m_VMSMassLossPrescription.type, true); }
17801780
double WolfRayetFactor() const { return OPT_VALUE("wolf-rayet-multiplier", m_WolfRayetFactor, true); }

‎src/changelog.h‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1673,6 +1673,13 @@
16731673
// - Added option --USSN-kicks-override-mandel-muller ; if set to true, use user-defined USSN kicks (as a fixed value) in lieu of the Mandel & Muller kick prescription for USSNe
16741674
// - Replaced --scale-CHE-mass-loss-with-surface-helium-abundance with the more general --scale-mass-loss-with-surface-helium-abundance (applies to all MS stars, not just CHE stars)
16751675
// - Updated rotational velocity solver to use boost root finder
1676+
// 03.27.01 JR - October 27, 2025 - Defect repairs:
1677+
// - changed Options::OptionValue() to return correct value for option --USSN-kicks-override-mandel-muller
1678+
// - deprecated --scale-CHE-mass-loss-with-surface-helium-abundance in favour of --scale-mass-loss-with-surface-helium-abundance
1679+
// - removed option --scale-CHE-mass-loss-with-surface-helium-abundance from "BSEonly" vector in Options.h
1680+
// - changed "scale-CHE-mass-loss-with-surface-helium-abundance" to "--scale-mass-loss-with-surface-helium-abundance" in "RangeExcluded" vector in Options.h
1681+
// - version should have been "v03.27.00" instead of "v03.26.02" - change included new functionality. This version is "v03.27.01" to compensate.
1682+
//
16761683
//
16771684
// Version string format is MM.mm.rr, where
16781685
//
@@ -1683,7 +1690,7 @@
16831690
// if MM is incremented, set mm and rr to 00, even if defect repairs and minor enhancements were also made
16841691
// if mm is incremented, set rr to 00, even if defect repairs were also made
16851692

1686-
const std::string VERSION_STRING = "03.26.02";
1693+
const std::string VERSION_STRING = "03.27.01";
16871694

16881695

16891696
# endif // __changelog_h__

‎src/yaml.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ namespace yaml {
123123
" --allow-non-stripped-ECSN",
124124
" --pair-instability-supernovae",
125125
" --pulsational-pair-instability",
126-
" --USSN-kicks-override-Mandel-Muller",
126+
" --USSN-kicks-override-mandel-muller",
127127
"",
128128
" ### PULSAR PARAMETERS",
129129
" --evolve-pulsars",

0 commit comments

Comments
 (0)