Skip to content

fix(codegen): fix recarray variable docstring rendering#2614

Merged
wpbonelli merged 3 commits into
modflowpy:developfrom
wpbonelli:fix-2599
Sep 28, 2025
Merged

fix(codegen): fix recarray variable docstring rendering#2614
wpbonelli merged 3 commits into
modflowpy:developfrom
wpbonelli:fix-2599

Conversation

@wpbonelli
Copy link
Copy Markdown
Member

@wpbonelli wpbonelli commented Sep 28, 2025

Fix #2599. Recarray columns were missing. Now mfgwegwe.py looks OK. Hopefully didn't break anything else

exchangedata : [(cellidm1, cellidm2, ihc, cl1, cl2, hwva, aux, boundname)]
        * cellidm1 : integer
                is the cellid of the cell in model 1 as specified in the simulation name file.
                For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row,
                and column numbers of the cell.   For a grid that uses the DISV input file,
                CELLIDM1 is the layer number and CELL2D number for the two cells.  If the model
                uses the unstructured discretization (DISU) input file, then CELLIDM1 is the
                node number for the cell.
        * cellidm2 : integer
                is the cellid of the cell in model 2 as specified in the simulation name file.
                For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row,
                and column numbers of the cell.   For a grid that uses the DISV input file,
                CELLIDM2 is the layer number and CELL2D number for the two cells.  If the model
                uses the unstructured discretization (DISU) input file, then CELLIDM2 is the
                node number for the cell.
        * ihc : integer
                is an integer flag indicating the direction between node n and all of its m
                connections. If IHC = 0 then the connection is vertical.  If IHC = 1 then the
                connection is horizontal. If IHC = 2 then the connection is horizontal for a
                vertically staggered grid.
        * cl1 : double precision
                is the distance between the center of cell 1 and the its shared face with cell
                2.
        * cl2 : double precision
                is the distance between the center of cell 2 and the its shared face with cell
                1.
        * hwva : double precision
                is the horizontal width of the flow connection between cell 1 and cell 2 if IHC
                > 0, or it is the area perpendicular to flow of the vertical connection between
                cell 1 and cell 2 if IHC = 0.
        * aux : [double precision]
                represents the values of the auxiliary variables for each GWEGWE Exchange. The
                values of auxiliary variables must be present for each exchange. The values
                must be specified in the order of the auxiliary variables specified in the
                OPTIONS block.
        * boundname : string
                name of the GWE Exchange cell.  BOUNDNAME is an ASCII character variable that
                can contain as many as 40 characters.  If BOUNDNAME contains spaces in it, then
                the entire name must be enclosed within single quotes.

@wpbonelli wpbonelli added this to the 3.9.4 milestone Sep 28, 2025
@wpbonelli wpbonelli added the bug label Sep 28, 2025
@wpbonelli wpbonelli marked this pull request as ready for review September 28, 2025 20:12
@codecov
Copy link
Copy Markdown

codecov Bot commented Sep 28, 2025

Codecov Report

❌ Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 72.5%. Comparing base (556c088) to head (9f18171).
⚠️ Report is 52 commits behind head on develop.

Files with missing lines Patch % Lines
flopy/mf6/utils/codegen/filters.py 0.0% 3 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2614      +/-   ##
===========================================
+ Coverage     55.5%    72.5%   +17.0%     
===========================================
  Files          644      667      +23     
  Lines       124135   128860    +4725     
===========================================
+ Hits         68947    93487   +24540     
+ Misses       55188    35373   -19815     
Files with missing lines Coverage Δ
flopy/mf6/utils/codegen/filters.py 0.0% <0.0%> (ø)

... and 553 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@mwtoews mwtoews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rendering the docs locally, I see that are improved! I don't see any reason why "items" is still used, since this is not part of the present structure. Unless there was some transition?

Comment thread flopy/mf6/utils/codegen/filters.py Outdated
Comment on lines 215 to 217
if items:
assert _type == "recarray"
return items
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This block is stale (never touched) since there is no "items"

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, no reason to keep this defensively I guess. We pinned devtools anyway

@wpbonelli wpbonelli merged commit b15fa87 into modflowpy:develop Sep 28, 2025
19 checks passed
@wpbonelli wpbonelli deleted the fix-2599 branch September 28, 2025 23:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug: incomplete mf6 docs

2 participants