vfact_mod.f

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

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

Variables on this page (8)

fact1, fact2, fact3, fact4, fact5, fact7, fact8, json

Purpose

VFACT_MOD holds the factors at each interface from which the circulation velocities and the stability criteria of rotational mixing are computed; SETUPV sets them once per step and VCIRC uses them. Shared by 2 routines. It replaces COMMON/VFACT/ (MHP via Claude, 10/14/26); JSON comes from DIMENSIONS_MOD.

What its variables hold, who sets them, who reads them. All are set by SETUPV (to 0 first, then at each interface); SETUPV's page gives the equations.

FACT1, FACT2 (JSON each): the Eddington–Sweet velocity, VES = FACT1·FACT2·$\Omega^2$ ("Endal and Sofia paper II"), with FACT6 of TAUKH_MOD; read by VCIRC, which also uses FACT1 for the $\mu$ currents.
FACT3(JSON): $|H_T r|$, for the Goldreich–Schubert–Fricke velocity; read only in VCIRC's commented-out lines.
FACT4(JSON): the "fictitious $\mu$ currents" (Kippenhahn, IAU 66); read by VCIRC.
FACT5(JSON): the Richardson criterion of the secular shear with $\mu$ gradients; read by VCIRC.
FACT7, FACT8 (JSON each): the terms of order $\mathrm{d}\Omega/\mathrm{d}r$ (Zahn and Maeder 1998), computed only with LDIFAD; FACT8 stays 0. Read by VCIRC.

Design

A blanket USE VFACT_MOD in each routine.

Definitions

moduleVFACT_MOD

lines 19–36 · GitHub

Uses modules DIMENSIONS_MOD

Used by (2 units)

SETUPV, VCIRC

Change log

The changes since rp_1

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

1C 2C 3C$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 4C VFACT_MOD 5C$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 6C 10/14/26 MHP via Claude 7C code changed to convert COMMON/VFACT/ into this module. 8C 9C Imported with a blanket USE, the convention for the conversion. 10C All 2 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 VFACT_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 :: FACT1(JSON) 29 REAL*8 :: FACT2(JSON) 30 REAL*8 :: FACT3(JSON) 31 REAL*8 :: FACT4(JSON) 32 REAL*8 :: FACT5(JSON) 33 REAL*8 :: FACT7(JSON) 34 REAL*8 :: FACT8(JSON) 35 36 END MODULE VFACT_MOD

1"""Python version of vfact_mod.f (YREC 7be4133): factors of the circulation 2velocities and stability criteria at each interface, formerly COMMON/VFACT/. 3 4Translates: vfact_mod.f#VFACT_MOD (7be4133) 5 6Module-level names, as in the Fortran module, in lower case. Routines that 7USE VFACT_MOD import this module and write ``vfact_mod.<name>``. 8Set by setupv, read by vcirc. Index 0 unused. 9""" 10 11import numpy as np 12 13from pyrec import dimensions_mod 14 15_JSON = dimensions_mod.json 16 17# Fortran lines 28–34. 18fact1 = np.zeros(_JSON + 1) # Eddington-Sweet velocity: ves = fact1*fact2*omega**2 19fact2 = np.zeros(_JSON + 1) 20fact3 = np.zeros(_JSON + 1) # |H_T r| for the GSF velocity (read nowhere) 21fact4 = np.zeros(_JSON + 1) # mu currents 22fact5 = np.zeros(_JSON + 1) # Richardson criterion with mu gradients 23fact7 = np.zeros(_JSON + 1) # d omega/dr terms (ldifad only) 24fact8 = np.zeros(_JSON + 1) # stays 0