Skip to content

Commit c6af83b

Browse files
authored
docs(prt-fmi): clarify only required when post-processing (#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
1 parent 849578f commit c6af83b

File tree

4 files changed

+17
-15
lines changed

4 files changed

+17
-15
lines changed

autotest/test_prt_exg.py

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -108,15 +108,17 @@ def build_mf6_sim(idx, test):
108108
trackcsv_filerecord=[prt_track_csv_file],
109109
)
110110

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

121123
# create exchange
122124
gwf_name = get_model_name(idx, "gwf")

doc/mf6io/gwe/fmi.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
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.
1+
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.
22

3-
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:
3+
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:
44

55
\begin{itemize}
66

doc/mf6io/gwt/fmi.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
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.
1+
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.
22

3-
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:
3+
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:
44

55
\begin{itemize}
66

doc/mf6io/prt/fmi.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
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.
1+
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.
22

3-
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:
3+
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:
44

55
\begin{itemize}
66

0 commit comments

Comments
 (0)