From 768b44e8dfb15eb22c1f97d49983ce0bb2615095 Mon Sep 17 00:00:00 2001
From: Meridith Joyce <meridith.joyce@gmail.com>
Date: Fri, 9 Aug 2024 11:50:23 -0600
Subject: [PATCH] [ci skip] updates to starspots

---
 star/defaults/controls.defaults      | 9 +++++----
 star/private/starspots.f90           | 3 ++-
 star/test_suite/starspots/README.rst | 2 +-
 3 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/star/defaults/controls.defaults b/star/defaults/controls.defaults
index 07360ec94..ac5cac866 100644
--- a/star/defaults/controls.defaults
+++ b/star/defaults/controls.defaults
@@ -4645,7 +4645,7 @@
 
       ! If ``.true.``, switch on impedence of the surface flux due to magnetic pressure from starspots, 
       ! parameterized in the style of an atmospheric boundary modification. First described by 
-      ! `Somers et al. (2015; ApJ) <https://ui.adsabs.harvard.edu/abs/2015ApJ...807..174S>`__. 
+      ! Somers et al. (2015; ApJ) <https://ui.adsabs.harvard.edu/abs/2015ApJ...807..174S . 
       ! Detailed discussion of this functionality can be found in |MESA VI|.
 
       ! ::
@@ -4656,8 +4656,7 @@
       ! fspot
       ! ~~~~~
 
-      ! Filling Factor of starspots (in [0,1])
-
+      ! Filling Factor of starspots. Valid values between 0.0 and 1.0 (no spots to 100% coverage)
       ! ::
 
     fspot = 0d0
@@ -4666,7 +4665,9 @@
       ! xspot
       ! ~~~~~
 
-      ! Temperature contrast between the spotted and unspotted regions (in [0,1])
+      ! Temperature contrast between the spotted and unspotted regions. 
+      ! Valid values are between 1.0 (no contribution from magnetic pressure) and 0.5 
+      ! (half of the total pressure is due to magnetic pressure)
 
       ! ::
 
diff --git a/star/private/starspots.f90 b/star/private/starspots.f90
index 6191b5ac8..e7ff6602b 100644
--- a/star/private/starspots.f90
+++ b/star/private/starspots.f90
@@ -44,7 +44,8 @@ module starspots
 contains
 
 ! -------------
-! YREC routines
+! parameterized YREC routines
+! MESA models a pressure contrast rather than temperature contrast
 ! -------------
 
    subroutine starspot_tweak_gradr(s, P, gradr, gradr_spot)
diff --git a/star/test_suite/starspots/README.rst b/star/test_suite/starspots/README.rst
index f7b60e9c1..f80abafd3 100644
--- a/star/test_suite/starspots/README.rst
+++ b/star/test_suite/starspots/README.rst
@@ -34,6 +34,6 @@ A plot of the HR diagram for the problem is included below:
    :width: 100%
 
 
-Last-Updated: 06Aug2024 by Meridith Joyce
+Last-Updated: 09Aug2024 by Meridith Joyce
 
 Last-Run: 06Aug2024 (MESA 7890d305) by pmocz on C916PXT6XW in 629 seconds using 8 threads.