Merge pull request #298 from spmatt/BreimannTorque

Breimann+21 Wind Torque
VirtualPlanetaryLaboratory · Aug 12, 2024 · 5fc4592 · 5fc4592
2 parents cf99e6a + 57446d5
commit 5fc4592
Show file tree

Hide file tree

Showing 21 changed files with 343 additions and 41 deletions.
diff --git a/examples/MagneticBraking/MagneticBraking.png b/examples/MagneticBraking/MagneticBraking.png
diff --git a/examples/MagneticBraking/MagneticBrakingTorques.png b/examples/MagneticBraking/MagneticBrakingTorques.png
diff --git a/examples/MagneticBraking/MagneticBraking_MBOnly.png b/examples/MagneticBraking/MagneticBraking_MBOnly.png
diff --git a/examples/MagneticBraking/README.rst b/examples/MagneticBraking/README.rst
@@ -11,12 +11,18 @@ Rotational evolution of stars due to magnetic effects.
 **Author**            David Fleming
 **Modules**           STELLAR
 **Approx. runtime**   2 minutes
+**Updates**           '24 Aug, Sean Matt
 ===================   ============
 
 Rotation period evolution for 0.1 and 1.0 solar-mass stars due to stellar
-evolution and magnetic braking. This example shows how the three available
-magnetic braking laws (`Reiners & Mohanty [2012] <https://ui.adsabs.harvard.edu/abs/2012ApJ...746...43R/abstract>`_, `Repetto & Nelemans [2014] <https://ui.adsabs.harvard.edu/abs/2014MNRAS.444..542R/abstract>`_,
-and `Matt et al. [2015] <https://ui.adsabs.harvard.edu/abs/2015ApJ...799L..23M/abstract>`_) impact the rotation period.
+evolution and magnetic braking. This example shows how the four available
+magnetic braking laws 
+(`Reiners & Mohanty [2012] <https://ui.adsabs.harvard.edu/abs/2012ApJ...746...43R/abstract>`_, 
+`Repetto & Nelemans [2014] <https://ui.adsabs.harvard.edu/abs/2014MNRAS.444..542R/abstract>`_,
+`Matt et al. [2015] <https://ui.adsabs.harvard.edu/abs/2015ApJ...799L..23M/abstract>`_, 
+and the "standard model" of
+`Breimann et al. [2021] <https://ui.adsabs.harvard.edu/abs/2021ApJ...913...75B/abstract>`_) 
+impact the rotation period.
 
 This example also demonstrates how the VPLanet implementation of the `Matt et al. [2015] <https://ui.adsabs.harvard.edu/abs/2015ApJ...799L..23M/abstract>`_
 magnetic braking model can be used to reproduce the upper enveloped of the Kepler
@@ -27,7 +33,7 @@ To run this example
 
 .. code-block:: bash
 
-    python makeplot.py <pdf | png>
+    python makeplot.py
 
 
 Expected output
@@ -37,8 +43,31 @@ Expected output
    :width: 100%
    :align: center
 
-Rotation period evolution of 0.1 and 1 solar-mass stars due to stellar evolution
-(`Baraffe et al. 2015 <https://ui.adsabs.harvard.edu/abs/2015A%26A...577A..42B/abstract>`_) and the three magnetic braking laws.
+Rotation period evolution of 0.1 and 1 solar-mass stars, due to structural evolution
+(`Baraffe et al. 2015 <https://ui.adsabs.harvard.edu/abs/2015A%26A...577A..42B/abstract>`_) 
+and the four magnetic braking laws.
+
+
+.. figure:: MagneticBraking_MBOnly.png
+   :width: 100%
+   :align: center
+
+Rotation period evolution of 0.1 and 1 solar-mass stars due to structural evolution
+(`Baraffe et al. 2015 <https://ui.adsabs.harvard.edu/abs/2015A%26A...577A..42B/abstract>`_) 
+and the two more modern magnetic braking laws, 
+for two different initial rotation rates.
+
+
+.. figure:: MagneticBrakingTorques.png
+   :width: 100%
+   :align: center
+
+Stellar wind torque versus Rossby number of 0.1 and 1 solar-mass stars during their evolution
+(`Baraffe et al. 2015 <https://ui.adsabs.harvard.edu/abs/2015A%26A...577A..42B/abstract>`_), 
+comparing two magnetic braking laws (approximately following fig. 10 in
+`Breimann et al. 2021 <https://ui.adsabs.harvard.edu/abs/2021ApJ...913...75B/abstract>`_,
+but here for different masses and here including the effects stellar structural evolution).
+
 
 .. figure:: kepler.png
    :width: 100%

