scrtch_mod.f

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

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

Variables on this page (11)

json, locons, sbeta, scp, sdel, seg, sesum, seta, sfxion, so, svel

Purpose

SCRTCH_MOD holds the local physics of the interior at each shell, as computed in the last pass of the structure equations: energy generation, opacity, temperature gradients, ionization, convective velocity. Many routines read it later in the step (mixing, burning, regridding, output). Shared by 16 routines. It replaces COMMON/SCRTCH/ (MHP via Claude, 10/14/26); JSON comes from DIMENSIONS_MOD.

What its variables hold, who sets them, who reads them. COEFFT stores all of them at each shell IM; PHYSIC stores SO, SDEL and SVEL again when it recomputes the physics.

SESUM(JSON): the sum of the nuclear energy generation's five terms EG(1)…EG(5) (0 below the cutoff temperature TCUT(1)); SEG(7,JSON): those five as fractions of SESUM, then the neutrino term EG(6) and the gravitational term HHC (EGRAV) (SEG(6), SEG(7)). Read by HPOINT (which interpolates them, through OSPLIN, to the grid at the start of the step), MIDMOD, WRTMIL, the setup of rotation (FRACNUC in ROTDER_MOD) and the output (PUTSTORE, STITCH, WRTMOD).
SO(JSON): the opacity. Read by HPOINT, MIDMOD, VISCOS and the output (PUTSTORE, STITCH, WRTMOD, WRTOUT).
SDEL(3,JSON): $\nabla_\mathrm{rad}$, $\nabla$, $\nabla_\mathrm{ad}$. ROTMIX replaces SDEL(2,·) for a while and restores it. Read by the burning and mixing routines (LIBURN, LIBURN2, MICRODIFF_MTE, SETUP_GRSETT, ROTMIX), GETTAU, HPOINT, MIDMOD, PHYSIC and the output.
SVEL(JSON): the convective velocity (cm/s); read by GETTAU, HPOINT, MIDMOD and the output.
SBETA(JSON), SETA(JSON), SFXION(3,JSON), SCP(JSON): $\beta$ (gas over total pressure), the degeneracy parameter $\eta$, the three ionization fractions and $c_P$, for the stored model (PUTSTORE, STITCH).
LOCONS(JSON): meant to say whether conduction dominates the opacity; set by COEFFT from its LOCOND, which it always sets to true (coefft.f, line 161 ↗; coefft.f, line 444 ↗), and read by no routine (unused?).

Design

A blanket USE SCRTCH_MOD in each routine.

Definitions

moduleSCRTCH_MOD

lines 19–39 · GitHub

Uses modules DIMENSIONS_MOD

Used by (16 units)

COEFFT, GETTAU, HPOINT, LIBURN, LIBURN2, MICRODIFF_MTE, MIDMOD, PHYSIC, PUTSTORE, ROTMIX, SETUP_GRSETT, STITCH, VISCOS, WRTMIL, WRTMOD, WRTOUT

Change log

The changes since rp_1

Changed since rp_1. New file: COMMON/SCRTCH/ as a module.

1C 2C 3C$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 4C SCRTCH_MOD 5C$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 6C 10/14/26 MHP via Claude 7C code changed to convert COMMON/SCRTCH/ into this module. 8C 9C Imported with a blanket USE, the convention for the conversion. 10C All 16 files declared this block identically, so the USE 11C imports exactly the names the declaration already made global in 12C each scoping unit and cannot change meaning. 13C 14C The types restate what the implicit rules supplied: L is 15C LOGICAL*4, I/J/K/M/N are INTEGER*4, everything else REAL*8. 16C SAVE is explicit rather than relying on module variables being 17C implicitly saved, which holds only from Fortran 2008 while ifort 18C Classic predates it. That matches COMMON's semantics. 19 MODULE SCRTCH_MOD 20C 10/20/26 MHP via Claude 21C code changed to take JSON from DIMENSIONS_MOD instead of declaring 22C a PRIVATE copy here. 23 USE DIMENSIONS_MOD 24 25 IMPLICIT NONE 26 SAVE 27 28 REAL*8 :: SESUM(JSON) 29 REAL*8 :: SEG(7,JSON) 30 REAL*8 :: SBETA(JSON) 31 REAL*8 :: SETA(JSON) 32 LOGICAL*4 :: LOCONS(JSON) 33 REAL*8 :: SO(JSON) 34 REAL*8 :: SDEL(3,JSON) 35 REAL*8 :: SFXION(3,JSON) 36 REAL*8 :: SVEL(JSON) 37 REAL*8 :: SCP(JSON) 38 39 END MODULE SCRTCH_MOD

1"""Python version of scrtch_mod.f (YREC 7be4133): the interior's local physics at each shell, formerly COMMON/SCRTCH/. 2 3Translates: scrtch_mod.f#SCRTCH_MOD (7be4133) 4 5Module-level names, as in the Fortran module, in lower case. Routines that 6USE SCRTCH_MOD import this module and write ``scrtch_mod.<name>``. 7Set by coefft at each shell (so, sdel, svel also by physic). Index 0 unused 8in every dimension. 9""" 10 11import numpy as np 12 13from pyrec import dimensions_mod 14 15_JSON = dimensions_mod.json 16 17# The local physics at each shell (Fortran lines 28–37). 18sesum = np.zeros(_JSON + 1) # nuclear energy generation, EG(1)..EG(5) 19seg = np.zeros((8, _JSON + 1)) # 1-5: fractions of sesum; 6: neutrinos; 7: gravitational 20sbeta = np.zeros(_JSON + 1) # beta, gas over total pressure 21seta = np.zeros(_JSON + 1) # degeneracy parameter eta 22locons = np.zeros(_JSON + 1, dtype=bool) # conduction dominates (read nowhere) 23so = np.zeros(_JSON + 1) # opacity 24sdel = np.zeros((4, _JSON + 1)) # 1: nabla_rad, 2: nabla, 3: nabla_ad 25sfxion = np.zeros((4, _JSON + 1)) # ionization fractions 26svel = np.zeros(_JSON + 1) # convective velocity, cm/s 27scp = np.zeros(_JSON + 1) # c_P