-
Notifications
You must be signed in to change notification settings - Fork 317
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(CellBudget): add support for full3D keyword (#1254)
- Loading branch information
1 parent
844c216
commit 45df13a
Showing
18 changed files
with
355 additions
and
112 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,205 @@ | ||
| import os | ||
| import sys | ||
| import shutil | ||
|
|
||
| import numpy as np | ||
| import flopy | ||
|
|
||
| ex_pths = ( | ||
| os.path.join("..", "examples", "data", "freyberg"), | ||
| os.path.join("..", "examples", "data", "mf6-freyberg"), | ||
| os.path.join("..", "examples", "data", "mf6", "test003_gwfs_disv"), | ||
| os.path.join("..", "examples", "data", "mf6", "test003_gwftri_disv"), | ||
| ) | ||
| ismf6_lst = ["mf6" in pth for pth in ex_pths] | ||
| names = [os.path.basename(pth) for pth in ex_pths] | ||
|
|
||
| tpth = os.path.join("temp", "t079") | ||
| # delete the directory if it exists | ||
| if os.path.isdir(tpth): | ||
| shutil.rmtree(tpth) | ||
| # make the directory | ||
| os.makedirs(tpth) | ||
|
|
||
| mf6_exe = "mf6" | ||
| mf2005_exe = "mf2005" | ||
| if sys.platform == "win32": | ||
| mf6_exe += ".exe" | ||
| mf2005_exe += ".exe" | ||
|
|
||
|
|
||
| def load_mf2005(name, ws_in): | ||
| name_file = f"{name}.nam" | ||
| ml = flopy.modflow.Modflow.load( | ||
| name_file, | ||
| model_ws=ws_in, | ||
| exe_name=mf2005_exe, | ||
| check=False, | ||
| ) | ||
|
|
||
| # change work space | ||
| ws_out = os.path.join(tpth, name) | ||
| ml.change_model_ws(ws_out) | ||
|
|
||
| # save all budget data to a cell-by cell file | ||
| oc = ml.get_package("OC") | ||
| oc.reset_budgetunit() | ||
| oc.stress_period_data = {(0, 0): ["save budget"]} | ||
|
|
||
| return ml | ||
|
|
||
|
|
||
| def load_mf6(name, ws_in): | ||
| sim = flopy.mf6.MFSimulation.load( | ||
| sim_name=name, | ||
| exe_name=mf6_exe, | ||
| sim_ws=ws_in, | ||
| ) | ||
|
|
||
| # change work space | ||
| ws_out = os.path.join(tpth, name) | ||
| sim.set_sim_path(ws_out) | ||
|
|
||
| # get the groundwater flow model(s) and redefine the output control | ||
| # file to save cell by cell output | ||
| models = sim.model_names | ||
| for model in models: | ||
| gwf = sim.get_model(model) | ||
| gwf.name_file.save_flows = True | ||
|
|
||
| gwf.remove_package("oc") | ||
| budget_filerecord = f"{model}.cbc" | ||
| oc = flopy.mf6.ModflowGwfoc( | ||
| gwf, | ||
| budget_filerecord=budget_filerecord, | ||
| saverecord=[("BUDGET", "ALL")], | ||
| ) | ||
|
|
||
| return sim | ||
|
|
||
|
|
||
| def cbc_eval_size(cbcobj, nnodes, shape3d): | ||
| cbc_pth = cbcobj.filename | ||
|
|
||
| assert cbcobj.nnodes == nnodes, ( | ||
| f"{cbc_pth} nnodes ({cbcobj.nnodes}) " f"does not equal {nnodes}" | ||
| ) | ||
| a = np.squeeze(np.ones(cbcobj.shape, dtype=float)) | ||
| b = np.squeeze(np.ones(shape3d, dtype=float)) | ||
| assert a.shape == b.shape, ( | ||
| f"{cbc_pth} shape {cbcobj.shape} " f"does not conform to {shape3d}" | ||
| ) | ||
|
|
||
|
|
||
| def cbc_eval_data(cbcobj, shape3d): | ||
| cbc_pth = cbcobj.filename | ||
| print(f"{cbc_pth}:\n") | ||
| cbcobj.list_unique_records() | ||
|
|
||
| names = cbcobj.get_unique_record_names(decode=True) | ||
| times = cbcobj.get_times() | ||
| for name in names: | ||
| text = name.strip() | ||
| arr = np.squeeze( | ||
| cbcobj.get_data(text=text, totim=times[0], full3D=True)[0] | ||
| ) | ||
| if text != "FLOW-JA-FACE": | ||
| b = np.squeeze(np.ones(shape3d, dtype=float)) | ||
| assert arr.shape == b.shape, ( | ||
| f"{cbc_pth} shape {arr.shape} for '{text}' budget item " | ||
| f"does not conform to {shape3d}" | ||
| ) | ||
|
|
||
|
|
||
| def cbc_eval(cbcobj, nnodes, shape3d, modelgrid): | ||
| cbc_pth = cbcobj.filename | ||
| cbc_eval_size(cbcobj, nnodes, shape3d) | ||
| cbc_eval_data(cbcobj, shape3d) | ||
| cbcobj.close() | ||
|
|
||
| cobj_mg = flopy.utils.CellBudgetFile( | ||
| cbc_pth, | ||
| modelgrid=modelgrid, | ||
| verbose=True, | ||
| ) | ||
| cbc_eval_size(cobj_mg, nnodes, shape3d) | ||
| cbc_eval_data(cobj_mg, shape3d) | ||
| cobj_mg.close() | ||
|
|
||
| return | ||
|
|
||
|
|
||
| def clean_run(name): | ||
| ws = os.path.join(tpth, name) | ||
| if os.path.isdir(ws): | ||
| shutil.rmtree(ws) | ||
|
|
||
|
|
||
| def mf6_eval(name, ws_in): | ||
|
|
||
| sim = load_mf6(name, ws_in) | ||
|
|
||
| # write the simulation | ||
| sim.write_simulation() | ||
|
|
||
| # run the simulation | ||
| sim.run_simulation() | ||
|
|
||
| # get the groundwater model and determine the size of the model grid | ||
| gwf_name = list(sim.model_names)[0] | ||
| gwf = sim.get_model(gwf_name) | ||
| nnodes, shape3d = gwf.modelgrid.nnodes, gwf.modelgrid.shape | ||
|
|
||
| # get the cell by cell object | ||
| cbc = gwf.output.budget() | ||
|
|
||
| # evaluate the full3D option | ||
| cbc_eval(cbc, nnodes, shape3d, gwf.modelgrid) | ||
|
|
||
| # clean the run | ||
| clean_run(name) | ||
|
|
||
| return | ||
|
|
||
|
|
||
| def mf2005_eval(name, ws_in): | ||
| ml = load_mf2005(name, ws_in) | ||
|
|
||
| # write the model | ||
| ml.write_input() | ||
|
|
||
| # run the model | ||
| ml.run_model() | ||
|
|
||
| # determine the size of the model grid | ||
| nnodes, shape3d = ml.modelgrid.nnodes, ml.modelgrid.shape | ||
|
|
||
| # get the cell by cell object | ||
| fpth = os.path.join(tpth, name, f"{name}.cbc") | ||
| cbc = flopy.utils.CellBudgetFile(fpth) | ||
|
|
||
| # evaluate the full3D option | ||
| cbc_eval(cbc, nnodes, shape3d, ml.modelgrid) | ||
|
|
||
| # clean the run | ||
| clean_run(name) | ||
|
|
||
|
|
||
| def test_cbc_full3D(): | ||
| for (name, ismf6, ws_in) in zip(names, ismf6_lst, ex_pths): | ||
| if ismf6: | ||
| yield mf6_eval, name, ws_in | ||
| else: | ||
| yield mf2005_eval, name, ws_in | ||
|
|
||
|
|
||
| def main(): | ||
| for (name, ismf6, ws_in) in zip(names, ismf6_lst, ex_pths): | ||
| if ismf6: | ||
| mf6_eval(name, ws_in) | ||
| else: | ||
| mf2005_eval(name, ws_in) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| main() |
Oops, something went wrong.