diff --git a/examples/MagneticBraking/a_breimann.in b/examples/MagneticBraking/a_breimann.in
@@ -0,0 +1,12 @@
+#
+sName	                  a_breimann
+saModules	              stellar
+dMass                     0.1
+dAge                      5.0e6
+dRotPeriod               -1.0   # Initial rotaiton period (days)
+sStellarModel             baraffe
+sMagBrakingModel          breimann21
+bHaltEndBaraffeGrid       1
+dSatXUVFrac               1.e-3
+dSatXUVTime               -0.1
+saOutputOrder Time -TotAngMom -Luminosity -Radius Temperature -RotPer RadGyra WindTorque RossbyNumber
diff --git a/examples/MagneticBraking/a_breimannslow.in b/examples/MagneticBraking/a_breimannslow.in
@@ -0,0 +1,12 @@
+#
+sName	                  a_breimannslow
+saModules	              stellar
+dMass                     0.1
+dAge                      5.0e6
+dRotPeriod               -10.0   # Initial rotaiton period (days)
+sStellarModel             baraffe
+sMagBrakingModel          breimann21
+bHaltEndBaraffeGrid       1
+dSatXUVFrac               1.e-3
+dSatXUVTime               -0.1
+saOutputOrder Time -TotAngMom -Luminosity -Radius Temperature -RotPer RadGyra WindTorque RossbyNumber
diff --git a/examples/MagneticBraking/a_matt.in b/examples/MagneticBraking/a_matt.in
@@ -1,11 +1,12 @@
 #
 sName	                  a_matt
-saModules	          stellar
+saModules	              stellar
 dMass                     0.1
 dAge                      5.0e6
+dRotPeriod               -1.0   # Initial rotaiton period (days)
 sStellarModel             baraffe
 sMagBrakingModel          matt
 bHaltEndBaraffeGrid       1
 dSatXUVFrac               1.e-3
 dSatXUVTime               -0.1
-saOutputOrder Time -TotEn -TotAngMom -Luminosity -Radius Temperature -RotPer -LXUVTot RadGyra
+saOutputOrder Time -TotAngMom -Luminosity -Radius Temperature -RotPer RadGyra WindTorque RossbyNumber
diff --git a/examples/MagneticBraking/a_mattslow.in b/examples/MagneticBraking/a_mattslow.in
@@ -0,0 +1,12 @@
+#
+sName	                  a_mattslow
+saModules	              stellar
+dMass                     0.1
+dAge                      5.0e6
+dRotPeriod               -10.0   # Initial rotaiton period (days)
+sStellarModel             baraffe
+sMagBrakingModel          matt
+bHaltEndBaraffeGrid       1
+dSatXUVFrac               1.e-3
+dSatXUVTime               -0.1
+saOutputOrder Time -TotAngMom -Luminosity -Radius Temperature -RotPer RadGyra WindTorque RossbyNumber
diff --git a/examples/MagneticBraking/a_reiners.in b/examples/MagneticBraking/a_reiners.in
@@ -1,11 +1,12 @@
 #
 sName	                  a_reiners
-saModules	          stellar
+saModules	              stellar
 dMass                     0.1
 dAge                      5.0e6
+dRotPeriod               -1.0   # Initial rotaiton period (days)
 sStellarModel             baraffe
 sMagBrakingModel          reiners
 bHaltEndBaraffeGrid       1
 dSatXUVFrac               1.e-3
 dSatXUVTime               -0.1
-saOutputOrder Time -TotEn -TotAngMom -Luminosity -Radius Temperature -RotPer -LXUVTot RadGyra
+saOutputOrder Time -TotAngMom -Luminosity -Radius Temperature -RotPer RadGyra WindTorque RossbyNumber
diff --git a/examples/MagneticBraking/a_sk.in b/examples/MagneticBraking/a_sk.in
@@ -1,11 +1,12 @@
 #
 sName	                  a_sk
-saModules	          stellar
+saModules	              stellar
 dMass                     0.1
 dAge                      5.0e6
+dRotPeriod               -1.0   # Initial rotaiton period (days)
 sStellarModel             baraffe
 sMagBrakingModel          skumanich
 bHaltEndBaraffeGrid       1
 dSatXUVFrac               1.e-3
 dSatXUVTime               -0.1
