FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
Review issues — fhsim_environment

Findings from code review that await an owner decision or an implementation. Each row is one file in issues/details/, which holds the evidence, the effect, the possible fix, the test that would prove it and the risk. Resolved issues are kept in issues/resolved/ so that their numbers are never reused. Issues that concern a SimObject are also shown on that model's documentation page. Audit notes that are not issues are in issues/notes.md.

How to work an item

  1. Reproduce the Evidence at the file:line given in the detail file, at HEAD.
  2. For a blocked item, get the owner's answer to "Decision needed" first, then set Status to ready.
  3. Write the proving test, apply the fix, check the Risk paragraph.
  4. git mv the file to issues/resolved/, add a | Resolved | <commit>, <date> | row, delete the matching \xrefitem reviewissue "Review issues" "Review issues" \ref fhsim_environment_issue_<ID> lines from the headers, rerun the script and commit it all together.

New issue: add issues/details/<slug>.md with the metadata table but no ID row; the script assigns the next free number, writes the heading and renames the file to <TAG>-<ID>-<slug>.md.

Legend

Tag Values
Class BUG code does something other than its documentation or sibling code says; KNOWN-LIMITATION behaviour gap by design or omission, document rather than fix silently; ARCHITECTURE structure, dependencies, build layout, dead code and stale artefacts; DOCUMENTATION missing or wrong documentation or example; TEST test coverage or infrastructure; API public name (port, state, parameter, registration string) whose change breaks input files; SECURITY credentials and supply chain
Severity 3 wrong numbers, a crash or a secret exposure reaches a user; 2 a documented interface does not work as documented; 1 tidiness, readers and tools only
Status blocked needs the owner decision named in the file; ready fully specified

Open issues (0)

| ID | Class | Severity | Status | Models | Title | |—|—|—|—|—|—|

Resolved issues (17)

ID Class Title Resolved File
ENV-0001 TEST No test carries the _NEEDS_GUI suffix the ctest filter excludes 7996618, 2026-09-16 resolved/ENV-0001-needs-gui-ctest-filter-matches-nothing.md
ENV-0002 DOCUMENTATION Waves.Hs documented default is 4, the code default is 1.0 8604406, 2026-09-15 resolved/ENV-0002-waves-hs-documented-default-is-4.md
ENV-0003 BUG Visual.WorldRadius documented default is 3000, the effective default is 1000 8604406, 2026-09-15 resolved/ENV-0003-visual-worldradius-documented-default-is-3000.md
ENV-0004 DOCUMENTATION Visual.Sky documented default Clear is not an accepted value 8604406, 2026-09-15 resolved/ENV-0004-visual-sky-documented-default-clear.md
ENV-0005 DOCUMENTATION Visual.Vertices documented default is 100, 100, the code default is 100, 130 8604406, 2026-09-15 resolved/ENV-0005-visual-vertices-documented-default-is-100.md
ENV-0006 DOCUMENTATION Waves.Spectrum documents the value Component; the code accepts Components 8604406, 2026-09-15 resolved/ENV-0006-waves-spectrum-documents-the-value-component.md
ENV-0007 DOCUMENTATION Waves.Theory is documented with a default but read as a mandatory parameter 8604406, 2026-09-15 resolved/ENV-0007-waves-theory-is-documented.md
ENV-0008 DOCUMENTATION Waves.OmegaNormalizedMax description says "Lower", and the silent 0.5 floor is undocumented 8604406, 2026-09-15 resolved/ENV-0008-waves-omeganormalizedmax-description-says-lower.md
ENV-0009 DOCUMENTATION Three VisualFlowPlane range defaults do not match the code b6b6d36, 2026-09-15 resolved/ENV-0009-three-visualflowplane-range-defaults.md
ENV-0010 DOCUMENTATION CNetCDFField documents NetcdfFile but reads the mandatory NetCDFFileName de2ab83, 2026-09-15 resolved/ENV-0010-cnetcdffield-documents-netcdffile-but-reads.md
ENV-0011 BUG CNetCDFField unconditionally writes a debug text file at construction 498cbd6, 2026-09-16 resolved/ENV-0011-netcdffield-writes-debug-file-unconditionally.md
ENV-0012 DOCUMENTATION Current.Vector is read but undocumented 8604406, 2026-09-15 resolved/ENV-0012-current-vector-is-read-but-undocumented.md
ENV-0013 ARCHITECTURE NETCDFCPP_AVAILABLE is defined unconditionally, so the documented condition and the fallback branch are dead f15bebc, 2026-09-16 resolved/ENV-0013-netcdfcpp-available-defined-unconditionally.md
ENV-0014 ARCHITECTURE TestDynamicWaves prints the whole parameter status map to stdout 154f0a3, 2026-09-15 resolved/ENV-0014-testdynamicwaves-prints-the-whole-parameter-status.md
ENV-0015 DOCUMENTATION NetCdfSeafloor.SeabedMaterial is read but undocumented a0f188d, 2026-09-15 resolved/ENV-0015-netcdfseafloor-seabedmaterial-is-read-but-undocumented.md
ENV-0016 DOCUMENTATION Two OpenWiki claims no longer match the source 4151209, 2026-09-15 resolved/ENV-0016-two-openwiki-claims-no-longer-match.md
ENV-0017 KNOWN-LIMITATION VisualFlowPlane.ComputeFunction silently falls back on an unrecognised value 50c4576, 2026-09-16 resolved/ENV-0017-visualflowplane-computefunction-silent-fallback.md