iounits_mod.f

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

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

Variables on this page (29)

ialex06, iclcd, icondopacp, idebug, ifermi, ifirst, ijlast, ilast, iliv95, imilne, imodpt, ioatm, ioatma, iopale, iopatm, iopenv, iopmod, iopurez, iowr, irun, iscvh, iscvhe, iscvz, ishort, isnu, isound, istand, istor, itrack

Purpose

IOUNITS_MOD holds the Fortran logical unit numbers of every input and output file, shared by 57 routines. It replaces COMMON/IOUNITS/ (MHP via Claude, 10/14/26), which had gathered, on 9/25/26, the unit numbers once scattered over COMMON/LUOUT/, /LUNUM/, /ALEX06/, /ACDPTH/, /NEWOPAC/, /LOPAL95/, /ATMOS2/, /ALATM03/, /OPALEOS/ and /SCV2/ (the dead IDYN, ILLDAT, ISCOMP, IKUR of /LUNUM/ removed). All members are INTEGER*4.

What its variables hold, who sets them, who reads them. PARMIN assigns every number (its comments name the files; they can be changed only in the code) and opens most of the files; the routines that read or write a file use its unit.

Run control: IOWR = 6 (the status output, the screen; the main program sets it to 9 before calling PARMIN, which overwrites it), ISTAND = 14 and IRUN = 13 (the CONTROL and PHYSICS namelists, read by PARMIN).
Models: IFIRST = 12 (the starting model), ILAST = 11 (the last model), ISTOR = 23 (saved models).
Outputs: ISHORT = 20 (all diagnostic information, the .short file), ITRACK = 19 (the track), IDEBUG = 18 (debugging), IMILNE = 21 (Milne's invariant variables, written by WRTMIL), IMODPT = 22 (shell-by-shell output), ISNU = 33 (neutrino fluxes), ISOUND = 500 (the sound-speed profile, written by WRTMOD with LSOUND), IOPMOD, IOPENV, IOPATM = 24, 25, 26 (interior, envelope and atmosphere for a pulsation code, also opened by PDIST), ICLCD = 91 (the acoustic-depth output, assigned only with LACOUT).
Input tables: IFERMI = 15 (Fermi–Dirac tables, read by SETUPS), IOATM = 38 (Kurucz atmospheres, SETUPS), IOATMA = 66 (Allard atmospheres, ALFILEIN), ILIV95 = 48 (OPAL95 opacities, LL95TBL), IALEX06 = 90 (the low-temperature opacities of Ferguson et al. 2005, called ALEX06 in the code, READALEX06), IOPUREZ = 62 (the pure-metal, "pure Z," LAOL89 table, $Z = 1$; PARMIN's comment calls it "pure CN"; RDZLAOL), IcondOpacP = 75 (Potekhin conductive opacities, CONDOPACP), IOPALE = 49 (OPAL 2006 equation of state, READCOEOS06), ISCVH, ISCVHE, ISCVZ = 72, 73, 74 (the SCV equation of state, SETUPS).
IJLAST: the unit to which WRTOUT writes the model with LJLAST (acoustic-depth output, wrtout.f, lines 710–715 ↗), but assigned nowhere (PARMIN's assignment is commented out, parmin.f, lines 847–849 ↗; bug 1); the branch never runs, since LACOUT cannot be turned on (see ACDPTH_MOD).

Design

A blanket USE IOUNITS_MOD. Unit numbers are fixed in PARMIN rather than allocated, so a new file must pick a free number by hand (ISOUND's 500 stands apart).

Suspected bugs, checked by running the code

Each bug is marked by what running the code showed: (changes results, large) or (small), the fix moving a run clearly beyond a null change; (stops the run); (wrong output), the fix changing only what is written; (harmless in the runs), within the noise; (never occurred), the code ran but the fault did not; (not reached); (cannot be reached), a guard prevents it; (withdrawn), the suspicion was wrong.

1. (cannot be reached) `IJLAST` is never assigned.

(line 42 ↗; wrtout.f, lines 710–715 ↗, parmin.f, lines 847–849 ↗) WRTOUT writes the last model to unit IJLAST when LJLAST is true, but no routine gives IJLAST a number or opens its file: PARMIN's three lines that did (IJLAST = 93, the file name, the OPEN) are commented out. If the branch ran, the model would go to unit 0 (with gfortran, standard error). It does not run today: LJLAST is set true only in the main program's acoustic-depth branch (main.f, line 651 ↗), and LACOUT cannot be turned on (see ACDPTH_MOD).

A possible fix, a choice for the developers: restore PARMIN's three lines beside ICLCD, or remove IJLAST together with WRTOUT's LJLAST branch.

Checked by running YREC (Nov 9, 2026; a line added at each suspected path counted how often it was taken, the outputs otherwise unchanged): Not reached in 33 runs, and it cannot be reached at 7be4133: LJLAST is set only in the main program's LACOUT branch, and LACOUT is in no namelist group and set nowhere in src/ (acdpth_mod.f, line 55 ↗). The fix (PARMIN's three lines restored) was not run. Intent: The three lines are commented out beside PARMIN's comment of 9/25/26 that removed other unit reservations as "declared but never opened anywhere" (parmin.f, lines 844–849 ↗), so the unit may have been dropped with them.

Definitions

moduleIOUNITS_MOD

lines 19–54 · GitHub

Used by (65 units)

(file level), ALEX06TAB, ALFILEIN, ALPRINT, ALSURFP, ALTABINIT, BSSTEP, CALCAD, CHECKC, CHECKJ, CHKCAL, CHKSCAL, CONDOPACP, CONVEC, COWIND, CRRECT, ENVINT, EQRELV, EQSAHA, EQSTAT2, ESAC06, GETOPAC, GETOPAL95, GETQUA, GRSETT, GTPURZ, HPOINT, KCSURFP, KEMCOM, KSPLINT, LIBURN, LL95TBL, MICRODIFF_RUN, MICRODIFF_SETUP, MIX, OEQOS06, OVERSH, PARMIN, PDIST, POLINT, PUTSTORE, RDZLAOL, READALEX06, READCOEOS06, ROTMIX, RSCALE, SCONVEC, SECULR, SETSCAL, SETUPS, SETUP_GRSETT, SPLINT, SPLINTD2, STARIN, STITCH, SURFBC, SURFP, T6RINTEOS06, TPGRAD, WIND, WRTHEAD, WRTLST, WRTMIL, WRTMOD, WRTOUT

Change log

The changes since rp_1

Changed since rp_1. New file: the unit numbers of ten COMMON blocks, and of /IOUNITS/ into which they were merged, as one module; the dead units IDYN, ILLDAT, ISCOMP, IKUR (and PARMIN's unshared ILSTBN, ISTOBN, IFSTBN) removed.

1C 2C 3C$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 4C IOUNITS_MOD 5C$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 6C 10/14/26 MHP via Claude 7C code changed to convert COMMON/IOUNITS/ into this module. 8C 9C Imported with a blanket USE, the convention for the conversion. 10C All 58 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 IOUNITS_MOD 20 21 IMPLICIT NONE 22 SAVE 23 24 INTEGER*4 :: ILAST 25 INTEGER*4 :: IDEBUG 26 INTEGER*4 :: ITRACK 27 INTEGER*4 :: ISHORT 28 INTEGER*4 :: IMILNE 29 INTEGER*4 :: IMODPT 30 INTEGER*4 :: ISTOR 31 INTEGER*4 :: IOWR 32 INTEGER*4 :: IFIRST 33 INTEGER*4 :: IRUN 34 INTEGER*4 :: ISTAND 35 INTEGER*4 :: IFERMI 36 INTEGER*4 :: IOPMOD 37 INTEGER*4 :: IOPENV 38 INTEGER*4 :: IOPATM 39 INTEGER*4 :: ISNU 40 INTEGER*4 :: IALEX06 41 INTEGER*4 :: ICLCD 42 INTEGER*4 :: IJLAST 43 INTEGER*4 :: IOPUREZ 44 INTEGER*4 :: IcondOpacP 45 INTEGER*4 :: ILIV95 46 INTEGER*4 :: IOATM 47 INTEGER*4 :: IOATMA 48 INTEGER*4 :: IOPALE 49 INTEGER*4 :: ISCVH 50 INTEGER*4 :: ISCVHE 51 INTEGER*4 :: ISCVZ 52 INTEGER*4 :: ISOUND 53 54 END MODULE IOUNITS_MOD

1"""Python version of iounits_mod.f (YREC 7be4133): the logical unit numbers 2of every file, formerly COMMON/IOUNITS/ (and before it /LUOUT/, /LUNUM/ 3and eight other blocks). 4 5Translates: iounits_mod.f#IOUNITS_MOD (7be4133) 6 7Module-level names, as in the Fortran module, in lower case (all INTEGER*4; 8parmin assigns them). Routines that USE IOUNITS_MOD import this module and 9write ``iounits_mod.<name>``. 10 11The functions below are not in the Fortran module: they stand in for 12Fortran's own I/O statements (OPEN, CLOSE, REWIND, READ, WRITE on a unit), 13so that every translated routine does its I/O the same way. Records are 14lines of text; FORMATs are applied by the callers. 15""" 16 17import builtins 18import os 19import sys 20 21# The unit numbers (Fortran lines 24–52). 22ilast = 0 # last model (11) 23idebug = 0 # debugging output (18) 24itrack = 0 # track (19) 25ishort = 0 # diagnostic output, the .short file (20) 26imilne = 0 # Milne invariant variables (21) 27imodpt = 0 # shell-by-shell output (22) 28istor = 0 # saved models (23) 29iowr = 0 # status output, the screen (6; main sets 9 first) 30ifirst = 0 # starting model (12) 31irun = 0 # PHYSICS namelist (13) 32istand = 0 # CONTROL namelist (14) 33ifermi = 0 # Fermi-Dirac tables (15) 34iopmod = 0 # pulsation output, interior (24) 35iopenv = 0 # pulsation output, envelope (25) 36iopatm = 0 # pulsation output, atmosphere (26) 37isnu = 0 # neutrino fluxes (33) 38ialex06 = 0 # Alexander 2006 opacities (90) 39iclcd = 0 # acoustic-depth output (91, only with lacout) 40# Suspected bug (see the page): ijlast is never assigned. 41ijlast = 0 # used by wrtout (ljlast), assigned nowhere 42iopurez = 0 # pure-CN opacities (62) 43icondopacp = 0 # Potekhin conductive opacities (75); IcondOpacP 44iliv95 = 0 # OPAL95 opacities (48) 45ioatm = 0 # Kurucz atmospheres (38) 46ioatma = 0 # Allard atmospheres (66) 47iopale = 0 # OPAL 2006 EOS (49) 48iscvh = 0 # SCV EOS, hydrogen (72) 49iscvhe = 0 # SCV EOS, helium (73) 50iscvz = 0 # SCV EOS, metals (74) 51isound = 0 # sound-speed profile (500) 52 53 54# --- Stand-ins for Fortran I/O (Python only) ------------------------------- 55 56_units = {} # unit number -> open text file 57 58 59def open(unit, name, status='UNKNOWN', form='FORMATTED', access='SEQUENTIAL'): 60 """OPEN(unit, FILE=name, STATUS=status): connect a unit to a file. 61 62 status is Fortran's: 'OLD' (must exist), 'NEW' (must not exist), 63 'REPLACE', 'SCRATCH' or 'UNKNOWN' (kept if it exists, positioned at its 64 start). form and access are accepted and ignored (formatted, sequential). 65 66 """ 67 68 close(unit) 69 name = str(name).strip() 70 status = status.upper() 71 if status == 'OLD': 72 mode = 'r+' if os.access(name, os.W_OK) else 'r' 73 elif status == 'NEW': 74 mode = 'x+' 75 elif status in ('REPLACE', 'SCRATCH'): 76 mode = 'w+' 77 else: # UNKNOWN 78 mode = 'r+' if os.path.exists(name) else 'w+' 79 _units[unit] = builtins.open(name, mode) 80 81 82def _file(unit): 83 """The file of a unit, connecting an unopened unit to fort.<unit> as 84 Fortran does.""" 85 86 if unit not in _units: 87 open(unit, f'fort.{unit}') 88 return _units[unit] 89 90 91def close(unit): 92 """CLOSE(unit).""" 93 94 f = _units.pop(unit, None) 95 if f is not None: 96 f.close() 97 98 99def rewind(unit): 100 """REWIND(unit).""" 101 102 if unit in _units: 103 _units[unit].seek(0) 104 105 106def read(unit): 107 """READ(unit, ...): the next record as a string, without its newline, 108 or None at the end of the file (Fortran's END= branch). Unit 5 is 109 standard input.""" 110 111 if unit == 5: 112 line = sys.stdin.readline() 113 else: 114 line = _file(unit).readline() 115 if line == '': 116 return None 117 return line.rstrip('\n') 118 119 120def write(unit, text): 121 """WRITE(unit, ...): write text as one or more records. Units 6 and '*' 122 are the screen. As in a sequential file, what follows the record just 123 written is cut off.""" 124 125 if unit in (6, '*') and unit not in _units: 126 print(text) 127 return 128 f = _file(unit) 129 f.write(f'{text}\n') 130 f.truncate() 131 f.flush()