Removed older --enable-tides and --enable-realistic-tides options to …

…avoid confusion
TeamCOMPAS · Apr 10, 2024 · d4b8be6 · d4b8be6
1 parent 31f2833
commit d4b8be6
Show file tree

Hide file tree

Showing 8 changed files with 1 addition and 40 deletions.
diff --git a/compas_python_utils/preprocessing/compasConfigDefault.yaml b/compas_python_utils/preprocessing/compasConfigDefault.yaml
@@ -47,10 +47,6 @@ booleanChoices:
 #    --common-envelope-lambda-nanjing-use-rejuvenated-mass: False          # Default: False
 #    --revised-energy-formalism-nandez-ivanova: False                      # Default: False
 
-    ### TIDES
-#    --enable-tides: False                                                 # Default: False
-#    --enable-realistic-tides: False                                       # Default: False
-
     ### SUPERNOVAE, KICKS AND REMNANTS
 #    --allow-non-stripped-ECSN: False                                      # Default: False
 #    --pair-instability-supernovae: True                                   # Default: True

diff --git a/examples/methods_paper_plots/detailed_evolution/example_bbh_compas_config.yaml b/examples/methods_paper_plots/detailed_evolution/example_bbh_compas_config.yaml
@@ -47,9 +47,6 @@ booleanChoices:
 #    --common-envelope-lambda-nanjing-use-rejuvenated-mass: False          # Default: False
 #    --revised-energy-formalism-nandez-ivanova: False                      # Default: False
 
-    ### TIDES
-#    --enable-tides: False                                                 # Default: False
-
     ### SUPERNOVAE, KICKS AND REMNANTS
 #    --allow-non-stripped-ECSN: False                                      # Default: False
 #    --pair-instability-supernovae: True                                   # Default: True

diff --git a/online-docs/pages/User guide/Program options/program-options-list-defaults.rst b/online-docs/pages/User guide/Program options/program-options-list-defaults.rst
@@ -349,14 +349,6 @@ Default = 0.0
 Multiplication factor for Eddington accretion for NS & BH (i.e. > 1 is super-eddington and 0 is no accretion). |br|
 Default = 1.0
 
-**--enable-realistic-tides** |br|
-Enables realistic tides following the secular equations of Zahn, 1977. |br|
-Default = FALSE
-
-**--enable-tides** |br|
-Enables tides. |br|
-Default = FALSE
-
 **--enable-warnings** |br|
 Display warning messages to stdout. |br|
 Default = FALSE
@@ -1326,7 +1318,7 @@ Go to :ref:`the top of this page <options-props-top>` for the full alphabetical
 --mass-transfer-rejuvenation-prescription, --mass-transfer-thermal-limit-accretor, --mass-transfer-thermal-limit-C, --retain-core-mass-during-caseA-mass-transfer, 
 --stellar-zeta-prescription, --zeta-adiabatic-arbitrary, --zeta-main-sequence, --zeta-radiative-giant-star 
 
---circulariseBinaryDuringMassTransfer, --angular-momentum-conservation-during-circularisation, --enable-tides, --tides-prescription
+--circulariseBinaryDuringMassTransfer, --angular-momentum-conservation-during-circularisation, --tides-prescription
 
 --envelope-state-prescription, --common-envelope-alpha, --common-envelope-alpha-thermal, --common-envelope-formalism,
 --common-envelope-lambda-prescription, --common-envelope-lambda, 

diff --git a/py_tests/test_data/fiducial_bbh_config.yaml b/py_tests/test_data/fiducial_bbh_config.yaml
@@ -47,9 +47,6 @@ booleanChoices:
 #    --common-envelope-lambda-nanjing-use-rejuvenated-mass: False          # Default: False
 #    --revised-energy-formalism-nandez-ivanova: False                      # Default: False
 
-    ### TIDES
-#    --enable-tides: False                                                 # Default: False
-
     ### SUPERNOVAE, KICKS AND REMNANTS
 #    --allow-non-stripped-ECSN: False                                      # Default: False
 #    --pair-instability-supernovae: True                                   # Default: True

