difad3_mod.f

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

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

Variables on this page (22)

dgsf, dss, ecod5, ecod6, egsf, ess, ev0, ev1a, ev1b, ev2a, ev2b, facd2, facd3, fgeom, fv0, fv1a, fv1b, fv2a, fv2b, json, vesd2, vesd3

Purpose

DIFAD3_MOD holds the Zahn-type factors of the diffusion-plus-advection treatment of angular momentum (LDIFAD), shared by SETUPV, VCIRC and DADCOEFT. It replaces COMMON/DIFAD3/ (MHP via Claude, 10/14/26); JSON comes from DIMENSIONS_MOD. All 21 members are arrays of JSON.

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

FACD2, FACD3: factors set by SETUPV, from which VCIRC forms VESD2, VESD3 (0.2*FACD*WM, then rescaled by the μ-gradient factor); VESD2, VESD3 are read nowhere else.
FV0, FV1A, FV1B, FV2A, FV2B: set by SETUPV (FV2B with the FACT7 term added); VCIRC rescales FV0. FV1A–FV2B are read nowhere: unused? (So are VESD2, VESD3 above.)
DSS, DGSF: $r\,|v_\mathrm{SS}|$ and $r\,|v_\mathrm{GSF}|$, set by VCIRC, read nowhere: unused?
EV0, EV1A, EV1B, EV2A, EV2B, ECOD5, ECOD6, FGEOM, ESS, EGSF: read by DADCOEFT to build its coefficients (ESS, EGSF rescaled in place there), but set by no routine, so they keep their initial values (zero in practice, though a module variable without an initializer is formally undefined). The coefficients ECOD3, ECOD4 that DADCOEFT computes from them are then zero (dadcoeft.f, lines 244–269 ↗), and DADCOEFT divides by FGEOM (dadcoeft.f, lines 592–597 ↗). This is DADCOEFT's suspected bug 1 (only with LDIFAD, off by default), whose possible fix takes them for the even-grid versions of the FV*, DSS, and DGSF on the model's grid; VESD2 and VESD3 may be missing inputs too, and FGEOM a geometric factor still to be computed.

Design

A blanket USE DIFAD3_MOD. The block looks like a half-finished link between the factors SETUPV computes (FV*) and those DADCOEFT reads (EV*), which differ only in their first letter.

Definitions

moduleDIFAD3_MOD

lines 19–50 · GitHub

Uses modules DIMENSIONS_MOD

Used by (3 units)

DADCOEFT, SETUPV, VCIRC

Change log

The changes since rp_1

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

1C 2C 3C$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 4C DIFAD3_MOD 5C$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 6C 10/14/26 MHP via Claude 7C code changed to convert COMMON/DIFAD3/ 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 DIFAD3_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 :: FACD2(JSON) 29 REAL*8 :: FACD3(JSON) 30 REAL*8 :: VESD2(JSON) 31 REAL*8 :: VESD3(JSON) 32 REAL*8 :: ECOD5(JSON) 33 REAL*8 :: ECOD6(JSON) 34 REAL*8 :: FGEOM(JSON) 35 REAL*8 :: FV0(JSON) 36 REAL*8 :: FV1A(JSON) 37 REAL*8 :: FV1B(JSON) 38 REAL*8 :: FV2A(JSON) 39 REAL*8 :: FV2B(JSON) 40 REAL*8 :: EV0(JSON) 41 REAL*8 :: EV1A(JSON) 42 REAL*8 :: EV1B(JSON) 43 REAL*8 :: EV2A(JSON) 44 REAL*8 :: EV2B(JSON) 45 REAL*8 :: DSS(JSON) 46 REAL*8 :: DGSF(JSON) 47 REAL*8 :: ESS(JSON) 48 REAL*8 :: EGSF(JSON) 49 50 END MODULE DIFAD3_MOD

1"""Python version of difad3_mod.f (YREC 7be4133): the Zahn-type factors of 2the diffusion-plus-advection treatment of angular momentum, formerly 3COMMON/DIFAD3/. 4 5Translates: difad3_mod.f#DIFAD3_MOD (7be4133) 6 7Routines that USE DIFAD3_MOD import this module and write 8``difad3_mod.<name>``. All arrays have JSON + 1 elements, 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–48. 18facd2 = np.zeros(_JSON + 1) # setupv; read by vcirc 19facd3 = np.zeros(_JSON + 1) # setupv; read by vcirc 20vesd2 = np.zeros(_JSON + 1) # vcirc; read nowhere else 21vesd3 = np.zeros(_JSON + 1) # vcirc; read nowhere else 22# Question (see the page): ecod5, ecod6, fgeom, ev0-ev2b, ess and egsf 23# are read by dadcoeft but set by no routine (zero here). 24ecod5 = np.zeros(_JSON + 1) 25ecod6 = np.zeros(_JSON + 1) 26fgeom = np.zeros(_JSON + 1) 27fv0 = np.zeros(_JSON + 1) # setupv; rescaled by vcirc 28fv1a = np.zeros(_JSON + 1) # setupv; read nowhere 29fv1b = np.zeros(_JSON + 1) # setupv; read nowhere 30fv2a = np.zeros(_JSON + 1) # setupv; read nowhere 31fv2b = np.zeros(_JSON + 1) # setupv; read nowhere 32ev0 = np.zeros(_JSON + 1) # read by dadcoeft, set nowhere 33ev1a = np.zeros(_JSON + 1) 34ev1b = np.zeros(_JSON + 1) 35ev2a = np.zeros(_JSON + 1) 36ev2b = np.zeros(_JSON + 1) 37dss = np.zeros(_JSON + 1) # r |v_SS| (vcirc); read nowhere 38dgsf = np.zeros(_JSON + 1) # r |v_GSF| (vcirc); read nowhere 39ess = np.zeros(_JSON + 1) # read (and rescaled) by dadcoeft, set nowhere 40egsf = np.zeros(_JSON + 1) # read (and rescaled) by dadcoeft, set nowhere