quadd_mod.f

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

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

Variables on this page (5)

json, phidis, phirot, phisp, rat

Purpose

QUADD_MOD holds terms of the potential of a rotating star at each shell and the quadrupole correction factor of the meridional circulation. Shared by 3 routines. It replaces COMMON/QUADD/ (MHP via Claude, 10/14/26); JSON comes from DIMENSIONS_MOD.

What its variables hold, who sets them, who reads them.

PHISP, PHIROT, PHIDIS (JSON each): the spherical potential $GM/r$, the rotational term $\Omega^2 r^2$ and the distortion term, computed by FPFT (under "OUTPUT DATA," fpft.f, lines 93–98 ↗) and read by no routine, at rp_1 too, where a fourth file declared the block (unused?).
RAT(JSON): the ratio of the corrected to the classical expression of the Eddington–Sweet circulation velocity (the quadrupole term, "as per Zahn (1992)"), set by VCIRC from QUAD and GG (QUADRU_MOD); read by VCIRC and written by CHECKJ.

Design

A blanket USE QUADD_MOD in each routine.

Definitions

moduleQUADD_MOD

lines 19–33 · GitHub

Uses modules DIMENSIONS_MOD

Used by (3 units)

CHECKJ, FPFT, VCIRC

Change log

The changes since rp_1

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

1C 2C 3C$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 4C QUADD_MOD 5C$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 6C 10/14/26 MHP via Claude 7C code changed to convert COMMON/QUADD/ into this module. 8C 9C Imported with a blanket USE, the convention for the conversion. 10C All 3 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 QUADD_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 :: PHISP(JSON) 29 REAL*8 :: PHIROT(JSON) 30 REAL*8 :: PHIDIS(JSON) 31 REAL*8 :: RAT(JSON) 32 33 END MODULE QUADD_MOD

1"""Python version of quadd_mod.f (YREC 7be4133): terms of the rotating 2star's potential and the circulation's quadrupole factor, formerly 3COMMON/QUADD/. 4 5Translates: quadd_mod.f#QUADD_MOD (7be4133) 6 7Module-level names, as in the Fortran module, in lower case. Routines that 8USE QUADD_MOD import this module and write ``quadd_mod.<name>``. 9""" 10 11import numpy as np 12 13from pyrec import dimensions_mod 14 15_JSON = dimensions_mod.json 16 17# Index 0 unused (Fortran lines 28–31). 18# phisp, phirot and phidis are set by fpft and read by no routine (unused?). 19phisp = np.zeros(_JSON + 1) # GM/r 20phirot = np.zeros(_JSON + 1) # Omega^2 r^2 21phidis = np.zeros(_JSON + 1) # distortion term 22rat = np.zeros(_JSON + 1) # quadrupole factor of the circulation (vcirc)