diff --git a/src/Options.cpp b/src/Options.cpp
@@ -778,16 +778,6 @@ bool Options::AddOptions(OptionValues *p_Options, po::options_description *p_Opt
             po::value<bool>(&p_Options->m_DetailedOutput)->default_value(p_Options->m_DetailedOutput)->implicit_value(true),                                                                      
             ("Print detailed output to file (default = " + std::string(p_Options->m_DetailedOutput ? "TRUE" : "FALSE") + ")").c_str()
         )
-        (
-            "enable-realistic-tides",                                               
-            po::value<bool>(&p_Options->m_EnableRealisticTides)->default_value(p_Options->m_EnableRealisticTides)->implicit_value(true),                                                                            
-            ("Enable realistic tides (default = " + std::string(p_Options->m_EnableRealisticTides ? "TRUE" : "FALSE") + ")").c_str()
-        )
-        (
-            "enable-tides",                                               
-            po::value<bool>(&p_Options->m_EnableTides)->default_value(p_Options->m_EnableTides)->implicit_value(true),                                                                            
-            ("Enable tides (default = " + std::string(p_Options->m_EnableTides ? "TRUE" : "FALSE") + ")").c_str()
-        )
 
         (
             "enable-warnings",                                             

diff --git a/src/Options.h b/src/Options.h
@@ -333,7 +333,6 @@ class Options {
         "eccentricity-distribution",
         "eccentricity-max",
         "eccentricity-min",
-        "enable-tides",
         "evolve-double-white-dwarfs",
         "evolve-pulsars",
         "evolve-unbound-systems",
@@ -445,7 +444,6 @@ class Options {
         "detailed-output",
 
         "eccentricity-distribution",
-        "enable-tides",
         "enable-warnings",
         "envelope-state-prescription",
         "errors-to-file",
@@ -1247,8 +1245,6 @@ class Options {
     bool                                        DebugToFile() const                                                     { return m_CmdLine.optionValues.m_DebugToFile; }
     bool                                        DetailedOutput() const                                                  { return m_CmdLine.optionValues.m_DetailedOutput; }
 
-    bool                                        EnableRealisticTides() const                                            { return OPT_VALUE("enable-realistic-tides", m_EnableRealisticTides, true); }
-    bool                                        EnableTides() const                                                     { return OPT_VALUE("enable-tides", m_EnableTides, true); }
     bool                                        EnableWarnings() const                                                  { return m_CmdLine.optionValues.m_EnableWarnings; }
     bool                                        ErrorsToFile() const                                                    { return m_CmdLine.optionValues.m_ErrorsToFile; }
     double                                      Eccentricity() const                                                    { return OPT_VALUE("eccentricity", m_Eccentricity, true); }

diff --git a/src/compasConfigDefault.yaml b/src/compasConfigDefault.yaml
@@ -47,9 +47,6 @@ booleanChoices:
 #    --common-envelope-lambda-nanjing-use-rejuvenated-mass: False          # Default: False
 #    --revised-energy-formalism-nandez-ivanova: False                      # Default: False
 
-    ### TIDES
-#    --enable-tides: False                                                 # Default: False
-
     ### SUPERNOVAE, KICKS AND REMNANTS
 #    --allow-non-stripped-ECSN: False                                      # Default: False
 #    --pair-instability-supernovae: True                                   # Default: True

diff --git a/src/yaml.h b/src/yaml.h
@@ -113,10 +113,6 @@ namespace yaml {
             "    --common-envelope-lambda-nanjing-use-rejuvenated-mass",
             "    --revised-energy-formalism-nandez-ivanova",
             "",
-            "    ### TIDES",
-            "    --enable-realistic-tides",
-            "    --enable-tides",
-            "",
             "    ### SUPERNOVAE, KICKS AND REMNANTS",
             "    --allow-non-stripped-ECSN",
             "    --pair-instability-supernovae",