ovrot.f

37 lines · 1 definitions · on GitHub (7be4133)

Python version: ovrot.py, 51 lines, on the right (switch to Python above the code).

Variables on this page (1)

json

Purpose

Sets the convection flags LCZ used for rotation and mixing so that they include convective overshoot: it calls CONVEC, which finds the mixed zones with overshoot, and marks every shell in a mixed zone convective and every shell in a radiative zone not.

How it fits

Inputs: the model (HCOMP, HD, HP, HR, HS, HT), the Schwarzschild flags LC and M.
Who calls it: GETW, HPOINT, MIDMOD and STARIN.
What it calls: CONVEC (which in turn calls OVERSH).
Outputs: LCZ, and the zone lists MRZONE, MXZONE, NRZONE, NZONE. The edges JCORE, JENV and the zones without overshoot MXZON0 are local and dropped.

The method

The radiative zones are marked first, then the mixed zones (lines 24–34 ↗); a check I .GT. 0 guards LCZ(I) = .FALSE. (comment: "to avoid runtime error"). The check cannot fail: CONVEC gives every radiative region it counts a lower edge of at least 1 (convec.f, lines 183–205 ↗), and the loop counts up from it (settled from the code, Nov 9, 2026: lines 25–27 ↗). The out-of-range index is more likely CONVEC's bug 1 (convec.f, suspected bug 1), which leaves the top radiative region's upper edge stale, possibly beyond M (from an earlier call with more shells), which the check does not catch; the loop over MXZONE has no check either. That bug also makes the first loop mark shells 1 to M radiative, which is harmless here, since the second loop then marks the mixed zones.

Definitions

subroutineOVROT

lines 2–37 · GitHub

Uses modules DIMENSIONS_MOD

Called by GETW, HPOINT, MIDMOD, STARIN

Flowchart of its calls, in order (1)

CONVEC 22

Change log

The changes since rp_1

Changed since rp_1. Declarations only: JSON from DIMENSIONS_MOD, IMPLICIT NONE.

1C $$$$$$ 2 SUBROUTINE OVROT(HCOMP,HD,HP,HR,HS,HT,LC,M,LCZ,MRZONE,MXZONE, 3 * * NRZONE,NZONE) 4C 10/15/26 MHP via Claude 5C code changed to take JSON from DIMENSIONS_MOD instead of declaring 6C PARAMETER(JSON=5000) here. 7 USE DIMENSIONS_MOD 8C 10/20/26 MHP via Claude 9C code changed to replace implicit typing with IMPLICIT NONE and 10C explicit declarations. 11 IMPLICIT NONE 12 REAL*8 HCOMP,HD,HP,HR,HS,HT 13 INTEGER I,J,JCORE,JENV,M,MRZONE,MXZON0,MXZONE,NRZONE,NZONE,NZONE0 14 LOGICAL*4 LC,LCZ 15 16 DIMENSION HCOMP(15,JSON),HD(JSON),HP(JSON),HR(JSON),HS(JSON), 17 * * HT(JSON),LC(JSON),LCZ(JSON),MRZONE(13,2),MXZONE(12,2), 18 * * MXZON0(12,2) 19 save 20 21C ISOLATE CONVECTIVE REGIONS INCLUDING OVERSHOOT. 22 CALL CONVEC(HCOMP,HD,HP,HR,HS,HT,LC,M,MRZONE,MXZONE,MXZON0, 23 * * JCORE,JENV,NRZONE,NZONE,NZONE0) 24 DO 10 J = 1,NRZONE 25 DO 5 I = MRZONE(J,1),MRZONE(J,2) 26C KC 2025-05-30 ADDED IF CHECK TO AVOID RUNTIME ERROR. 27 IF (I .GT. 0) LCZ(I) = .FALSE. 28 5 5 CONTINUE 29 10 10 CONTINUE 30 DO 20 J = 1,NZONE 31 DO 15 I = MXZONE(J,1),MXZONE(J,2) 32 LCZ(I) = .TRUE. 33 15 15 CONTINUE 34 20 20 CONTINUE 35 36 RETURN 37 END

1"""Python version of ovrot.f (YREC 7be4133): convection flags for rotation 2and mixing, overshoot included.""" 3 4import numpy as np 5 6from pyrec.convec import convec 7 8# Locals kept between calls (SAVE). 9mxzon0 = np.zeros((13, 3), dtype=int) 10jcore = 0 11jenv = 0 12nzone0 = 0 13 14 15def ovrot(hcomp: np.ndarray, hd: np.ndarray, hp: np.ndarray, hr: np.ndarray, hs: np.ndarray, ht: np.ndarray, 16 lc: np.ndarray, m: int, lcz: np.ndarray, mrzone: np.ndarray, mxzone: np.ndarray, nrzone: int, 17 nzone: int) -> tuple[int, int]: 18 """Call CONVEC for the mixed zones with overshoot, then mark every 19 shell of a radiative zone not convective and every shell of a mixed 20 zone convective in lcz. 21 22 Translates: ovrot.f#OVROT (7be4133) 23 24 Arguments: the model hcomp, hd, hp, hr, hs, ht; lc, the Schwarzschild 25 flags; m, the number of shells; lcz, set in place; mrzone[13+1, 2+1], 26 mxzone[12+1, 2+1], the radiative and mixed zones, set in place by 27 CONVEC; nrzone, nzone (set). Returns (nrzone, nzone). 28 29 """ 30 31 global jcore, jenv, nzone0 32 33 # The convective regions with overshoot (Fortran lines 21–23). 34 jcore, jenv, nrzone, nzone, nzone0 = convec( 35 hcomp, hd, hp, hr, hs, ht, lc, m, mrzone, mxzone, mxzon0, 36 jcore, jenv, nrzone, nzone, nzone0) 37 38 # The radiative zones (Fortran lines 24–29). The guard i > 0 cannot 39 # fail; an upper bound beyond m (CONVEC's suspected bug, see its page) 40 # is not caught. 41 for j in range(1, nrzone + 1): 42 for i in range(mrzone[j, 1], mrzone[j, 2] + 1): 43 if i > 0: 44 lcz[i] = False 45 46 # The mixed zones (Fortran lines 30–34). 47 for j in range(1, nzone + 1): 48 for i in range(mxzone[j, 1], mxzone[j, 2] + 1): 49 lcz[i] = True 50 51 return nrzone, nzone