Skip to content

docs(UcnFile): mention MODFLOW 6 GWT concentration file support #2865

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TameTheGame wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs(UcnFile): mention MODFLOW 6 GWT concentration file support #2865

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions flopy/utils/binaryfile/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

* HeadFile (Binary head file. Can also be used for drawdown)
* HeadUFile (Binary MODFLOW-USG unstructured head file)
* UcnFile (Binary concentration file from MT3DMS)
* UcnFile (Binary concentration file from MT3DMS or MODFLOW 6 GWT)
* CellBudgetFile (Binary cell-by-cell flow file)

"""
Expand Down Expand Up @@ -1321,8 +1321,9 @@ class UcnFile(BinaryLayerFile):
Notes
-----
The UcnFile class provides simple ways to retrieve 2d and 3d
concentration arrays from a MT3D binary head file and time series
arrays for one or more cells.
concentration arrays from an MT3D or MODFLOW 6 GWT binary
concentration file and time series arrays for one or more cells.
The file type is detected from the first record header.

The BinaryLayerFile class is built on a record array consisting of
headers, which are record arrays of the modflow header information
Expand All @@ -1338,6 +1339,9 @@ class UcnFile(BinaryLayerFile):
>>> ucnobj.headers
>>> rec = ucnobj.get_data(kstpkper=(0, 0))

>>> gwtobj = bf.UcnFile('gwt.ucn') # MODFLOW 6 GWT concentration file
>>> conc = gwtobj.get_alldata()

"""

def __init__(
Expand Down
Loading