-saOutputOrder Time -TotEn -TotAngMom -Luminosity -Radius Temperature -RotPer -LXUVTot RadGyra
+saOutputOrder Time -TotAngMom -Luminosity -Radius Temperature -RotPer RadGyra WindTorque RossbyNumber
diff --git a/examples/MagneticBraking/b_breimann.in b/examples/MagneticBraking/b_breimann.in
@@ -0,0 +1,12 @@
+#
+sName	                  b_breimann
+saModules	              stellar
+dMass                     1.0
+dAge                      5.0e6
+dRotPeriod               -1.0   # Initial rotaiton period (days)
+sStellarModel             baraffe
+sMagBrakingModel          breimann21
+bHaltEndBaraffeGrid       1
+dSatXUVFrac               1.e-3
+dSatXUVTime               -0.1
+saOutputOrder Time -TotAngMom -Luminosity -Radius Temperature -RotPer RadGyra WindTorque RossbyNumber
diff --git a/examples/MagneticBraking/b_breimannslow.in b/examples/MagneticBraking/b_breimannslow.in
@@ -0,0 +1,12 @@
+#
+sName	                  b_breimannslow
+saModules	              stellar
+dMass                     1.0
+dAge                      5.0e6
+dRotPeriod               -10.0   # Initial rotaiton period (days)
+sStellarModel             baraffe
+sMagBrakingModel          breimann21
+bHaltEndBaraffeGrid       1
+dSatXUVFrac               1.e-3
+dSatXUVTime               -0.1
+saOutputOrder Time -TotAngMom -Luminosity -Radius Temperature -RotPer RadGyra WindTorque RossbyNumber
diff --git a/examples/MagneticBraking/b_matt.in b/examples/MagneticBraking/b_matt.in
@@ -1,11 +1,12 @@
 #
 sName	                  b_matt
-saModules	          stellar
+saModules	              stellar
 dMass                     1.0
 dAge                      5.0e6
+dRotPeriod               -1.0   # Initial rotaiton period (days)
 sStellarModel             baraffe
 sMagBrakingModel          matt
 bHaltEndBaraffeGrid       1
 dSatXUVFrac               1.e-3
 dSatXUVTime               -0.1
-saOutputOrder Time -TotEn -TotAngMom -Luminosity -Radius Temperature -RotPer -LXUVTot RadGyra
+saOutputOrder Time -TotAngMom -Luminosity -Radius Temperature -RotPer RadGyra WindTorque RossbyNumber
diff --git a/examples/MagneticBraking/b_mattslow.in b/examples/MagneticBraking/b_mattslow.in
@@ -0,0 +1,12 @@
+#
+sName	                  b_mattslow
+saModules	              stellar
+dMass                     1.0
+dAge                      5.0e6
+dRotPeriod               -10.0   # Initial rotaiton period (days)
+sStellarModel             baraffe
+sMagBrakingModel          matt
+bHaltEndBaraffeGrid       1
+dSatXUVFrac               1.e-3
+dSatXUVTime               -0.1
+saOutputOrder Time -TotAngMom -Luminosity -Radius Temperature -RotPer RadGyra WindTorque RossbyNumber
diff --git a/examples/MagneticBraking/b_reiners.in b/examples/MagneticBraking/b_reiners.in
@@ -1,11 +1,12 @@
 #
 sName	                  b_reiners
-saModules	          stellar
+saModules	              stellar
 dMass                     1.0
 dAge                      5.0e6
+dRotPeriod               -1.0   # Initial rotaiton period (days)
 sStellarModel             baraffe
 sMagBrakingModel          reiners
 bHaltEndBaraffeGrid       1
 dSatXUVFrac               1.e-3
 dSatXUVTime               -0.1
-saOutputOrder Time -TotEn -TotAngMom -Luminosity -Radius Temperature -RotPer -LXUVTot RadGyra
+saOutputOrder Time -TotAngMom -Luminosity -Radius Temperature -RotPer RadGyra WindTorque RossbyNumber
diff --git a/examples/MagneticBraking/b_sk.in b/examples/MagneticBraking/b_sk.in
@@ -1,11 +1,12 @@
 #
 sName	                  b_sk
-saModules	          stellar
+saModules	              stellar
 dMass                     1.0
 dAge                      5.0e6
+dRotPeriod               -1.0   # Initial rotaiton period (days)
 sStellarModel             baraffe
 sMagBrakingModel          skumanich
 bHaltEndBaraffeGrid       1
 dSatXUVFrac               1.e-3
 dSatXUVTime               -0.1
-saOutputOrder Time -TotEn -TotAngMom -Luminosity -Radius Temperature -RotPer -LXUVTot RadGyra
+saOutputOrder Time -TotAngMom -Luminosity -Radius Temperature -RotPer RadGyra WindTorque RossbyNumber
diff --git a/examples/MagneticBraking/kepler.png b/examples/MagneticBraking/kepler.png