Skip to content

Commit

Permalink
docs(prt-fmi): clarify only required when post-processing (MODFLOW-US…
Browse files Browse the repository at this point in the history
…GS#2151)

The first paragraph in the fmi sections of mf6io could be read to indicate that the fmi file is always required. Clarify that the file is only required when the corresponding model is run as a post-processor to the flow model. Also update a prt test to make sure the head/budget file paths provided via fmi are ignored when the simulation uses an exchange
  • Loading branch information
wpbonelli authored Jan 20, 2025
1 parent 849578f commit c6af83b
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 15 deletions.
20 changes: 11 additions & 9 deletions autotest/test_prt_exg.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,15 +108,17 @@ def build_mf6_sim(idx, test):
trackcsv_filerecord=[prt_track_csv_file],
)

# create a flow model interface
# todo Mike Fienen's report (crash when FMI created but not needed)
# flopy.mf6.ModflowPrtfmi(
# prt,
# packagedata=[
# ("GWFHEAD", gwf_head_file),
# ("GWFBUDGET", gwf_budget_file),
# ],
# )
# create a flow model interface. should be ignored.
# Mike Fienen reported that an early version of PRT
# crashed if FMI is provided when using an exchange.
flopy.mf6.ModflowPrtfmi(
prt,
packagedata=[
# garbage paths
("GWFHEAD", "heads.hds"),
("GWFBUDGET", "budget.cbc"),
],
)

# create exchange
gwf_name = get_model_name(idx, "gwf")
Expand Down
4 changes: 2 additions & 2 deletions doc/mf6io/gwe/fmi.tex
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Flow Model Interface (FMI) Package information is read from the file that is specified by ``FMI6'' as the file type. The FMI Package is optional, but if provided, only one FMI Package can be specified for a GWE model.
Flow Model Interface (FMI) Package information is read from the file that is specified by ``FMI6'' as the file type. The FMI Package file is required only if the GWE Model is running in a separate simulation from a previously run GWF Model. If the GWE Model is coupled to a GWF Model by an exchange, the FMI Package file is not required. Only one FMI Package can be specified for a GWE model.

For most simulations, the GWE Model needs groundwater flows for every cell in the model grid, for all boundary conditions, and for other terms, such as the flow of water in or out of storage. The FMI Package is the interface between the GWE Model and simulated groundwater flows provided by a corresponding GWF Model that is running concurrently within the simulation or from binary budget files that were created from a previous GWF model run. The following are several different FMI simulation cases:
The GWE Model needs groundwater flows for model grid cells, for boundary conditions, and for other terms, such as the flow of water in or out of storage. The FMI Package is the interface between the GWE Model and simulated groundwater flows provided by a corresponding GWF Model that is running concurrently within the simulation or from binary budget files that were created from a previous GWF model run. The following are several different FMI simulation cases:

\begin{itemize}

Expand Down
4 changes: 2 additions & 2 deletions doc/mf6io/gwt/fmi.tex
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Flow Model Interface (FMI) Package information is read from the file that is specified by ``FMI6'' as the file type. The FMI Package is optional, but if provided, only one FMI Package can be specified for a GWT model.
Flow Model Interface (FMI) Package information is read from the file that is specified by ``FMI6'' as the file type. The FMI Package file is required only if the GWT Model is running in a separate simulation from a previously run GWF Model. If the GWT Model is coupled to a GWF Model by an exchange, the FMI Package file is not required. Only one FMI Package can be specified for a GWT model.

For most simulations, the GWT Model needs groundwater flows for every cell in the model grid, for all boundary conditions, and for other terms, such as the flow of water in or out of storage. The FMI Package is the interface between the GWT Model and simulated groundwater flows provided by a corresponding GWF Model that is running concurrently within the simulation or from binary budget files that were created from a previous GWF model run. The following are several different FMI simulation cases:
The GWT Model needs groundwater flows for model grid cells, for boundary conditions, and for other terms, such as the flow of water in or out of storage. The FMI Package is the interface between the GWT Model and simulated groundwater flows provided by a corresponding GWF Model that is running concurrently within the simulation or from binary budget files that were created from a previous GWF model run. The following are several different FMI simulation cases:

\begin{itemize}

Expand Down
4 changes: 2 additions & 2 deletions doc/mf6io/prt/fmi.tex
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Flow Model Interface (FMI) Package information is read from the file that is specified by ``FMI6'' as the file type. The FMI Package is required, and only one FMI Package can be specified for a PRT model.
Flow Model Interface (FMI) Package information is read from the file that is specified by ``FMI6'' as the file type. The FMI Package file is required only if the PRT Model is running in a separate simulation from a previously run GWF Model. If the PRT Model is coupled to a GWF Model by an exchange, the FMI Package file is not required. Only one FMI Package can be specified for a PRT model.

For most simulations, the PRT Model needs groundwater flows for every cell in the model grid, for all boundary conditions, and for other terms, such as the flow of water in or out of storage. The FMI Package is the interface between the PRT Model and simulated groundwater flows provided by a corresponding GWF Model that is running concurrently within the simulation or from binary budget files that were created from a previous GWF model run. The following are several different FMI simulation cases:
The PRT Model needs groundwater flows for model grid cells, for boundary conditions, and for other terms, such as the flow of water in or out of storage. The FMI Package is the interface between the PRT Model and simulated groundwater flows provided by a corresponding GWF Model that is running concurrently within the simulation or from binary budget files that were created from a previous GWF model run. The following are several different FMI simulation cases:

\begin{itemize}

Expand Down

0 comments on commit c6af83b

Please sign in to comment.