├── .Rbuildignore ├── .gitignore ├── DESCRIPTION ├── NAMESPACE ├── NEWS.md ├── R ├── RMODFLOW.R ├── animate.R ├── examples.R ├── execute.R ├── imports.R ├── install.R ├── internals.R ├── modflow.R ├── output.R ├── package-bas.R ├── package-bcf.R ├── package-chd.R ├── package-de4.R ├── package-dis.R ├── package-drn.R ├── package-evt.R ├── package-ghb.R ├── package-gmg.R ├── package-hfb.R ├── package-hob.R ├── package-huf.R ├── package-lmt.R ├── package-lpf.R ├── package-mlt.R ├── package-nam.R ├── package-nwt.R ├── package-oc.R ├── package-pcg.R ├── package-pval.R ├── package-rch.R ├── package-riv.R ├── package-sip.R ├── package-upw.R ├── package-wel.R ├── package-zon.R ├── plot.R ├── print.R ├── spatial.R ├── sysdata.rda ├── ui.R ├── utils.R ├── vtk.R ├── web.R └── zzz.R ├── README.Rmd ├── README.md ├── RMODFLOW.Rproj ├── _pkgdown.yml ├── data-raw └── data-raw.R ├── docs ├── 404.html ├── articles │ ├── RMODFLOW.html │ ├── RMODFLOW_files │ │ ├── figure-html │ │ │ ├── unnamed-chunk-10-1.png │ │ │ ├── unnamed-chunk-11-1.png │ │ │ ├── unnamed-chunk-12-1.png │ │ │ ├── unnamed-chunk-12-2.png │ │ │ ├── unnamed-chunk-12-3.png │ │ │ ├── unnamed-chunk-13-1.png │ │ │ ├── unnamed-chunk-14-1.png │ │ │ ├── unnamed-chunk-14-2.png │ │ │ ├── unnamed-chunk-14-3.png │ │ │ ├── unnamed-chunk-15-1.png │ │ │ └── unnamed-chunk-17-1.png │ │ └── header-attrs-2.10 │ │ │ └── header-attrs.js │ ├── boundary_conditions.html │ ├── boundary_conditions_files │ │ └── header-attrs-2.10 │ │ │ └── header-attrs.js │ ├── index.html │ ├── input_data_structure.html │ ├── input_data_structure_files │ │ └── header-attrs-2.10 │ │ │ └── header-attrs.js │ ├── output.html │ ├── output_files │ │ ├── figure-html │ │ │ ├── unnamed-chunk-12-1.png │ │ │ ├── unnamed-chunk-12-2.png │ │ │ ├── unnamed-chunk-13-1.png │ │ │ ├── unnamed-chunk-15-1.png │ │ │ ├── unnamed-chunk-16-1.png │ │ │ ├── unnamed-chunk-17-1.png │ │ │ ├── unnamed-chunk-18-1.png │ │ │ ├── unnamed-chunk-18-2.png │ │ │ ├── unnamed-chunk-19-1.png │ │ │ ├── unnamed-chunk-20-1.png │ │ │ ├── unnamed-chunk-21-1.png │ │ │ ├── unnamed-chunk-23-1.png │ │ │ ├── unnamed-chunk-24-1.png │ │ │ ├── unnamed-chunk-25-1.png │ │ │ ├── unnamed-chunk-5-1.png │ │ │ ├── unnamed-chunk-6-1.png │ │ │ ├── unnamed-chunk-6-2.png │ │ │ ├── unnamed-chunk-7-1.png │ │ │ ├── unnamed-chunk-7-2.png │ │ │ ├── unnamed-chunk-8-1.png │ │ │ └── unnamed-chunk-8-2.png │ │ └── header-attrs-2.10 │ │ │ └── header-attrs.js │ ├── parameters.html │ ├── parameters_files │ │ └── header-attrs-2.10 │ │ │ └── header-attrs.js │ ├── plotting.html │ ├── plotting_files │ │ ├── figure-html │ │ │ ├── unnamed-chunk-1-1.png │ │ │ ├── unnamed-chunk-10-1.png │ │ │ ├── unnamed-chunk-10-2.png │ │ │ ├── unnamed-chunk-10-3.png │ │ │ ├── unnamed-chunk-11-1.png │ │ │ ├── unnamed-chunk-11-2.png │ │ │ ├── unnamed-chunk-12-1.png │ │ │ ├── unnamed-chunk-13-1.png │ │ │ ├── unnamed-chunk-13-2.png │ │ │ ├── unnamed-chunk-14-1.png │ │ │ ├── unnamed-chunk-15-1.png │ │ │ ├── unnamed-chunk-15-2.png │ │ │ ├── unnamed-chunk-15-3.png │ │ │ ├── unnamed-chunk-15-4.png │ │ │ ├── unnamed-chunk-16-1.png │ │ │ ├── unnamed-chunk-17-1.png │ │ │ ├── unnamed-chunk-18-1.png │ │ │ ├── unnamed-chunk-2-1.png │ │ │ ├── unnamed-chunk-2-2.png │ │ │ ├── unnamed-chunk-2-3.png │ │ │ ├── unnamed-chunk-20-1.png │ │ │ ├── unnamed-chunk-21-1.png │ │ │ ├── unnamed-chunk-22-1.png │ │ │ ├── unnamed-chunk-22-2.png │ │ │ ├── unnamed-chunk-23-1.png │ │ │ ├── unnamed-chunk-3-1.png │ │ │ ├── unnamed-chunk-4-1.png │ │ │ ├── unnamed-chunk-4-2.png │ │ │ ├── unnamed-chunk-5-1.png │ │ │ ├── unnamed-chunk-5-2.png │ │ │ ├── unnamed-chunk-6-1.png │ │ │ ├── unnamed-chunk-6-2.png │ │ │ ├── unnamed-chunk-6-3.png │ │ │ ├── unnamed-chunk-7-1.png │ │ │ ├── unnamed-chunk-7-2.png │ │ │ ├── unnamed-chunk-8-1.png │ │ │ ├── unnamed-chunk-8-2.png │ │ │ ├── unnamed-chunk-8-3.png │ │ │ ├── unnamed-chunk-9-1.png │ │ │ └── unnamed-chunk-9-2.png │ │ └── header-attrs-2.10 │ │ │ └── header-attrs.js │ ├── spatial.html │ ├── spatial_files │ │ ├── figure-html │ │ │ ├── unnamed-chunk-11-1.png │ │ │ ├── unnamed-chunk-11-2.png │ │ │ ├── unnamed-chunk-12-1.png │ │ │ ├── unnamed-chunk-3-1.png │ │ │ ├── unnamed-chunk-4-1.png │ │ │ ├── unnamed-chunk-6-1.png │ │ │ └── unnamed-chunk-7-1.png │ │ └── header-attrs-2.10 │ │ │ └── header-attrs.js │ ├── top_level.html │ └── top_level_files │ │ └── header-attrs-2.10 │ │ └── header-attrs.js ├── authors.html ├── bootstrap-toc.css ├── bootstrap-toc.js ├── docsearch.css ├── docsearch.js ├── extra.css ├── index.html ├── link.svg ├── news │ └── index.html ├── pkgdown.css ├── pkgdown.js ├── pkgdown.yml ├── reference │ ├── Rplot001.png │ ├── Rplot002.png │ ├── Rplot003.png │ ├── Rplot004.png │ ├── Rplot005.png │ ├── Rplot006.png │ ├── Rplot007.png │ ├── Rplot008.png │ ├── index.html │ ├── plot3d.mf2darray.html │ ├── plot3d.mf3darray.html │ ├── prj_auxiliary.html │ ├── read.array.html │ ├── reexports.html │ ├── rmf_analyze.html │ ├── rmf_animate.html │ ├── rmf_as_array.Raster.html │ ├── rmf_as_array.html │ ├── rmf_as_array.sf.html │ ├── rmf_as_array.stars.html │ ├── rmf_as_list.html │ ├── rmf_as_list.sf-1.png │ ├── rmf_as_list.sf-2.png │ ├── rmf_as_list.sf-3.png │ ├── rmf_as_list.sf-4.png │ ├── rmf_as_list.sf-5.png │ ├── rmf_as_list.sf-6.png │ ├── rmf_as_list.sf-7.png │ ├── rmf_as_list.sf-8.png │ ├── rmf_as_list.sf.html │ ├── rmf_as_list.stars.html │ ├── rmf_as_raster.html │ ├── rmf_as_sf.html │ ├── rmf_as_stars.html │ ├── rmf_as_tibble.html │ ├── rmf_browse.html │ ├── rmf_calculate_array.html │ ├── rmf_calculate_thickness.html │ ├── rmf_cell_coordinates.html │ ├── rmf_cell_dimensions.html │ ├── rmf_cell_info.html │ ├── rmf_convert_bcf_to_lpf.html │ ├── rmf_convert_cbc_to_darcy.html │ ├── rmf_convert_dis_to_saturated_dis.html │ ├── rmf_convert_grid_to_xyz.html │ ├── rmf_convert_hed_to_water_table.html │ ├── rmf_convert_hob_to_locations.html │ ├── rmf_convert_hob_to_time_series.html │ ├── rmf_convert_huf_to_dis.html │ ├── rmf_convert_huf_to_grid.html │ ├── rmf_convert_huf_to_lpf.html │ ├── rmf_convert_huf_to_mask.html │ ├── rmf_convert_ibound_to_neighbours.html │ ├── rmf_convert_id_to_id.html │ ├── rmf_convert_id_to_ijk.html │ ├── rmf_convert_ijk_to_id.html │ ├── rmf_convert_lpf_to_upw.html │ ├── rmf_convert_upw_to_lpf.html │ ├── rmf_convert_xyz_to_grid.html │ ├── rmf_copy_to_wd.html │ ├── rmf_create.html │ ├── rmf_create_array.html │ ├── rmf_create_bas.html │ ├── rmf_create_bcf.html │ ├── rmf_create_chd.html │ ├── rmf_create_de4.html │ ├── rmf_create_dis.html │ ├── rmf_create_drn.html │ ├── rmf_create_evt.html │ ├── rmf_create_ghb.html │ ├── rmf_create_gmg.html │ ├── rmf_create_hfb.html │ ├── rmf_create_hob.html │ ├── rmf_create_huf.html │ ├── rmf_create_kdep.html │ ├── rmf_create_list.html │ ├── rmf_create_lmt.html │ ├── rmf_create_lpf.html │ ├── rmf_create_lvda.html │ ├── rmf_create_mlt.html │ ├── rmf_create_nam.html │ ├── rmf_create_nwt.html │ ├── rmf_create_oc.html │ ├── rmf_create_parameter.default.html │ ├── rmf_create_parameter.html │ ├── rmf_create_parameter.rmf_2d_array.html │ ├── rmf_create_parameter.rmf_3d_array.html │ ├── rmf_create_parameter.rmf_list.html │ ├── rmf_create_pcg.html │ ├── rmf_create_prj.html │ ├── rmf_create_pval.html │ ├── rmf_create_rch.html │ ├── rmf_create_riv.html │ ├── rmf_create_sip.html │ ├── rmf_create_upw.html │ ├── rmf_create_wel.html │ ├── rmf_create_zon.html │ ├── rmf_example.html │ ├── rmf_example_file.html │ ├── rmf_example_files.html │ ├── rmf_example_model.html │ ├── rmf_example_models.html │ ├── rmf_execute.html │ ├── rmf_extent.html │ ├── rmf_gradient.html │ ├── rmf_guide.html │ ├── rmf_install.html │ ├── rmf_interpolate.html │ ├── rmf_optimize.html │ ├── rmf_performance.html │ ├── rmf_plot.bud.html │ ├── rmf_plot.cbc.html │ ├── rmf_plot.chd.html │ ├── rmf_plot.ddn.html │ ├── rmf_plot.drn.html │ ├── rmf_plot.evt.html │ ├── rmf_plot.ghb.html │ ├── rmf_plot.hed.html │ ├── rmf_plot.hfb.html │ ├── rmf_plot.hob.html │ ├── rmf_plot.hpr.html │ ├── rmf_plot.html │ ├── rmf_plot.huf.html │ ├── rmf_plot.modflow-1.png │ ├── rmf_plot.modflow-2.png │ ├── rmf_plot.modflow-3.png │ ├── rmf_plot.modflow-4.png │ ├── rmf_plot.modflow-5.png │ ├── rmf_plot.modflow-6.png │ ├── rmf_plot.modflow-7.png │ ├── rmf_plot.modflow.html │ ├── rmf_plot.rch.html │ ├── rmf_plot.riv.html │ ├── rmf_plot.rmf_2d_array.html │ ├── rmf_plot.rmf_3d_array.html │ ├── rmf_plot.rmf_4d_array.html │ ├── rmf_plot.rmf_analyze.html │ ├── rmf_plot.rmf_list.html │ ├── rmf_plot.wel.html │ ├── rmf_read.html │ ├── rmf_read_array.html │ ├── rmf_read_bas.html │ ├── rmf_read_bcf.html │ ├── rmf_read_bud.html │ ├── rmf_read_cbc.html │ ├── rmf_read_chd.html │ ├── rmf_read_ddn.html │ ├── rmf_read_de4.html │ ├── rmf_read_dis.html │ ├── rmf_read_drn.html │ ├── rmf_read_evt.html │ ├── rmf_read_ghb.html │ ├── rmf_read_gmg.html │ ├── rmf_read_hed.html │ ├── rmf_read_hfb.html │ ├── rmf_read_hob.html │ ├── rmf_read_hpr.html │ ├── rmf_read_huf.html │ ├── rmf_read_kdep.html │ ├── rmf_read_lmt.html │ ├── rmf_read_lpf.html │ ├── rmf_read_lvda.html │ ├── rmf_read_mlt.html │ ├── rmf_read_nam.html │ ├── rmf_read_nwt.html │ ├── rmf_read_oc.html │ ├── rmf_read_pcg.html │ ├── rmf_read_pval.html │ ├── rmf_read_rch.html │ ├── rmf_read_riv.html │ ├── rmf_read_sip.html │ ├── rmf_read_upw.html │ ├── rmf_read_usgs_model_reference.html │ ├── rmf_read_wel.html │ ├── rmf_read_zon.html │ ├── rmf_saturated_thickness.html │ ├── rmf_time_steps.html │ ├── rmf_write.html │ ├── rmf_write_array.html │ ├── rmf_write_bas.html │ ├── rmf_write_bcf.html │ ├── rmf_write_chd.html │ ├── rmf_write_de4.html │ ├── rmf_write_dis.html │ ├── rmf_write_drn.html │ ├── rmf_write_evt.html │ ├── rmf_write_ghb.html │ ├── rmf_write_gmg.html │ ├── rmf_write_hfb.html │ ├── rmf_write_hob.html │ ├── rmf_write_huf.html │ ├── rmf_write_kdep.html │ ├── rmf_write_lmt.html │ ├── rmf_write_lpf.html │ ├── rmf_write_lvda.html │ ├── rmf_write_mlt.html │ ├── rmf_write_nam.html │ ├── rmf_write_nwt.html │ ├── rmf_write_oc.html │ ├── rmf_write_pcg.html │ ├── rmf_write_pval.html │ ├── rmf_write_rch.html │ ├── rmf_write_riv.html │ ├── rmf_write_sip.html │ ├── rmf_write_upw.html │ ├── rmf_write_vtk.html │ ├── rmf_write_wel.html │ ├── rmf_write_zon.html │ ├── rmfi_backup_pval.html │ ├── rmfi_bilinear_intp.html │ ├── rmfi_confining_beds.html │ ├── rmfi_convert_coordinates.html │ ├── rmfi_convert_huf_to_nlay.html │ ├── rmfi_create_bc_array.html │ ├── rmfi_create_bc_list.html │ ├── rmfi_download_code.html │ ├── rmfi_find.html │ ├── rmfi_fortran_format.html │ ├── rmfi_geomean.html │ ├── rmfi_guide_url.html │ ├── rmfi_harmean.html │ ├── rmfi_ifelse0.html │ ├── rmfi_install_code.html │ ├── rmfi_list_packages.html │ ├── rmfi_look_for_path.html │ ├── rmfi_parse_array.html │ ├── rmfi_parse_array_parameters.html │ ├── rmfi_parse_bc_list.html │ ├── rmfi_parse_comments.html │ ├── rmfi_parse_list.html │ ├── rmfi_parse_prj.html │ ├── rmfi_parse_variables.html │ ├── rmfi_performance_measures.html │ ├── rmfi_plot_bc.html │ ├── rmfi_prj_length_multiplier.html │ ├── rmfi_remove_comments_end_of_line.html │ ├── rmfi_remove_empty_strings.html │ ├── rmfi_replace_in_vector.html │ ├── rmfi_rev_rainbow.html │ ├── rmfi_trilinear_intp.html │ ├── rmfi_weighted_geomean.html │ ├── rmfi_weighted_harmean.html │ ├── rmfi_write_array.html │ ├── rmfi_write_array_parameters.html │ ├── rmfi_write_bc_list.html │ ├── rmfi_write_list.html │ ├── rmfi_write_prj.html │ └── rmfi_write_variables.html └── sitemap.xml ├── inst └── extdata │ ├── example-model.Rmd │ ├── example-model.bas │ ├── example-model.cbc │ ├── example-model.chd │ ├── example-model.dis │ ├── example-model.fdn │ ├── example-model.fhd │ ├── example-model.gpt │ ├── example-model.gsf │ ├── example-model.lpf │ ├── example-model.lst │ ├── example-model.md │ ├── example-model.mlt │ ├── example-model.nam │ ├── example-model.oc │ ├── example-model.pcg │ ├── example-model.pval │ ├── example-model.wel │ ├── example-model.zon │ ├── rocky-mountain-arsenal.Rmd │ ├── rocky-mountain-arsenal.bas │ ├── rocky-mountain-arsenal.cbc │ ├── rocky-mountain-arsenal.chd │ ├── rocky-mountain-arsenal.dis │ ├── rocky-mountain-arsenal.fdn │ ├── rocky-mountain-arsenal.fhd │ ├── rocky-mountain-arsenal.ftl │ ├── rocky-mountain-arsenal.gpt │ ├── rocky-mountain-arsenal.gsf │ ├── rocky-mountain-arsenal.lmt │ ├── rocky-mountain-arsenal.lpf │ ├── rocky-mountain-arsenal.lst │ ├── rocky-mountain-arsenal.md │ ├── rocky-mountain-arsenal.nam │ ├── rocky-mountain-arsenal.oc │ ├── rocky-mountain-arsenal.pcg │ ├── rocky-mountain-arsenal.wel │ ├── water-supply-problem.Rmd │ ├── water-supply-problem.bas │ ├── water-supply-problem.cbc │ ├── water-supply-problem.dis │ ├── water-supply-problem.fdn │ ├── water-supply-problem.fhd │ ├── water-supply-problem.gpt │ ├── water-supply-problem.gsf │ ├── water-supply-problem.hob_out │ ├── water-supply-problem.lpf │ ├── water-supply-problem.lst │ ├── water-supply-problem.md │ ├── water-supply-problem.nam │ ├── water-supply-problem.ob_hob │ ├── water-supply-problem.oc │ ├── water-supply-problem.pcg │ ├── water-supply-problem.riv │ └── water-supply-problem.wel ├── man ├── plot3d.mf2darray.Rd ├── plot3d.mf3darray.Rd ├── prj_auxiliary.Rd ├── read.array.Rd ├── reexports.Rd ├── rmf_analyze.Rd ├── rmf_animate.Rd ├── rmf_as_array.Raster.Rd ├── rmf_as_array.Rd ├── rmf_as_array.sf.Rd ├── rmf_as_array.stars.Rd ├── rmf_as_list.Rd ├── rmf_as_list.sf.Rd ├── rmf_as_list.stars.Rd ├── rmf_as_raster.Rd ├── rmf_as_sf.Rd ├── rmf_as_stars.Rd ├── rmf_as_tibble.Rd ├── rmf_browse.Rd ├── rmf_calculate_array.Rd ├── rmf_calculate_thickness.Rd ├── rmf_cell_coordinates.Rd ├── rmf_cell_dimensions.Rd ├── rmf_cell_info.Rd ├── rmf_convert_bcf_to_lpf.Rd ├── rmf_convert_cbc_to_darcy.Rd ├── rmf_convert_dis_to_saturated_dis.Rd ├── rmf_convert_grid_to_xyz.Rd ├── rmf_convert_hed_to_water_table.Rd ├── rmf_convert_hob_to_locations.Rd ├── rmf_convert_hob_to_time_series.Rd ├── rmf_convert_huf_to_dis.Rd ├── rmf_convert_huf_to_grid.Rd ├── rmf_convert_huf_to_lpf.Rd ├── rmf_convert_huf_to_mask.Rd ├── rmf_convert_ibound_to_neighbours.Rd ├── rmf_convert_id_to_id.Rd ├── rmf_convert_id_to_ijk.Rd ├── rmf_convert_ijk_to_id.Rd ├── rmf_convert_lpf_to_upw.Rd ├── rmf_convert_upw_to_lpf.Rd ├── rmf_convert_xyz_to_grid.Rd ├── rmf_copy_to_wd.Rd ├── rmf_create.Rd ├── rmf_create_array.Rd ├── rmf_create_bas.Rd ├── rmf_create_bcf.Rd ├── rmf_create_chd.Rd ├── rmf_create_de4.Rd ├── rmf_create_dis.Rd ├── rmf_create_drn.Rd ├── rmf_create_evt.Rd ├── rmf_create_ghb.Rd ├── rmf_create_gmg.Rd ├── rmf_create_hfb.Rd ├── rmf_create_hob.Rd ├── rmf_create_huf.Rd ├── rmf_create_kdep.Rd ├── rmf_create_list.Rd ├── rmf_create_lmt.Rd ├── rmf_create_lpf.Rd ├── rmf_create_lvda.Rd ├── rmf_create_mlt.Rd ├── rmf_create_nam.Rd ├── rmf_create_nwt.Rd ├── rmf_create_oc.Rd ├── rmf_create_parameter.Rd ├── rmf_create_parameter.default.Rd ├── rmf_create_parameter.rmf_2d_array.Rd ├── rmf_create_parameter.rmf_3d_array.Rd ├── rmf_create_parameter.rmf_list.Rd ├── rmf_create_pcg.Rd ├── rmf_create_prj.Rd ├── rmf_create_pval.Rd ├── rmf_create_rch.Rd ├── rmf_create_riv.Rd ├── rmf_create_sip.Rd ├── rmf_create_upw.Rd ├── rmf_create_wel.Rd ├── rmf_create_zon.Rd ├── rmf_example.Rd ├── rmf_example_file.Rd ├── rmf_example_files.Rd ├── rmf_example_model.Rd ├── rmf_example_models.Rd ├── rmf_execute.Rd ├── rmf_extent.Rd ├── rmf_gradient.Rd ├── rmf_guide.Rd ├── rmf_install.Rd ├── rmf_interpolate.Rd ├── rmf_optimize.Rd ├── rmf_performance.Rd ├── rmf_plot.Rd ├── rmf_plot.bud.Rd ├── rmf_plot.cbc.Rd ├── rmf_plot.chd.Rd ├── rmf_plot.ddn.Rd ├── rmf_plot.drn.Rd ├── rmf_plot.evt.Rd ├── rmf_plot.ghb.Rd ├── rmf_plot.hed.Rd ├── rmf_plot.hfb.Rd ├── rmf_plot.hob.Rd ├── rmf_plot.hpr.Rd ├── rmf_plot.huf.Rd ├── rmf_plot.modflow.Rd ├── rmf_plot.rch.Rd ├── rmf_plot.riv.Rd ├── rmf_plot.rmf_2d_array.Rd ├── rmf_plot.rmf_3d_array.Rd ├── rmf_plot.rmf_4d_array.Rd ├── rmf_plot.rmf_analyze.Rd ├── rmf_plot.rmf_list.Rd ├── rmf_plot.wel.Rd ├── rmf_read.Rd ├── rmf_read_array.Rd ├── rmf_read_bas.Rd ├── rmf_read_bcf.Rd ├── rmf_read_bud.Rd ├── rmf_read_cbc.Rd ├── rmf_read_chd.Rd ├── rmf_read_ddn.Rd ├── rmf_read_de4.Rd ├── rmf_read_dis.Rd ├── rmf_read_drn.Rd ├── rmf_read_evt.Rd ├── rmf_read_ghb.Rd ├── rmf_read_gmg.Rd ├── rmf_read_hed.Rd ├── rmf_read_hfb.Rd ├── rmf_read_hob.Rd ├── rmf_read_hpr.Rd ├── rmf_read_huf.Rd ├── rmf_read_kdep.Rd ├── rmf_read_lmt.Rd ├── rmf_read_lpf.Rd ├── rmf_read_lvda.Rd ├── rmf_read_mlt.Rd ├── rmf_read_nam.Rd ├── rmf_read_nwt.Rd ├── rmf_read_oc.Rd ├── rmf_read_pcg.Rd ├── rmf_read_pval.Rd ├── rmf_read_rch.Rd ├── rmf_read_riv.Rd ├── rmf_read_sip.Rd ├── rmf_read_upw.Rd ├── rmf_read_usgs_model_reference.Rd ├── rmf_read_wel.Rd ├── rmf_read_zon.Rd ├── rmf_saturated_thickness.Rd ├── rmf_time_steps.Rd ├── rmf_write.Rd ├── rmf_write_array.Rd ├── rmf_write_bas.Rd ├── rmf_write_bcf.Rd ├── rmf_write_chd.Rd ├── rmf_write_de4.Rd ├── rmf_write_dis.Rd ├── rmf_write_drn.Rd ├── rmf_write_evt.Rd ├── rmf_write_ghb.Rd ├── rmf_write_gmg.Rd ├── rmf_write_hfb.Rd ├── rmf_write_hob.Rd ├── rmf_write_huf.Rd ├── rmf_write_kdep.Rd ├── rmf_write_lmt.Rd ├── rmf_write_lpf.Rd ├── rmf_write_lvda.Rd ├── rmf_write_mlt.Rd ├── rmf_write_nam.Rd ├── rmf_write_nwt.Rd ├── rmf_write_oc.Rd ├── rmf_write_pcg.Rd ├── rmf_write_pval.Rd ├── rmf_write_rch.Rd ├── rmf_write_riv.Rd ├── rmf_write_sip.Rd ├── rmf_write_upw.Rd ├── rmf_write_vtk.Rd ├── rmf_write_wel.Rd ├── rmf_write_zon.Rd ├── rmfi_backup_pval.Rd ├── rmfi_bilinear_intp.Rd ├── rmfi_confining_beds.Rd ├── rmfi_convert_coordinates.Rd ├── rmfi_convert_huf_to_nlay.Rd ├── rmfi_create_bc_array.Rd ├── rmfi_create_bc_list.Rd ├── rmfi_download_code.Rd ├── rmfi_find.Rd ├── rmfi_fortran_format.Rd ├── rmfi_geomean.Rd ├── rmfi_guide_url.Rd ├── rmfi_harmean.Rd ├── rmfi_ifelse0.Rd ├── rmfi_install_code.Rd ├── rmfi_list_packages.Rd ├── rmfi_look_for_path.Rd ├── rmfi_parse_array.Rd ├── rmfi_parse_array_parameters.Rd ├── rmfi_parse_bc_list.Rd ├── rmfi_parse_comments.Rd ├── rmfi_parse_list.Rd ├── rmfi_parse_prj.Rd ├── rmfi_parse_variables.Rd ├── rmfi_performance_measures.Rd ├── rmfi_plot_bc.Rd ├── rmfi_prj_length_multiplier.Rd ├── rmfi_remove_comments_end_of_line.Rd ├── rmfi_remove_empty_strings.Rd ├── rmfi_replace_in_vector.Rd ├── rmfi_rev_rainbow.Rd ├── rmfi_trilinear_intp.Rd ├── rmfi_weighted_geomean.Rd ├── rmfi_weighted_harmean.Rd ├── rmfi_write_array.Rd ├── rmfi_write_array_parameters.Rd ├── rmfi_write_bc_list.Rd ├── rmfi_write_list.Rd ├── rmfi_write_prj.Rd └── rmfi_write_variables.Rd ├── pkgdown └── extra.css └── vignettes ├── RMODFLOW.R ├── RMODFLOW.Rmd ├── RMODFLOW.html ├── boundary_conditions.R ├── boundary_conditions.Rmd ├── boundary_conditions.html ├── input_data_structure.R ├── input_data_structure.Rmd ├── input_data_structure.html ├── output.R ├── output.Rmd ├── output.html ├── parameters.R ├── parameters.Rmd ├── parameters.html ├── plotting.R ├── plotting.Rmd ├── plotting.html ├── spatial.R ├── spatial.Rmd ├── spatial.html ├── top_level.R ├── top_level.Rmd └── top_level.html /.Rbuildignore: -------------------------------------------------------------------------------- 1 | ^.*\.Rproj$ 2 | ^\.Rproj\.user$ 3 | ^_pkgdown\.yml$ 4 | ^pkgdown$ 5 | ^NEWS\.md$ 6 | ^inst/code/ 7 | ^data-raw$ 8 | ^README\.Rmd$ 9 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .Rproj.user 2 | .Rhistory 3 | .RData 4 | inst/doc 5 | code 6 | inst/code -------------------------------------------------------------------------------- /DESCRIPTION: -------------------------------------------------------------------------------- 1 | Package: RMODFLOW 2 | Type: Package 3 | Title: Pre- and post-processing of MODFLOW files 4 | Version: 0.5.0 5 | Date: 2021-10-12 6 | Authors@R: c( 7 | person( 8 | given = "Bart", 9 | family = "Rogiers", 10 | email = "bart.rogiers@sckcen.be", 11 | role = c("cre", "aut"), 12 | comment = c(ORCID = "0000-0002-8836-0988")), 13 | person("Cas", "Neyens", role = "aut", email = "cas.neyens@gmail.com")) 14 | Description: The RMODFLOW package provides a set of tools for groundwater flow 15 | modelling with the MODFLOW-2005 family of codes. 16 | License: GPL (>= 2) 17 | Imports: 18 | ggplot2, 19 | akima, 20 | rgl, 21 | readr (>= 2.0.0), 22 | hydroGOF, 23 | directlabels, 24 | fs, 25 | sp, 26 | rgdal, 27 | animation, 28 | tools, 29 | xml2, 30 | rvest, 31 | sf, 32 | tibble, 33 | dplyr, 34 | stringr, 35 | purrr, 36 | abind, 37 | ggquiver, 38 | magrittr, 39 | stars, 40 | processx, 41 | tidyr, 42 | spectralscale, 43 | rui, 44 | lubridate 45 | Remotes: 46 | rogiersbart/spectralscale, 47 | rogiersbart/rui 48 | URL: https://rogiersbart.github.io/RMODFLOW/ 49 | BugReports: https://github.com/rogiersbart/RMODFLOW/issues 50 | Encoding: UTF-8 51 | Roxygen: list(markdown = TRUE) 52 | RoxygenNote: 7.2.3 53 | Suggests: 54 | knitr, 55 | rmarkdown, 56 | mapview 57 | VignetteBuilder: knitr 58 | ByteCompile: true 59 | Depends: 60 | R (>= 2.10) 61 | -------------------------------------------------------------------------------- /R/RMODFLOW.R: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /R/imports.R: -------------------------------------------------------------------------------- 1 | #' @importFrom magrittr %>% 2 | #' @export 3 | magrittr::`%>%` 4 | -------------------------------------------------------------------------------- /R/sysdata.rda: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/R/sysdata.rda -------------------------------------------------------------------------------- /R/zzz.R: -------------------------------------------------------------------------------- 1 | .onLoad <- function(libname, pkgname) { 2 | opts <- options() 3 | opts.RMODFLOW <- list( 4 | RMODFLOW.path = file.path(system.file(package = "RMODFLOW"), "code"), 5 | RMODFLOW.ui = "verbose", 6 | RMODFLOW.theme = "RMODFLOW" 7 | ) 8 | toset <- !(names(opts.RMODFLOW) %in% names(opts)) 9 | if(any(toset)) options(opts.RMODFLOW[toset]) 10 | invisible() 11 | } 12 | 13 | .onAttach <- function(libname, pkgname) { 14 | rui::alert("{{RMODFLOW}} is still in its experimental lifecycle stage.") 15 | rui::alert("Use at your own risk, and submit issues here:") 16 | rui::alert("{.url https://github.com/rogiersbart/RMODFLOW/issues}") 17 | invisible() 18 | } 19 | 20 | # options 21 | # path: enable users to set the code installation directory 22 | # ui: allow for a hierarchy of verbosity 23 | # verbose: everything 24 | # quiet: only warn and code output 25 | # silent: only code output 26 | # none: nothing 27 | # theme: ggplot2 theme, scales and template 28 | # RMODFLOW: recommended theme, encouraging users to tweak things 29 | # ggplot2: ggplot2 default behaviour 30 | 31 | # TODO: this has to enter documentation somewhere! -------------------------------------------------------------------------------- /RMODFLOW.Rproj: -------------------------------------------------------------------------------- 1 | Version: 1.0 2 | 3 | RestoreWorkspace: Default 4 | SaveWorkspace: Default 5 | AlwaysSaveHistory: Default 6 | 7 | EnableCodeIndexing: Yes 8 | UseSpacesForTab: Yes 9 | NumSpacesForTab: 2 10 | Encoding: UTF-8 11 | 12 | RnwWeave: knitr 13 | LaTeX: pdfLaTeX 14 | 15 | BuildType: Package 16 | PackageUseDevtools: Yes 17 | PackageInstallArgs: --no-multiarch --with-keep.source 18 | PackageRoxygenize: rd,collate,namespace,vignette 19 | -------------------------------------------------------------------------------- /docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-10-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-10-1.png -------------------------------------------------------------------------------- /docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-11-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-11-1.png -------------------------------------------------------------------------------- /docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-12-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-12-1.png -------------------------------------------------------------------------------- /docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-12-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-12-2.png -------------------------------------------------------------------------------- /docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-12-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-12-3.png -------------------------------------------------------------------------------- /docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-13-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-13-1.png -------------------------------------------------------------------------------- /docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-14-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-14-1.png -------------------------------------------------------------------------------- /docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-14-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-14-2.png -------------------------------------------------------------------------------- /docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-14-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-14-3.png -------------------------------------------------------------------------------- /docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-15-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-15-1.png -------------------------------------------------------------------------------- /docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-17-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/RMODFLOW_files/figure-html/unnamed-chunk-17-1.png -------------------------------------------------------------------------------- /docs/articles/RMODFLOW_files/header-attrs-2.10/header-attrs.js: -------------------------------------------------------------------------------- 1 | // Pandoc 2.9 adds attributes on both header and div. We remove the former (to 2 | // be compatible with the behavior of Pandoc < 2.8). 3 | document.addEventListener('DOMContentLoaded', function(e) { 4 | var hs = document.querySelectorAll("div.section[class*='level'] > :first-child"); 5 | var i, h, a; 6 | for (i = 0; i < hs.length; i++) { 7 | h = hs[i]; 8 | if (!/^h[1-6]$/i.test(h.tagName)) continue; // it should be a header h1-h6 9 | a = h.attributes; 10 | while (a.length > 0) h.removeAttribute(a[0].name); 11 | } 12 | }); 13 | -------------------------------------------------------------------------------- /docs/articles/boundary_conditions_files/header-attrs-2.10/header-attrs.js: -------------------------------------------------------------------------------- 1 | // Pandoc 2.9 adds attributes on both header and div. We remove the former (to 2 | // be compatible with the behavior of Pandoc < 2.8). 3 | document.addEventListener('DOMContentLoaded', function(e) { 4 | var hs = document.querySelectorAll("div.section[class*='level'] > :first-child"); 5 | var i, h, a; 6 | for (i = 0; i < hs.length; i++) { 7 | h = hs[i]; 8 | if (!/^h[1-6]$/i.test(h.tagName)) continue; // it should be a header h1-h6 9 | a = h.attributes; 10 | while (a.length > 0) h.removeAttribute(a[0].name); 11 | } 12 | }); 13 | -------------------------------------------------------------------------------- /docs/articles/input_data_structure_files/header-attrs-2.10/header-attrs.js: -------------------------------------------------------------------------------- 1 | // Pandoc 2.9 adds attributes on both header and div. We remove the former (to 2 | // be compatible with the behavior of Pandoc < 2.8). 3 | document.addEventListener('DOMContentLoaded', function(e) { 4 | var hs = document.querySelectorAll("div.section[class*='level'] > :first-child"); 5 | var i, h, a; 6 | for (i = 0; i < hs.length; i++) { 7 | h = hs[i]; 8 | if (!/^h[1-6]$/i.test(h.tagName)) continue; // it should be a header h1-h6 9 | a = h.attributes; 10 | while (a.length > 0) h.removeAttribute(a[0].name); 11 | } 12 | }); 13 | -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-12-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-12-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-12-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-12-2.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-13-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-13-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-15-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-15-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-16-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-16-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-17-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-17-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-18-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-18-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-18-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-18-2.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-19-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-19-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-20-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-20-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-21-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-21-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-23-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-23-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-24-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-24-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-25-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-25-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-5-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-5-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-6-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-6-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-6-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-6-2.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-7-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-7-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-7-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-7-2.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-8-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-8-1.png -------------------------------------------------------------------------------- /docs/articles/output_files/figure-html/unnamed-chunk-8-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/output_files/figure-html/unnamed-chunk-8-2.png -------------------------------------------------------------------------------- /docs/articles/output_files/header-attrs-2.10/header-attrs.js: -------------------------------------------------------------------------------- 1 | // Pandoc 2.9 adds attributes on both header and div. We remove the former (to 2 | // be compatible with the behavior of Pandoc < 2.8). 3 | document.addEventListener('DOMContentLoaded', function(e) { 4 | var hs = document.querySelectorAll("div.section[class*='level'] > :first-child"); 5 | var i, h, a; 6 | for (i = 0; i < hs.length; i++) { 7 | h = hs[i]; 8 | if (!/^h[1-6]$/i.test(h.tagName)) continue; // it should be a header h1-h6 9 | a = h.attributes; 10 | while (a.length > 0) h.removeAttribute(a[0].name); 11 | } 12 | }); 13 | -------------------------------------------------------------------------------- /docs/articles/parameters_files/header-attrs-2.10/header-attrs.js: -------------------------------------------------------------------------------- 1 | // Pandoc 2.9 adds attributes on both header and div. We remove the former (to 2 | // be compatible with the behavior of Pandoc < 2.8). 3 | document.addEventListener('DOMContentLoaded', function(e) { 4 | var hs = document.querySelectorAll("div.section[class*='level'] > :first-child"); 5 | var i, h, a; 6 | for (i = 0; i < hs.length; i++) { 7 | h = hs[i]; 8 | if (!/^h[1-6]$/i.test(h.tagName)) continue; // it should be a header h1-h6 9 | a = h.attributes; 10 | while (a.length > 0) h.removeAttribute(a[0].name); 11 | } 12 | }); 13 | -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-1-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-1-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-10-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-10-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-10-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-10-2.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-10-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-10-3.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-11-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-11-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-11-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-11-2.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-12-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-12-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-13-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-13-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-13-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-13-2.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-14-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-14-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-15-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-15-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-15-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-15-2.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-15-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-15-3.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-15-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-15-4.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-16-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-16-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-17-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-17-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-18-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-18-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-2-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-2-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-2-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-2-2.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-2-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-2-3.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-20-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-20-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-21-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-21-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-22-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-22-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-22-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-22-2.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-23-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-23-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-3-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-3-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-4-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-4-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-4-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-4-2.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-5-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-5-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-5-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-5-2.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-6-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-6-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-6-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-6-2.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-6-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-6-3.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-7-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-7-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-7-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-7-2.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-8-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-8-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-8-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-8-2.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-8-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-8-3.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-9-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-9-1.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/figure-html/unnamed-chunk-9-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/plotting_files/figure-html/unnamed-chunk-9-2.png -------------------------------------------------------------------------------- /docs/articles/plotting_files/header-attrs-2.10/header-attrs.js: -------------------------------------------------------------------------------- 1 | // Pandoc 2.9 adds attributes on both header and div. We remove the former (to 2 | // be compatible with the behavior of Pandoc < 2.8). 3 | document.addEventListener('DOMContentLoaded', function(e) { 4 | var hs = document.querySelectorAll("div.section[class*='level'] > :first-child"); 5 | var i, h, a; 6 | for (i = 0; i < hs.length; i++) { 7 | h = hs[i]; 8 | if (!/^h[1-6]$/i.test(h.tagName)) continue; // it should be a header h1-h6 9 | a = h.attributes; 10 | while (a.length > 0) h.removeAttribute(a[0].name); 11 | } 12 | }); 13 | -------------------------------------------------------------------------------- /docs/articles/spatial_files/figure-html/unnamed-chunk-11-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/spatial_files/figure-html/unnamed-chunk-11-1.png -------------------------------------------------------------------------------- /docs/articles/spatial_files/figure-html/unnamed-chunk-11-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/spatial_files/figure-html/unnamed-chunk-11-2.png -------------------------------------------------------------------------------- /docs/articles/spatial_files/figure-html/unnamed-chunk-12-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/spatial_files/figure-html/unnamed-chunk-12-1.png -------------------------------------------------------------------------------- /docs/articles/spatial_files/figure-html/unnamed-chunk-3-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/spatial_files/figure-html/unnamed-chunk-3-1.png -------------------------------------------------------------------------------- /docs/articles/spatial_files/figure-html/unnamed-chunk-4-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/spatial_files/figure-html/unnamed-chunk-4-1.png -------------------------------------------------------------------------------- /docs/articles/spatial_files/figure-html/unnamed-chunk-6-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/spatial_files/figure-html/unnamed-chunk-6-1.png -------------------------------------------------------------------------------- /docs/articles/spatial_files/figure-html/unnamed-chunk-7-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/articles/spatial_files/figure-html/unnamed-chunk-7-1.png -------------------------------------------------------------------------------- /docs/articles/spatial_files/header-attrs-2.10/header-attrs.js: -------------------------------------------------------------------------------- 1 | // Pandoc 2.9 adds attributes on both header and div. We remove the former (to 2 | // be compatible with the behavior of Pandoc < 2.8). 3 | document.addEventListener('DOMContentLoaded', function(e) { 4 | var hs = document.querySelectorAll("div.section[class*='level'] > :first-child"); 5 | var i, h, a; 6 | for (i = 0; i < hs.length; i++) { 7 | h = hs[i]; 8 | if (!/^h[1-6]$/i.test(h.tagName)) continue; // it should be a header h1-h6 9 | a = h.attributes; 10 | while (a.length > 0) h.removeAttribute(a[0].name); 11 | } 12 | }); 13 | -------------------------------------------------------------------------------- /docs/articles/top_level_files/header-attrs-2.10/header-attrs.js: -------------------------------------------------------------------------------- 1 | // Pandoc 2.9 adds attributes on both header and div. We remove the former (to 2 | // be compatible with the behavior of Pandoc < 2.8). 3 | document.addEventListener('DOMContentLoaded', function(e) { 4 | var hs = document.querySelectorAll("div.section[class*='level'] > :first-child"); 5 | var i, h, a; 6 | for (i = 0; i < hs.length; i++) { 7 | h = hs[i]; 8 | if (!/^h[1-6]$/i.test(h.tagName)) continue; // it should be a header h1-h6 9 | a = h.attributes; 10 | while (a.length > 0) h.removeAttribute(a[0].name); 11 | } 12 | }); 13 | -------------------------------------------------------------------------------- /docs/link.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 8 | 12 | 13 | -------------------------------------------------------------------------------- /docs/pkgdown.yml: -------------------------------------------------------------------------------- 1 | pandoc: 2.14.0.3 2 | pkgdown: 1.6.1 3 | pkgdown_sha: ~ 4 | articles: 5 | boundary_conditions: boundary_conditions.html 6 | input_data_structure: input_data_structure.html 7 | output: output.html 8 | parameters: parameters.html 9 | plotting: plotting.html 10 | RMODFLOW: RMODFLOW.html 11 | spatial: spatial.html 12 | top_level: top_level.html 13 | last_built: 2021-10-12T08:28Z 14 | urls: 15 | reference: https://rogiersbart.github.io/RMODFLOW//reference 16 | article: https://rogiersbart.github.io/RMODFLOW//articles 17 | 18 | -------------------------------------------------------------------------------- /docs/reference/Rplot001.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/Rplot001.png -------------------------------------------------------------------------------- /docs/reference/Rplot002.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/Rplot002.png -------------------------------------------------------------------------------- /docs/reference/Rplot003.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/Rplot003.png -------------------------------------------------------------------------------- /docs/reference/Rplot004.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/Rplot004.png -------------------------------------------------------------------------------- /docs/reference/Rplot005.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/Rplot005.png -------------------------------------------------------------------------------- /docs/reference/Rplot006.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/Rplot006.png -------------------------------------------------------------------------------- /docs/reference/Rplot007.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/Rplot007.png -------------------------------------------------------------------------------- /docs/reference/Rplot008.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/Rplot008.png -------------------------------------------------------------------------------- /docs/reference/rmf_as_list.sf-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_as_list.sf-1.png -------------------------------------------------------------------------------- /docs/reference/rmf_as_list.sf-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_as_list.sf-2.png -------------------------------------------------------------------------------- /docs/reference/rmf_as_list.sf-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_as_list.sf-3.png -------------------------------------------------------------------------------- /docs/reference/rmf_as_list.sf-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_as_list.sf-4.png -------------------------------------------------------------------------------- /docs/reference/rmf_as_list.sf-5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_as_list.sf-5.png -------------------------------------------------------------------------------- /docs/reference/rmf_as_list.sf-6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_as_list.sf-6.png -------------------------------------------------------------------------------- /docs/reference/rmf_as_list.sf-7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_as_list.sf-7.png -------------------------------------------------------------------------------- /docs/reference/rmf_as_list.sf-8.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_as_list.sf-8.png -------------------------------------------------------------------------------- /docs/reference/rmf_plot.modflow-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_plot.modflow-1.png -------------------------------------------------------------------------------- /docs/reference/rmf_plot.modflow-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_plot.modflow-2.png -------------------------------------------------------------------------------- /docs/reference/rmf_plot.modflow-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_plot.modflow-3.png -------------------------------------------------------------------------------- /docs/reference/rmf_plot.modflow-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_plot.modflow-4.png -------------------------------------------------------------------------------- /docs/reference/rmf_plot.modflow-5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_plot.modflow-5.png -------------------------------------------------------------------------------- /docs/reference/rmf_plot.modflow-6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_plot.modflow-6.png -------------------------------------------------------------------------------- /docs/reference/rmf_plot.modflow-7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/docs/reference/rmf_plot.modflow-7.png -------------------------------------------------------------------------------- /inst/extdata/example-model.Rmd: -------------------------------------------------------------------------------- 1 | --- 2 | output: 3 | md_document: 4 | variant: markdown_github 5 | --- 6 | 7 | # Example model 8 | 9 | The example model MODFLOW example is derived from the [corresponding ModelMuse example](https://water.usgs.gov/nrp/gwsoftware/ModelMuse/Help/example_model.htm). -------------------------------------------------------------------------------- /inst/extdata/example-model.bas: -------------------------------------------------------------------------------- 1 | # Basic Package file created on 2017-05-30 by ModelMuse version 3.9.0.0. 2 | FREE CHTOCH PRINTTIME # OPTIONS 3 | CONSTANT 1 # IBOUND Upper Aquifer 4 | CONSTANT 1 # IBOUND Middle Aquifer Layer 1 5 | CONSTANT 1 # IBOUND Middle Aquifer Layer 2 6 | CONSTANT 1 # IBOUND Middle Aquifer Layer 3 7 | CONSTANT 1 # IBOUND Middle Aquifer Layer 4 8 | CONSTANT 1 # IBOUND Middle Aquifer Layer 5 9 | CONSTANT 1 # IBOUND Middle Aquifer Layer 6 10 | CONSTANT 1 # IBOUND Middle Aquifer Layer 7 11 | CONSTANT 1 # IBOUND Lower Aquifer 12 | -1.000000000000E+020 # HNOFLO 13 | CONSTANT 3.000000000000E+001 # STRT Upper Aquifer 14 | CONSTANT 3.000000000000E+001 # STRT Middle Aquifer Layer 1 15 | CONSTANT 3.000000000000E+001 # STRT Middle Aquifer Layer 2 16 | CONSTANT 3.000000000000E+001 # STRT Middle Aquifer Layer 3 17 | CONSTANT 3.000000000000E+001 # STRT Middle Aquifer Layer 4 18 | CONSTANT 3.000000000000E+001 # STRT Middle Aquifer Layer 5 19 | CONSTANT 3.000000000000E+001 # STRT Middle Aquifer Layer 6 20 | CONSTANT 3.000000000000E+001 # STRT Middle Aquifer Layer 7 21 | CONSTANT 3.000000000000E+001 # STRT Lower Aquifer 22 | -------------------------------------------------------------------------------- /inst/extdata/example-model.cbc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/inst/extdata/example-model.cbc -------------------------------------------------------------------------------- /inst/extdata/example-model.gsf: -------------------------------------------------------------------------------- 1 | 10 10 2 | 0.000000000000E+000 0.000000000000E+000 0.000000000000E+000 3 | 10*100 4 | 10*100 5 | -------------------------------------------------------------------------------- /inst/extdata/example-model.md: -------------------------------------------------------------------------------- 1 | Example model 2 | ============= 3 | 4 | The example model MODFLOW example is derived from the [corresponding ModelMuse example](https://water.usgs.gov/nrp/gwsoftware/ModelMuse/Help/example_model.htm). 5 | -------------------------------------------------------------------------------- /inst/extdata/example-model.nam: -------------------------------------------------------------------------------- 1 | # Name File for MODFLOW created on 2017-05-30 by ModelMuse Version 3.9.0.0 2 | LIST 11 example-model.lst REPLACE 3 | DATA(BINARY) 9 example-model.cbc REPLACE 4 | DIS 12 example-model.dis OLD 5 | BAS6 13 example-model.bas OLD 6 | OC 39 example-model.oc OLD 7 | DATA 37 example-model.fhd REPLACE 8 | DATA 38 example-model.fdn REPLACE 9 | PCG 18 example-model.pcg OLD 10 | LPF 14 example-model.lpf OLD 11 | CHD 17 example-model.chd OLD 12 | WEL 20 example-model.wel OLD 13 | ZONE 15 example-model.zon OLD 14 | MULT 16 example-model.mlt OLD 15 | PVAL 52 example-model.pval OLD 16 | -------------------------------------------------------------------------------- /inst/extdata/example-model.oc: -------------------------------------------------------------------------------- 1 | # Output Control file created on 2017-05-30 by ModelMuse version 3.9.0.0. 2 | HEAD SAVE FORMAT (10(1X1PE13.5)) LABEL 3 | HEAD SAVE UNIT 37 4 | DRAWDOWN SAVE FORMAT (10(1X1PE13.5)) LABEL 5 | DRAWDOWN SAVE UNIT 38 6 | COMPACT BUDGET AUXILIARY 7 | PERIOD 1 STEP 1 8 | SAVE HEAD 9 | SAVE DRAWDOWN 10 | SAVE BUDGET 11 | PRINT BUDGET 12 | -------------------------------------------------------------------------------- /inst/extdata/example-model.pcg: -------------------------------------------------------------------------------- 1 | # PCG: Preconditioned Conjugate Gradient package file created on 2017-05-30 by ModelMuse version 3.9.0.0. 2 | 20 30 1 0 # MXITER, ITER1, NPCOND, IHCOFADD 3 | 1.000000000000E-003 1.000000000000E+003 1.000000000000E+000 1 1 0 1.000000000000E+000 # HCLOSE, RCLOSE, RELAX, NBPOL, IPRPCG, MUTPCG, DAMPPCG 4 | -------------------------------------------------------------------------------- /inst/extdata/example-model.pval: -------------------------------------------------------------------------------- 1 | # PVAL file created on 2017-05-30 by ModelMuse version 3.9.0.0. 2 | 4 3 | HK_Par1 150 4 | HK_Par2 200 5 | CHD_Par1 30 6 | CHD_Par2 30 7 | -------------------------------------------------------------------------------- /inst/extdata/example-model.wel: -------------------------------------------------------------------------------- 1 | # WEL: Well package file created on 2017-05-30 by ModelMuse version 3.9.0.0. 2 | 1 9 AUXILIARY IFACE # DataSet 2: MXACTW IWELCB Option 3 | 1 0 # Data Set 5: ITMP NP Stress period 1 4 | 1 5 6 3.000000000000E-001 0 # Data Set 6: Layer Row Column Bhead Q IFACE Intersected by Well with formula: 0.3 5 | -------------------------------------------------------------------------------- /inst/extdata/rocky-mountain-arsenal.Rmd: -------------------------------------------------------------------------------- 1 | --- 2 | output: 3 | md_document: 4 | variant: markdown_github 5 | --- 6 | 7 | # Rocky mountain arsenal 8 | 9 | The Rocky mountain arsenal MODFLOW example is derived from the [corresponding ModelMuse example](https://water.usgs.gov/nrp/gwsoftware/ModelMuse/Help/rocky_mountain_arsenal.htm). -------------------------------------------------------------------------------- /inst/extdata/rocky-mountain-arsenal.cbc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/inst/extdata/rocky-mountain-arsenal.cbc -------------------------------------------------------------------------------- /inst/extdata/rocky-mountain-arsenal.ftl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/inst/extdata/rocky-mountain-arsenal.ftl -------------------------------------------------------------------------------- /inst/extdata/rocky-mountain-arsenal.lmt: -------------------------------------------------------------------------------- 1 | OUTPUT_FILE_NAME rocky-mountain-arsenal.ftl 2 | OUTPUT_FILE_UNIT 136 3 | OUTPUT_FIlE_HEADER Extended 4 | OUTPUT_FILE_FORMAT Unformatted 5 | -------------------------------------------------------------------------------- /inst/extdata/rocky-mountain-arsenal.lpf: -------------------------------------------------------------------------------- 1 | # LPF: Layer Property Flow package file created on 2017-05-30 by ModelMuse version 3.9.0.0. 2 | 9 -2.000000000000E+020 0 # ILPFCB, HDRY, NPLPF 3 | 0 # LAYTYP 4 | 0 # LAYAVG 5 | -1 # CHANI 6 | 0 # LAYVKA 7 | 0 # LAYWET 8 | CONSTANT 1.000000000000E-004 # HK Aquifer Layer 1 9 | CONSTANT 1.000000000000E+000 # HANI Aquifer Layer 1 10 | CONSTANT 1.000000000000E-005 # VKA Aquifer Layer 1 11 | -------------------------------------------------------------------------------- /inst/extdata/rocky-mountain-arsenal.md: -------------------------------------------------------------------------------- 1 | Rocky mountain arsenal 2 | ====================== 3 | 4 | The Rocky mountain arsenal MODFLOW example is derived from the [corresponding ModelMuse example](https://water.usgs.gov/nrp/gwsoftware/ModelMuse/Help/rocky_mountain_arsenal.htm). 5 | -------------------------------------------------------------------------------- /inst/extdata/rocky-mountain-arsenal.nam: -------------------------------------------------------------------------------- 1 | # Name File for MODFLOW created on 2017-05-30 by ModelMuse Version 3.9.0.0 2 | LIST 11 rocky-mountain-arsenal.lst REPLACE 3 | DATA(BINARY) 9 rocky-mountain-arsenal.cbc REPLACE 4 | DIS 12 rocky-mountain-arsenal.dis OLD 5 | BAS6 13 rocky-mountain-arsenal.bas OLD 6 | OC 39 rocky-mountain-arsenal.oc OLD 7 | DATA 37 rocky-mountain-arsenal.fhd REPLACE 8 | DATA 38 rocky-mountain-arsenal.fdn REPLACE 9 | PCG 18 rocky-mountain-arsenal.pcg OLD 10 | LPF 14 rocky-mountain-arsenal.lpf OLD 11 | LMT6 135 rocky-mountain-arsenal.lmt OLD 12 | DATA(BINARY) 136 rocky-mountain-arsenal.ftl REPLACE 13 | CHD 17 rocky-mountain-arsenal.chd OLD 14 | WEL 20 rocky-mountain-arsenal.wel OLD 15 | -------------------------------------------------------------------------------- /inst/extdata/rocky-mountain-arsenal.oc: -------------------------------------------------------------------------------- 1 | # Output Control file created on 2017-05-30 by ModelMuse version 3.9.0.0. 2 | HEAD SAVE FORMAT (10(1X1PE13.5)) LABEL 3 | HEAD SAVE UNIT 37 4 | DRAWDOWN SAVE FORMAT (10(1X1PE13.5)) LABEL 5 | DRAWDOWN SAVE UNIT 38 6 | COMPACT BUDGET AUXILIARY 7 | PERIOD 1 STEP 1 8 | SAVE HEAD 9 | SAVE DRAWDOWN 10 | SAVE BUDGET 11 | PRINT BUDGET 12 | -------------------------------------------------------------------------------- /inst/extdata/rocky-mountain-arsenal.pcg: -------------------------------------------------------------------------------- 1 | # PCG: Preconditioned Conjugate Gradient package file created on 2017-05-30 by ModelMuse version 3.9.0.0. 2 | 20 30 1 0 # MXITER, ITER1, NPCOND, IHCOFADD 3 | 1.000000000000E-003 1.000000000000E+003 1.000000000000E+000 1 1 0 1.000000000000E+000 # HCLOSE, RCLOSE, RELAX, NBPOL, IPRPCG, MUTPCG, DAMPPCG 4 | -------------------------------------------------------------------------------- /inst/extdata/rocky-mountain-arsenal.wel: -------------------------------------------------------------------------------- 1 | # WEL: Well package file created on 2017-05-30 by ModelMuse version 3.9.0.0. 2 | 4 9 AUXILIARY IFACE # DataSet 2: MXACTW IWELCB Option 3 | 4 0 # Data Set 5: ITMP NP Stress period 1 4 | 1 13 29 1.250000000000E-002 0 # Data Set 6: Layer Row Column Bhead Q IFACE Enclosed by Disposal_Pond with formula: 0.0125 5 | 1 13 30 1.250000000000E-002 0 # Data Set 6: Layer Row Column Bhead Q IFACE Enclosed by Disposal_Pond with formula: 0.0125 6 | 1 42 15 -1.000000000000E-003 0 # Data Set 6: Layer Row Column Bhead Q IFACE Intersected by Well_1 with formula: -0.001 7 | 1 44 23 -2.000000000000E-003 0 # Data Set 6: Layer Row Column Bhead Q IFACE Intersected by Well_2 with formula: -0.002 8 | -------------------------------------------------------------------------------- /inst/extdata/water-supply-problem.Rmd: -------------------------------------------------------------------------------- 1 | --- 2 | output: 3 | md_document: 4 | variant: markdown_github 5 | --- 6 | 7 | # Water supply problem 8 | 9 | The water supply problem MODFLOW example is derived from the [corresponding ModelMuse example](https://water.usgs.gov/nrp/gwsoftware/ModelMuse/Help/index.html?water_supply_problem.htm). Note some MODFLOW files were renamed after the file export in ModelMuse, to make file naming more consistent with RMODFLOW conventions (although ModelMuse extensions are/will be supported as well): 10 | 11 | ```{r, eval = FALSE} 12 | file.rename("water-supply-problem.hob_out", "water-supply-problem.hpr") 13 | file.rename("water-supply-problem.ob_hob", "water-supply-problem.hob") 14 | x <- readLines("water-supply-problem.nam") 15 | y <- gsub("water-supply-problem.hob_out", "water-supply-problem.hpr", x, fixed = TRUE) 16 | y <- gsub("water-supply-problem.ob_hob", "water-supply-problem.hob", y, fixed = TRUE) 17 | cat(y, file = "rocky-mountain-arsenal.nam", sep = "\n") 18 | ``` 19 | 20 | 21 | -------------------------------------------------------------------------------- /inst/extdata/water-supply-problem.cbc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rogiersbart/RMODFLOW/2da3f1e23f0df058e56a4b30cb46a304e9a757e7/inst/extdata/water-supply-problem.cbc -------------------------------------------------------------------------------- /inst/extdata/water-supply-problem.lpf: -------------------------------------------------------------------------------- 1 | # LPF: Layer Property Flow package file created on 2017-05-30 by ModelMuse version 3.9.0.0. 2 | 9 -2.000000000000E+020 0 # ILPFCB, HDRY, NPLPF 3 | 0 # LAYTYP 4 | 0 # LAYAVG 5 | -1 # CHANI 6 | 0 # LAYVKA 7 | 0 # LAYWET 8 | CONSTANT 6.850000000000E-002 # HK Aquifer Layer 1 9 | CONSTANT 1.000000000000E+000 # HANI Aquifer Layer 1 10 | CONSTANT 6.850000000000E-003 # VKA Aquifer Layer 1 11 | CONSTANT 1.000000000000E-004 # SS Aquifer Layer 1 12 | -------------------------------------------------------------------------------- /inst/extdata/water-supply-problem.md: -------------------------------------------------------------------------------- 1 | The water supply problem MODFLOW example is derived from the [corresponding ModelMuse example](https://water.usgs.gov/nrp/gwsoftware/ModelMuse/Help/index.html?water_supply_problem.htm). Note some MODFLOW files were renamed after the file export in ModelMuse, to make file naming more consistent with RMODFLOW conventions (although ModelMuse extensions are/will be supported as well): 2 | 3 | ``` r 4 | file.rename("water-supply-problem.hob_out", "water-supply-problem.hpr") 5 | file.rename("water-supply-problem.ob_hob", "water-supply-problem.hob") 6 | x <- readLines("water-supply-problem.nam") 7 | y <- gsub("water-supply-problem.hob_out", "water-supply-problem.hpr", x, fixed = TRUE) 8 | y <- gsub("water-supply-problem.ob_hob", "water-supply-problem.hob", y, fixed = TRUE) 9 | cat(y, file = "rocky-mountain-arsenal.nam", sep = "\n") 10 | ``` 11 | -------------------------------------------------------------------------------- /inst/extdata/water-supply-problem.nam: -------------------------------------------------------------------------------- 1 | # Name File for MODFLOW created on 2017-05-30 by ModelMuse Version 3.9.0.0 2 | LIST 11 water-supply-problem.lst REPLACE 3 | DATA(BINARY) 9 water-supply-problem.cbc REPLACE 4 | DIS 12 water-supply-problem.dis OLD 5 | BAS6 13 water-supply-problem.bas OLD 6 | OC 39 water-supply-problem.oc OLD 7 | DATA 37 water-supply-problem.fhd REPLACE 8 | DATA 38 water-supply-problem.fdn REPLACE 9 | PCG 18 water-supply-problem.pcg OLD 10 | LPF 14 water-supply-problem.lpf OLD 11 | WEL 20 water-supply-problem.wel OLD 12 | RIV 21 water-supply-problem.riv OLD 13 | HOB 41 water-supply-problem.ob_hob OLD 14 | DATA 42 water-supply-problem.hob_out REPLACE 15 | -------------------------------------------------------------------------------- /inst/extdata/water-supply-problem.pcg: -------------------------------------------------------------------------------- 1 | # PCG: Preconditioned Conjugate Gradient package file created on 2017-05-30 by ModelMuse version 3.9.0.0. 2 | 20 30 1 0 # MXITER, ITER1, NPCOND, IHCOFADD 3 | 1.000000000000E-003 1.000000000000E+003 1.000000000000E+000 1 1 0 1.000000000000E+000 # HCLOSE, RCLOSE, RELAX, NBPOL, IPRPCG, MUTPCG, DAMPPCG 4 | -------------------------------------------------------------------------------- /inst/extdata/water-supply-problem.wel: -------------------------------------------------------------------------------- 1 | # WEL: Well package file created on 2017-05-30 by ModelMuse version 3.9.0.0. 2 | 1 9 AUXILIARY IFACE # DataSet 2: MXACTW IWELCB Option 3 | 1 0 # Data Set 5: ITMP NP Stress period 1 4 | 1 30 33 9.630000000000E-001 0 # Data Set 6: Layer Row Column Bhead Q IFACE Intersected by Well with formula: 0.963 5 | -------------------------------------------------------------------------------- /man/plot3d.mf2darray.Rd: -------------------------------------------------------------------------------- 1 | \name{plot3d.mf2darray} 2 | \alias{plot3d.mf2darray} 3 | \title{Plot a MODFLOW 2D array} 4 | \usage{ 5 | \method{plot3d}{mf2darray}(mf2darray, dis, ibound = mf2darray * 0 + 1, 6 | color.palette = terrain.colors, zlim = range(mf2darray, finite = TRUE), 7 | levels = pretty(zlim, nlevels), nlevels = 20, main = "MF ARRAY plot", 8 | type = "fill", add = FALSE, xOrigin = 0, yOrigin = 0) 9 | } 10 | \arguments{ 11 | \item{mf2darray}{An object of class mf2darray, or a 2D 12 | matrix} 13 | 14 | \item{ibound}{An ibound array with 1 or TRUE indicating 15 | active cells, and 0 or F indicating inactive cells} 16 | 17 | \item{color.palette}{A color palette for imaging the 18 | parameter values} 19 | 20 | \item{zlim}{} 21 | 22 | \item{levels}{} 23 | 24 | \item{nlevels}{} 25 | 26 | \item{main}{} 27 | } 28 | \value{ 29 | None 30 | } 31 | \description{ 32 | \code{plot.mf2darray} plots a MODFLOW 2D array. 33 | } 34 | 35 | -------------------------------------------------------------------------------- /man/plot3d.mf3darray.Rd: -------------------------------------------------------------------------------- 1 | \name{plot3d.mf3darray} 2 | \alias{plot3d.mf3darray} 3 | \title{Plot a MODFLOW 2D array} 4 | \usage{ 5 | \method{plot3d}{mf3darray}(mf3darray, layer = "all", dis, ibound = mf2darray 6 | * 0 + 1, color.palette = terrain.colors, zlim = range(mf2darray, finite = 7 | TRUE), levels = pretty(zlim, nlevels), nlevels = 20, 8 | main = "MF ARRAY plot", type = "fill", add = FALSE, xOrigin = 0, 9 | yOrigin = 0) 10 | } 11 | \arguments{ 12 | \item{mf3darray}{An object of class mf2darray, or a 2D 13 | matrix} 14 | 15 | \item{ibound}{An ibound array with 1 or TRUE indicating 16 | active cells, and 0 or F indicating inactive cells} 17 | 18 | \item{color.palette}{A color palette for imaging the 19 | parameter values} 20 | 21 | \item{zlim}{} 22 | 23 | \item{levels}{} 24 | 25 | \item{nlevels}{} 26 | 27 | \item{main}{} 28 | } 29 | \value{ 30 | None 31 | } 32 | \description{ 33 | \code{plot.mf2darray} plots a MODFLOW 2D array. 34 | } 35 | 36 | -------------------------------------------------------------------------------- /man/read.array.Rd: -------------------------------------------------------------------------------- 1 | \name{read.array} 2 | \alias{read.array} 3 | \title{Read an array specified by a free-format control record} 4 | \usage{ 5 | read.array(mfarray.lines, NROW, NCOL, NLAY) 6 | } 7 | \arguments{ 8 | \item{object}{MODFLOW input file text object, starting 9 | with the free-format control record} 10 | } 11 | \value{ 12 | A list containing the array and the remaining text of the 13 | MODFLOW input file 14 | } 15 | \description{ 16 | Read an array specified by a free-format control record 17 | } 18 | 19 | -------------------------------------------------------------------------------- /man/reexports.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/imports.R 3 | \docType{import} 4 | \name{reexports} 5 | \alias{reexports} 6 | \alias{\%>\%} 7 | \title{Objects exported from other packages} 8 | \keyword{internal} 9 | \description{ 10 | These objects are imported from other packages. Follow the links 11 | below to see their documentation. 12 | 13 | \describe{ 14 | \item{magrittr}{\code{\link[magrittr:pipe]{\%>\%}}} 15 | }} 16 | 17 | -------------------------------------------------------------------------------- /man/rmf_as_array.Raster.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/spatial.R 3 | \name{rmf_as_array.Raster} 4 | \alias{rmf_as_array.Raster} 5 | \title{Convert a raster object to rmf_array} 6 | \usage{ 7 | \method{rmf_as_array}{Raster}(obj, dis, ...) 8 | } 9 | \arguments{ 10 | \item{obj}{object of class \code{RasterLayer}, \code{RasterStack} or \code{RasterBrick}} 11 | 12 | \item{dis}{\code{RMODFLOW} object} 13 | 14 | \item{...}{additional arguments passed to \code{\link{rmf_as_array.stars}}} 15 | } 16 | \value{ 17 | a \code{rmf_2d_array} or \code{rmf_3d_array} depending on the dimensions of \code{obj} 18 | } 19 | \description{ 20 | Convert a raster object to rmf_array 21 | } 22 | \details{ 23 | \code{obj} is first converted to \code{stars} using \code{stars::st_as_stars}. \code{rmf_as_array.stars} is called on the resulting \code{stars} object. 24 | } 25 | \examples{ 26 | dis <- rmf_create_dis() 27 | r <- raster::raster(matrix(1:prod(dis$nrow, dis$ncol), 10, 10), 28 | xmx = sum(dis$delr), ymx = sum(dis$delc)) 29 | rmf_as_array(r, dis, resample = FALSE) 30 | } 31 | -------------------------------------------------------------------------------- /man/rmf_browse.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/web.R 3 | \name{rmf_browse} 4 | \alias{rmf_browse} 5 | \title{Browse the RMODFLOW pkgdown website} 6 | \usage{ 7 | rmf_browse() 8 | } 9 | \description{ 10 | This function can be used to launch the \href{https://rogiersbart.github.io/RMODFLOW/}{RMODFLOW pkgdown website} from the R console. 11 | } 12 | \examples{ 13 | rmf_browse() 14 | } 15 | \seealso{ 16 | \code{\link[=rmf_guide]{rmf_guide()}} for browsing the online guide pages. 17 | } 18 | -------------------------------------------------------------------------------- /man/rmf_calculate_thickness.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_calculate_thickness} 4 | \alias{rmf_calculate_thickness} 5 | \title{Calculate layer thicknesses} 6 | \usage{ 7 | rmf_calculate_thickness(dis, collapse_cbd = FALSE, only_layers = FALSE) 8 | } 9 | \arguments{ 10 | \item{dis}{\code{RMODFLOW} dis object} 11 | 12 | \item{collapse_cbd}{logical; should the thickness of an underlying confining bed be added to the overlying layer ? Defaults to FALSE.} 13 | 14 | \item{only_layers}{logical; should only the thicknesses of model layers be returned ? Defaults to FALSE} 15 | } 16 | \value{ 17 | rmf_3d_array with the layer thicknesses. If collapse_cbd = TRUE or only_layers = TRUE or if there are no confining beds present, there are \code{dis$nlay} layers. 18 | Otherwise there are \code{dis$nlay + number of confining beds} layers 19 | } 20 | \description{ 21 | Calculate layer thicknesses 22 | } 23 | \details{ 24 | The bottom layer can not have a confining bed below. 25 | When collapse_cbd is TRUE, thicknesses of confining beds are added to their respective overlying layers. The confining beds are then removed. 26 | When only_layers is TRUE, the thicknesses of all layers and confining beds are calculated and only the layers are returned. This is useful to calculate e.g. transmissivities. 27 | By default, thicknesses of confining layers are therefore also included in the returned array. 28 | } 29 | -------------------------------------------------------------------------------- /man/rmf_cell_dimensions.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_cell_dimensions} 4 | \alias{rmf_cell_dimensions} 5 | \alias{rmf_cell_dimensions.dis} 6 | \alias{rmf_cell_dimensions.huf} 7 | \title{Generic function to get cell dimensions} 8 | \usage{ 9 | rmf_cell_dimensions(...) 10 | 11 | \method{rmf_cell_dimensions}{dis}( 12 | dis, 13 | hed = NULL, 14 | include_volume = FALSE, 15 | include_faces = FALSE 16 | ) 17 | 18 | \method{rmf_cell_dimensions}{huf}( 19 | huf, 20 | dis = NULL, 21 | hed = NULL, 22 | include_volume = FALSE, 23 | include_faces = FALSE 24 | ) 25 | } 26 | \arguments{ 27 | \item{dis}{dis object} 28 | 29 | \item{hed}{hed object, used for calculating the saturated thickness; if not specified, the regular cell thickness is returned} 30 | 31 | \item{include_volume}{logical; should the cell volumes be included?} 32 | 33 | \item{include_faces}{logical; should face areas be included?} 34 | 35 | \item{huf}{huf object} 36 | } 37 | \value{ 38 | list with x y and z cell dimension 3d arrays and optionally, cell volume 39 | } 40 | \description{ 41 | Generic function to get cell dimensions 42 | } 43 | -------------------------------------------------------------------------------- /man/rmf_cell_info.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_cell_info} 4 | \alias{rmf_cell_info} 5 | \alias{rmf_cell_info.dis} 6 | \alias{rmf_cell_info.huf} 7 | \title{Generic function to print information at a certain grid cell} 8 | \usage{ 9 | rmf_cell_info(...) 10 | 11 | \method{rmf_cell_info}{dis}(dis, i, j) 12 | 13 | \method{rmf_cell_info}{huf}(huf, i, j) 14 | } 15 | \arguments{ 16 | \item{dis}{a discretization file object} 17 | 18 | \item{i}{row number} 19 | 20 | \item{j}{column number} 21 | 22 | \item{huf}{a hydrogeologic unit file object} 23 | } 24 | \value{ 25 | \code{NULL} 26 | } 27 | \description{ 28 | Generic function to print information at a certain grid cell 29 | } 30 | -------------------------------------------------------------------------------- /man/rmf_convert_cbc_to_darcy.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_convert_cbc_to_darcy} 4 | \alias{rmf_convert_cbc_to_darcy} 5 | \title{Convert cbc object fluxes to darcy velocities} 6 | \usage{ 7 | rmf_convert_cbc_to_darcy( 8 | cbc, 9 | dis, 10 | hed = NULL, 11 | porosity = NULL, 12 | include_bc = TRUE 13 | ) 14 | } 15 | \arguments{ 16 | \item{cbc}{\code{RMODFLOW} cbc object} 17 | 18 | \item{dis}{\code{RMODFLOW} dis object} 19 | 20 | \item{hed}{\code{RMODFLOW} hed object; optional; if specified, the saturated cell thickness is used} 21 | 22 | \item{porosity}{optional 3d array with porosity values. If used, the average linear groundwater flow velocities are returned.} 23 | 24 | \item{include_bc}{logical, should fluxes from boundary conditions be included in the calculation of Darcy fluxes ? Defaults to TRUE.} 25 | } 26 | \value{ 27 | list of 4d arrays: right, front, lower, left, back, upper, qx, qy, qz and q; all represent Darcy velocities (or average linear groundwater flow velocities if porosity is specified): the first six at the different cell faces, the last four represent the components and magnitude at the cell center 28 | } 29 | \description{ 30 | Convert cbc object fluxes to darcy velocities 31 | } 32 | -------------------------------------------------------------------------------- /man/rmf_convert_dis_to_saturated_dis.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_convert_dis_to_saturated_dis} 4 | \alias{rmf_convert_dis_to_saturated_dis} 5 | \title{Convert a dis object to correspond to the saturated volume} 6 | \usage{ 7 | rmf_convert_dis_to_saturated_dis(dis, hed, l = NULL, na_values = NULL) 8 | } 9 | \arguments{ 10 | \item{dis}{dis object} 11 | 12 | \item{hed}{hed object} 13 | 14 | \item{l}{integer used to subset the 4th dimension of \code{hed}. If not supplied, the final time step is used} 15 | 16 | \item{na_values}{optional; specifies which \code{hed} values should be set to \code{NA}} 17 | } 18 | \value{ 19 | \code{RMODFLOW} dis object corresponding to the saturated domain. 20 | } 21 | \description{ 22 | Convert a dis object to correspond to the saturated volume 23 | } 24 | -------------------------------------------------------------------------------- /man/rmf_convert_hed_to_water_table.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_convert_hed_to_water_table} 4 | \alias{rmf_convert_hed_to_water_table} 5 | \title{Obtain the water table elevation from a hydraulic head array} 6 | \usage{ 7 | rmf_convert_hed_to_water_table(hed, l = NULL, na_values = NULL) 8 | } 9 | \arguments{ 10 | \item{hed}{2d, 3d or 4d array with hydraulic heads} 11 | 12 | \item{l}{integer used to subset the 4th dimension of \code{hed}. If not supplied, the final time step is used} 13 | 14 | \item{na_values}{optional; specifies which \code{hed} values should be set to \code{NA}} 15 | } 16 | \value{ 17 | \code{rmf_2d_array} with the elevation of the water table, i.e. the first non-NA value in every vertical column of the grid 18 | } 19 | \description{ 20 | Obtain the water table elevation from a hydraulic head array 21 | } 22 | -------------------------------------------------------------------------------- /man/rmf_convert_hob_to_locations.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_convert_hob_to_locations} 4 | \alias{rmf_convert_hob_to_locations} 5 | \title{Convert a hob object to a locations data frame} 6 | \usage{ 7 | rmf_convert_hob_to_locations(hob, dis, prj = rmf_get_prj(dis)) 8 | } 9 | \arguments{ 10 | \item{hob}{\code{RMODFLOW} hob object} 11 | 12 | \item{dis}{\code{RMODFLOW} dis object} 13 | 14 | \item{prj}{prj object} 15 | } 16 | \value{ 17 | a data frame containing name, screened layer proportion pr, cell indices k, i, j and x, y & z coordinates 18 | } 19 | \description{ 20 | Convert a hob object to a locations data frame 21 | } 22 | \details{ 23 | returned z coordinate represents the center of the cell, not the top or bottom of the well screen 24 | } 25 | \seealso{ 26 | \code{\link{rmf_create_hob}}, \code{\link{rmf_convert_hob_to_time_series}} 27 | } 28 | -------------------------------------------------------------------------------- /man/rmf_convert_hob_to_time_series.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_convert_hob_to_time_series} 4 | \alias{rmf_convert_hob_to_time_series} 5 | \title{Convert a hob object to a time series data frame} 6 | \usage{ 7 | rmf_convert_hob_to_time_series(hob, dis, starttime = dis$starttime) 8 | } 9 | \arguments{ 10 | \item{hob}{\code{RMODFLOW} hob object} 11 | 12 | \item{dis}{\code{RMODFLOW} dis object} 13 | } 14 | \value{ 15 | time series data frame containing name, time and head columns 16 | } 17 | \description{ 18 | Convert a hob object to a time series data frame 19 | } 20 | \seealso{ 21 | \code{\link{rmf_create_hob}}, \code{\link{rmf_convert_hob_to_locations}} 22 | } 23 | -------------------------------------------------------------------------------- /man/rmf_convert_huf_to_dis.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_convert_huf_to_dis} 4 | \alias{rmf_convert_huf_to_dis} 5 | \title{Convert a huf to a dis object (for plotting)} 6 | \usage{ 7 | rmf_convert_huf_to_dis(huf, dis) 8 | } 9 | \arguments{ 10 | \item{huf}{huf object} 11 | 12 | \item{dis}{dis object, corresponding to the huf object} 13 | } 14 | \value{ 15 | dis object containing the layers of the huf object 16 | } 17 | \description{ 18 | Convert a huf to a dis object (for plotting) 19 | } 20 | -------------------------------------------------------------------------------- /man/rmf_convert_huf_to_mask.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_convert_huf_to_mask} 4 | \alias{rmf_convert_huf_to_mask} 5 | \title{Convert a huf to a mask object} 6 | \usage{ 7 | rmf_convert_huf_to_mask(huf, dis, bas = NULL) 8 | } 9 | \arguments{ 10 | \item{huf}{huf object} 11 | 12 | \item{dis}{dis object, corresponding to the huf object} 13 | 14 | \item{bas}{bas object, corresponding to the huf object; defaults to NULL} 15 | } 16 | \value{ 17 | mask rmf_3d_array 18 | } 19 | \description{ 20 | Convert a huf to a mask object 21 | } 22 | -------------------------------------------------------------------------------- /man/rmf_convert_ibound_to_neighbours.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_convert_ibound_to_neighbours} 4 | \alias{rmf_convert_ibound_to_neighbours} 5 | \title{Convert an \code{ibound} array to lower, upper, left, right, front and back logical arrays indicating presence of a neighbouring active cell} 6 | \usage{ 7 | rmf_convert_ibound_to_neighbours(ibound) 8 | } 9 | \arguments{ 10 | \item{ibound}{3d \code{ibound} array as specified in a MODFLOW BAS object} 11 | } 12 | \value{ 13 | list of lower, upper, left, right, front and back logical 3d arrays 14 | } 15 | \description{ 16 | Convert an \code{ibound} array to lower, upper, left, right, front and back logical arrays indicating presence of a neighbouring active cell 17 | } 18 | -------------------------------------------------------------------------------- /man/rmf_convert_id_to_id.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_convert_id_to_id} 4 | \alias{rmf_convert_id_to_id} 5 | \title{Convert id to id} 6 | \usage{ 7 | rmf_convert_id_to_id(id, dis, from = "modflow", to = "r") 8 | } 9 | \arguments{ 10 | \item{id}{cell id, providing the place of the number in an input file 2d or 3d array} 11 | 12 | \item{dis}{a discretisation file object} 13 | 14 | \item{from}{'r' or 'modflow'. The type of id to convert from. Defaults to 'modflow'} 15 | 16 | \item{to}{'r' or 'modflow'. The type of id to convert to. Defaults to 'r'} 17 | } 18 | \description{ 19 | Convert id to id 20 | } 21 | \details{ 22 | a modflow id provides the place of the number in an input file 3d array (not like the way R uses ids for arrays or matrices; rows and columns are switched) 23 | } 24 | -------------------------------------------------------------------------------- /man/rmf_convert_id_to_ijk.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_convert_id_to_ijk} 4 | \alias{rmf_convert_id_to_ijk} 5 | \title{Convert id to ijk} 6 | \usage{ 7 | rmf_convert_id_to_ijk(id, dis, type = "r") 8 | } 9 | \arguments{ 10 | \item{id}{cell id, providing the place of the number in an input file 3d array} 11 | 12 | \item{dis}{a discretisation file object} 13 | 14 | \item{type}{'r' or 'modflow' specifying type of id. See details. Defaults to 'r'} 15 | } 16 | \description{ 17 | Convert id to ijk 18 | } 19 | \details{ 20 | a modflow id provides the place of the number in an input file 3d array (not like the way R uses ids for arrays or matrices; rows and columns are switched) 21 | } 22 | -------------------------------------------------------------------------------- /man/rmf_convert_ijk_to_id.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_convert_ijk_to_id} 4 | \alias{rmf_convert_ijk_to_id} 5 | \title{Convert ijk to id} 6 | \usage{ 7 | rmf_convert_ijk_to_id(i, j, k, dis, type = "r") 8 | } 9 | \arguments{ 10 | \item{i}{vector of row numbers} 11 | 12 | \item{j}{vector of column numbers} 13 | 14 | \item{k}{vector of layer numbers} 15 | 16 | \item{dis}{a discretization file object} 17 | 18 | \item{type}{'r' or 'modflow' specifying type of id. See details. Defaults to 'r'} 19 | } 20 | \value{ 21 | cell ids, providing the place of the cell in an input file 3d array 22 | } 23 | \description{ 24 | Convert ijk to id 25 | } 26 | \details{ 27 | a modflow id provides the place of the number in an input file 3d array (not like the way R uses ids for arrays or matrices; rows and columns are switched) 28 | } 29 | -------------------------------------------------------------------------------- /man/rmf_convert_lpf_to_upw.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_convert_lpf_to_upw} 4 | \alias{rmf_convert_lpf_to_upw} 5 | \title{Convert a lpf to a upw object} 6 | \usage{ 7 | rmf_convert_lpf_to_upw(lpf, iphdry = TRUE) 8 | } 9 | \arguments{ 10 | \item{lpf}{\code{RMODFLOW} lpf object} 11 | 12 | \item{iphdry}{logical; indicating if head will be set to hdry when it's less than 1E-4 above the cell bottom; defaults to TRUE} 13 | } 14 | \value{ 15 | Object of class upw 16 | } 17 | \description{ 18 | Convert a lpf to a upw object 19 | } 20 | \note{ 21 | upw input structure is nearly identical to lpf but calculations are done differently. Differences include the addition of the iphdry value and the omission of optional keywords. Layer wetting capabilities are also not supported by upw. 22 | 23 | upw must be used with the Newton solver. See also \code{\link{rmf_create_nwt}}. 24 | } 25 | \seealso{ 26 | \code{\link{rmf_create_upw}}, \code{\link{rmf_convert_upw_to_lpf}} and \url{https://water.usgs.gov/ogw/modflow-nwt/MODFLOW-NWT-Guide/} 27 | } 28 | -------------------------------------------------------------------------------- /man/rmf_copy_to_wd.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_copy_to_wd} 4 | \alias{rmf_copy_to_wd} 5 | \title{Copy files from specified paths to current working directory} 6 | \usage{ 7 | rmf_copy_to_wd(filenames, ...) 8 | } 9 | \arguments{ 10 | \item{filenames}{character vector of filenames} 11 | 12 | \item{...}{additional arguments provided to file.copy} 13 | } 14 | \description{ 15 | Copy files from specified paths to current working directory 16 | } 17 | -------------------------------------------------------------------------------- /man/rmf_create.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/modflow.R 3 | \name{rmf_create} 4 | \alias{rmf_create} 5 | \title{Create an \code{RMODFLOW} modflow object} 6 | \usage{ 7 | rmf_create(..., cbc = NULL, recreate_nam = FALSE, basename = NULL) 8 | } 9 | \arguments{ 10 | \item{...}{(list of) \code{RMODFLOW} objects of class \code{rmf_package} to be included in the modflow object. If a nam object is not provided, it is added automatically.} 11 | 12 | \item{cbc}{optional integer; sets the flag and unit number for writing cell-by-cell flow data. Overwrites the values set in the objects. Defaults to NULL.} 13 | 14 | \item{recreate_nam}{logical; if a nam object is supplied, should it be recreated from scratch ? Defaults to FALSE} 15 | 16 | \item{basename}{character specifying the basename of the files if the nam object is (re)created. The default (\code{NULL}) sets input basenames to 'input' and output to 'output'.} 17 | } 18 | \value{ 19 | a \code{modflow} object which is a list containing all MODFLOW packages 20 | } 21 | \description{ 22 | \code{rmf_create} creates an \code{RMODFLOW} modflow object from \code{rmf_package} objects 23 | } 24 | \seealso{ 25 | \code{\link{rmf_read}}, \code{\link{rmf_write}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html} 26 | } 27 | -------------------------------------------------------------------------------- /man/rmf_create_chd.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-chd.R 3 | \name{rmf_create_chd} 4 | \alias{rmf_create_chd} 5 | \title{Create an \code{RMODFLOW} chd object.} 6 | \usage{ 7 | rmf_create_chd(..., dis, noprint = FALSE, aux = NULL) 8 | } 9 | \arguments{ 10 | \item{...}{\code{rmf_list} (possibly of class \code{rmf_parameter}) objects or a single \code{list} with \code{rmf_list} objects (possibly of class \code{rmf_parameter}) elements; defines the constant head cells} 11 | 12 | \item{dis}{dis object} 13 | 14 | \item{noprint}{logical, should the printing of CHD cells to the listing file be suppressed ? Defaults to \code{FALSE}} 15 | 16 | \item{aux}{optional character vector specifying the names of the auxiliary variables. These variables should also be included in the \code{rmf_list} objects that are supplied; defaults to \code{NULL}} 17 | } 18 | \value{ 19 | \code{RMODFLOW} chd object 20 | } 21 | \description{ 22 | \code{rmf_create_chd} creates an \code{RMODFLOW} chd object 23 | } 24 | \seealso{ 25 | \code{\link{rmf_read_chd}}, \code{\link{rmf_write_chd}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?chd.htm} 26 | } 27 | -------------------------------------------------------------------------------- /man/rmf_create_drn.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-drn.R 3 | \name{rmf_create_drn} 4 | \alias{rmf_create_drn} 5 | \title{Create an \code{RMODFLOW} drn object.} 6 | \usage{ 7 | rmf_create_drn(..., dis, idrncb = 0, noprint = FALSE, aux = NULL) 8 | } 9 | \arguments{ 10 | \item{...}{\code{rmf_list} (possibly of class \code{rmf_parameter}) objects or a single \code{list} with \code{rmf_list} objects (possibly of class \code{rmf_parameter}) elements; defines the drains.} 11 | 12 | \item{dis}{dis object} 13 | 14 | \item{idrncb}{flag and unit number for writing cell-by-cell flow terms; defaults to 0 (cell-by-cell flow terms will not be written)} 15 | 16 | \item{noprint}{logical, should the printing of DRN cells to the listing file be suppressed ? Defaults to \code{FALSE}} 17 | 18 | \item{aux}{optional character vector specifying the names of the auxiliary variables. These variables should also be included in the \code{rmf_list} objects that are supplied; defaults to \code{NULL}} 19 | } 20 | \value{ 21 | \code{RMODFLOW} drn object 22 | } 23 | \description{ 24 | \code{rmf_create_drn} creates an \code{RMODFLOW} drn object 25 | } 26 | \seealso{ 27 | \code{\link{rmf_read_drn}}, \code{\link{rmf_write_drn}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?drn.htm} 28 | } 29 | -------------------------------------------------------------------------------- /man/rmf_create_ghb.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-ghb.R 3 | \name{rmf_create_ghb} 4 | \alias{rmf_create_ghb} 5 | \title{Create an \code{RMODFLOW} ghb object.} 6 | \usage{ 7 | rmf_create_ghb(..., dis, ighbcb = 0, noprint = FALSE, aux = NULL) 8 | } 9 | \arguments{ 10 | \item{...}{\code{rmf_list} (possibly of class \code{rmf_parameter}) objects or a single \code{list} with \code{rmf_list} objects (possibly of class \code{rmf_parameter}) elements; defines the general-head boundary cells.} 11 | 12 | \item{dis}{dis object} 13 | 14 | \item{ighbcb}{flag and unit number for writing cell-by-cell flow terms; defaults to 0 (cell-by-cell flow terms will not be written)} 15 | 16 | \item{noprint}{logical, should the printing of GHB cells to the listing file be suppressed ? Defaults to \code{FALSE}} 17 | 18 | \item{aux}{optional character vector specifying the names of the auxiliary variables. These variables should also be included in the \code{rmf_list} objects that are supplied; defaults to \code{NULL}} 19 | } 20 | \value{ 21 | \code{RMODFLOW} ghb object 22 | } 23 | \description{ 24 | \code{rmf_create_ghb} creates an \code{RMODFLOW} ghb object 25 | } 26 | \seealso{ 27 | \code{\link{rmf_read_ghb}}, \code{\link{rmf_write_ghb}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?ghb.htm} 28 | } 29 | -------------------------------------------------------------------------------- /man/rmf_create_hfb.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-hfb.R 3 | \name{rmf_create_hfb} 4 | \alias{rmf_create_hfb} 5 | \title{Create an \code{RMODFLOW} hfb object.} 6 | \usage{ 7 | rmf_create_hfb(..., dis, noprint = FALSE) 8 | } 9 | \arguments{ 10 | \item{...}{\code{rmf_list} (possibly of class \code{rmf_parameter}) objects or a single \code{list} with \code{rmf_list} objects (possibly of class \code{rmf_parameter}) elements; defines the horizontal-flow barriers.} 11 | 12 | \item{dis}{dis object} 13 | 14 | \item{noprint}{logical, should the printing of HFB cells to the listing file be suppressed ? Defaults to \code{FALSE}} 15 | } 16 | \value{ 17 | \code{RMODFLOW} hfb object 18 | } 19 | \description{ 20 | \code{rmf_create_hfb} creates an \code{RMODFLOW} hfb object 21 | } 22 | \details{ 23 | As an alternative to specifying \code{irow2} and \code{icol2}, a \code{direction} column can be present in the rmf_lists objects to specify the direction of the horizontal flow barrier with respect to \code{i & j}. 24 | Allowed values for the \code{direction} column are \code{"right"}, \code{"back"}, \code{"left"} and \code{"front"}. 25 | } 26 | \seealso{ 27 | \code{\link{rmf_read_hfb}}, \code{\link{rmf_write_hfb}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?hfb6.htm} 28 | } 29 | -------------------------------------------------------------------------------- /man/rmf_create_kdep.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-huf.R 3 | \name{rmf_create_kdep} 4 | \alias{rmf_create_kdep} 5 | \title{Create an \code{RMODFLOW} kdep object} 6 | \usage{ 7 | rmf_create_kdep(parameters, rs = NULL, dis) 8 | } 9 | \arguments{ 10 | \item{parameters}{either a single \code{rmf_parameter} or a list of \code{rmf_parameters} specifying the depth-dependency coefficients. See details.} 11 | 12 | \item{rs}{optional 2d array specifying the reference elevation surface} 13 | 14 | \item{dis}{\code{RMODFLOW} dis object. Only used if \code{rs} is supplied.} 15 | } 16 | \value{ 17 | a \code{RMODFLOW} kdep object 18 | } 19 | \description{ 20 | \code{rmf_create_kdep} creates an \code{RMODFLOW} kdep object. 21 | } 22 | \details{ 23 | All parameters should have a hgunam attribute and their partyp attribute set to 'KDEP'. 24 | The KDEP package can only be used in conjunction with the HUF package. 25 | Note that the parameters are defined on the HUF grid, not the numerical grid 26 | \code{\link{rmf_convert_huf_to_grid}} can be used to convert parameters defined on the HUF grid to the numerical grid 27 | } 28 | \seealso{ 29 | \code{link{rmf_convert_huf_to_grid}}, \code{\link{rmf_read_kdep}}, \code{\link{rmf_write_kdep}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?kdep.htm} 30 | } 31 | -------------------------------------------------------------------------------- /man/rmf_create_list.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_create_list} 4 | \alias{rmf_create_list} 5 | \title{Add rmf list class to data.frame and check if k, i and j columns are present} 6 | \usage{ 7 | rmf_create_list(df, kper = NULL) 8 | } 9 | \arguments{ 10 | \item{df}{data.frame that holds at least the k, i and j columns that specify cell indices as well as additional variables related to the boundary condition package.} 11 | 12 | \item{kper}{numeric vector with the stress period numbers during which the list is active.} 13 | } 14 | \value{ 15 | an object of class \code{rmf_list} and \code{data.frame} 16 | } 17 | \description{ 18 | Add rmf list class to data.frame and check if k, i and j columns are present 19 | } 20 | \details{ 21 | \if{html}{\out{
}}\preformatted{ rmf_lists represent List Data input (and output) as used by MODFLOW. rmf_lists are used to define stress period input for boundary condition packages; 22 | to define parameters and to read certain types of output in the the cell-by-cell budget file. A MODFLOW List Data can be viewed as discrete spatial features in contrast to the MODFLOW array data type which represents continuous data. 23 | 24 | A rmf_list is a dataframe with at least 3 integer columns k, i and j, that may contain repeated values. 25 | }\if{html}{\out{
}} 26 | } 27 | -------------------------------------------------------------------------------- /man/rmf_create_lmt.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-lmt.R 3 | \name{rmf_create_lmt} 4 | \alias{rmf_create_lmt} 5 | \title{Create a \code{RMODFLOW} lmt object} 6 | \usage{ 7 | rmf_create_lmt( 8 | fname = "output.ftl", 9 | inftl = 333, 10 | extended = TRUE, 11 | formatted = FALSE, 12 | package_flows = NULL 13 | ) 14 | } 15 | \arguments{ 16 | \item{fname}{character; name of the flow-transport link file produced. Defaults to \code{'output.ftl'}} 17 | 18 | \item{inftl}{integer; unit number on which the flow-transport link file will be saved; defaults to 333} 19 | 20 | \item{extended}{logical; should the extended header be used (instead of the standard header); defaults to TRUE} 21 | 22 | \item{formatted}{logical; should the file be formatted. Under the default (FALSE), an unformatted flow-transport link file will be created by lmt} 23 | 24 | \item{package_flows}{optional; additional flows to be saved in the flow-transport link file. Possible values are \code{'ALL'} or any combination of \code{'UZF', 'SFR' or 'LAK'}. Defaults to not including any of the above.} 25 | } 26 | \value{ 27 | object of class lmt 28 | } 29 | \description{ 30 | Create a \code{RMODFLOW} lmt object 31 | } 32 | \examples{ 33 | rmf_create_lmt(fname = file.path('..', 'transport', 'output.ftl'), formatted = TRUE, package_flows = c('UZF', 'LAK')) 34 | 35 | } 36 | \seealso{ 37 | \code{\link{rmf_read_lmt}}, \code{\link{rmf_write_lmt}} and \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?lmt6.htm} 38 | } 39 | -------------------------------------------------------------------------------- /man/rmf_create_lvda.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-huf.R 3 | \name{rmf_create_lvda} 4 | \alias{rmf_create_lvda} 5 | \title{Create an \code{RMODFLOW} lvda object} 6 | \usage{ 7 | rmf_create_lvda(parameters, dis) 8 | } 9 | \arguments{ 10 | \item{parameters}{either a single \code{rmf_parameter} or a list of \code{rmf_parameters} specifying the angle between the grid axis and the principal direction of horizontal hydraulic conductivity. See details.} 11 | 12 | \item{dis}{\code{RMODFLOW} dis object} 13 | } 14 | \value{ 15 | a \code{RMODFLOW} lvda object 16 | } 17 | \description{ 18 | \code{rmf_create_lvda} creates an \code{RMODFLOW} lvda object. 19 | } 20 | \details{ 21 | All parameters should have a layer attribute and their partyp attribute set to 'LVDA'. 22 | The LVDA package can only be used in conjunction with the HUF package. 23 | Note that the parameters are defined on the numerical grid, not the HUF grid 24 | } 25 | \seealso{ 26 | \code{\link{rmf_read_lvda}}, \code{\link{rmf_write_lvda}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?lvda.htm} 27 | } 28 | -------------------------------------------------------------------------------- /man/rmf_create_nam.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-nam.R 3 | \name{rmf_create_nam} 4 | \alias{rmf_create_nam} 5 | \title{Create an \code{RMODFLOW} nam object} 6 | \usage{ 7 | rmf_create_nam(..., basename = NULL) 8 | } 9 | \arguments{ 10 | \item{...}{RMODFLOW objects to be included in the nam file} 11 | 12 | \item{basename}{character specifying the basename of the files. The default (\code{NULL}) sets input basenames to 'input' and output to 'output'.} 13 | } 14 | \value{ 15 | Object of class nam 16 | } 17 | \description{ 18 | \code{rmf_create_nam} creates an \code{RMODFLOW} nam object. 19 | } 20 | \details{ 21 | if a \code{RMODFLOW nam} object is present, it is recreated. 22 | } 23 | \seealso{ 24 | \code{\link{rmf_read_nam}}, \code{\link{rmf_write_nam}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?name_file.htm} 25 | } 26 | -------------------------------------------------------------------------------- /man/rmf_create_parameter.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_create_parameter} 4 | \alias{rmf_create_parameter} 5 | \title{Create a MODFLOW parameter} 6 | \usage{ 7 | rmf_create_parameter(...) 8 | } 9 | \description{ 10 | Create a MODFLOW parameter 11 | } 12 | -------------------------------------------------------------------------------- /man/rmf_create_parameter.rmf_list.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_create_parameter.rmf_list} 4 | \alias{rmf_create_parameter.rmf_list} 5 | \title{Create a List Data input parameter} 6 | \usage{ 7 | \method{rmf_create_parameter}{rmf_list}( 8 | rmf_list, 9 | parnam, 10 | parval = 1, 11 | instnam = NULL, 12 | kper = attr(rmf_list, "kper") 13 | ) 14 | } 15 | \arguments{ 16 | \item{rmf_list}{a rmf_list object} 17 | 18 | \item{parnam}{character specifying the name of the parameter} 19 | 20 | \item{parval}{numeric specifying the value of the parameter which is used to multiply the flux controlling variable in the data.frame. Defaults to 1.0} 21 | 22 | \item{instnam}{optional character specying the instance name of the parameter is to be time-varying; defaults to NULL} 23 | } 24 | \value{ 25 | an object of class \code{rmf_parameter} and \code{rmf_list} 26 | } 27 | \description{ 28 | Create a parameter for List Data input used in MODFLOW boundary condition packages. 29 | } 30 | \details{ 31 | the variable in the data.frame which is multiplied differs between boundary condition packages. 32 | if the parameter is to be time-varying, a separate parameter should be created for each instance with a unique \code{instnam} but with the same \code{name} 33 | } 34 | \seealso{ 35 | \code{\link{rmf_create_list}} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_create_pval.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-pval.R 3 | \name{rmf_create_pval} 4 | \alias{rmf_create_pval} 5 | \title{Create an \code{RMODFLOW} pval object} 6 | \usage{ 7 | rmf_create_pval(parnam, parval = NULL, np = NULL) 8 | } 9 | \arguments{ 10 | \item{parnam}{character vector specifying the parameter names, in which case 11 | at least \code{parval} has to be provided as well, named numeric vector 12 | containing the parameter values, or data frame containing a \code{parnam} and 13 | \code{parval} column} 14 | 15 | \item{parval}{numeric vector specifying the parameter values; defaults to 16 | NULL, in which case values are extracted from \code{parnam}} 17 | 18 | \item{np}{number of MODFLOW-supported parameters; defaults to NULL, in which 19 | case the total number of parameters is determined from \code{parnam}} 20 | } 21 | \value{ 22 | an \code{RMODFLOW} pval object 23 | } 24 | \description{ 25 | \code{rmf_create_pval} creates an \code{RMODFLOW} pval object 26 | } 27 | \details{ 28 | parnam & parval should be of the same length. Extra parameters that 29 | are not supported by MODFLOW can be introduced, but np should be adjusted 30 | accordingly (\emph{i.e.} not accounting for the extra parameters), and hence set 31 | explicitly. For details on working with these extra parameters, see the 32 | \code{preprocess} argument to \code{rmf_execute()}. 33 | } 34 | \seealso{ 35 | \code{\link{rmf_read_pval}}, \code{\link{rmf_write_pval}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?parameter_value_file.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_create_riv.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-riv.R 3 | \name{rmf_create_riv} 4 | \alias{rmf_create_riv} 5 | \title{Create an \code{RMODFLOW} riv object.} 6 | \usage{ 7 | rmf_create_riv(..., dis, irivcb = 0, noprint = FALSE, aux = NULL) 8 | } 9 | \arguments{ 10 | \item{...}{\code{rmf_list} (possibly of class \code{rmf_parameter}) objects or a single \code{list} with \code{rmf_list} objects (possibly of class \code{rmf_parameter}) elements; defines the rivers.} 11 | 12 | \item{dis}{dis object} 13 | 14 | \item{irivcb}{flag and unit number for writing cell-by-cell flow terms; defaults to 0 (cell-by-cell flow terms will not be written)} 15 | 16 | \item{noprint}{logical, should the printing of RIV cells to the listing file be suppressed ? Defaults to \code{FALSE}} 17 | 18 | \item{aux}{optional character vector specifying the names of the auxiliary variables. These variables should also be included in the \code{rmf_list} objects that are supplied; defaults to \code{NULL}} 19 | } 20 | \value{ 21 | \code{RMODFLOW} riv object 22 | } 23 | \description{ 24 | \code{rmf_create_riv} creates an \code{RMODFLOW} riv object 25 | } 26 | \seealso{ 27 | \code{\link{rmf_read_riv}}, \code{\link{rmf_write_riv}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?riv.htm} 28 | } 29 | -------------------------------------------------------------------------------- /man/rmf_create_sip.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-sip.R 3 | \name{rmf_create_sip} 4 | \alias{rmf_create_sip} 5 | \title{Create an \code{RMODFLOW} sip object.} 6 | \usage{ 7 | rmf_create_sip( 8 | mxiter = 50, 9 | nparm = 5, 10 | accl = 1, 11 | hclose = 0.01, 12 | ipcalc = 1, 13 | wseed = 0, 14 | iprsip = 0 15 | ) 16 | } 17 | \arguments{ 18 | \item{mxiter}{maximum number of iterations in one time step attempting to solve the equations; defaults to 50} 19 | 20 | \item{nparm}{number of iteration variables; defaults to 5} 21 | 22 | \item{accl}{acceleration variable; defaults to 1} 23 | 24 | \item{hclose}{head change criterion for convergence in units of length; defaults to 0.01} 25 | 26 | \item{ipcalc}{flag indicating where the seed for calculating iteration variables comes from; defaults to 1} 27 | 28 | \item{wseed}{user-specified seed for calculating iteration variables; defaults to 0} 29 | 30 | \item{iprsip}{printout interval for maximum head change; defaults to 0} 31 | } 32 | \value{ 33 | \code{RMODFLOW} sip object 34 | } 35 | \description{ 36 | \code{rmf_create_sip} creates an \code{RMODFLOW} sip object 37 | } 38 | \seealso{ 39 | \code{\link{rmf_read_sip}}, \code{\link{rmf_write_sip}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?sip.htm} 40 | } 41 | -------------------------------------------------------------------------------- /man/rmf_create_wel.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-wel.R 3 | \name{rmf_create_wel} 4 | \alias{rmf_create_wel} 5 | \title{Create an \code{RMODFLOW} wel object.} 6 | \usage{ 7 | rmf_create_wel(..., dis, iwelcb = 0, noprint = FALSE, aux = NULL) 8 | } 9 | \arguments{ 10 | \item{...}{\code{rmf_list} (possibly of class \code{rmf_parameter}) objects or a single \code{list} with \code{rmf_list} objects (possibly of class \code{rmf_parameter}) elements; defines the wells.} 11 | 12 | \item{dis}{dis object} 13 | 14 | \item{iwelcb}{flag and unit number for writing cell-by-cell flow terms; defaults to 0 (cell-by-cell flow terms will not be written)} 15 | 16 | \item{noprint}{logical, should the printing of WEL cells to the listing file be suppressed ? Defaults to \code{FALSE}} 17 | 18 | \item{aux}{optional character vector specifying the names of the auxiliary variables. These variables should also be included in the \code{rmf_list} objects that are supplied; defaults to \code{NULL}} 19 | } 20 | \value{ 21 | \code{RMODFLOW} wel object 22 | } 23 | \description{ 24 | \code{rmf_create_wel} creates an \code{RMODFLOW} wel object 25 | } 26 | \seealso{ 27 | \code{\link{rmf_read_wel}}, \code{\link{rmf_write_wel}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?wel.htm} 28 | } 29 | -------------------------------------------------------------------------------- /man/rmf_create_zon.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-zon.R 3 | \name{rmf_create_zon} 4 | \alias{rmf_create_zon} 5 | \title{Create an \code{RMODFLOW} zon object} 6 | \usage{ 7 | rmf_create_zon( 8 | nzn = length(zonnam), 9 | zonnam = "ZONE", 10 | izon = rmf_create_array(1L, dim = c(10, 10)) 11 | ) 12 | } 13 | \arguments{ 14 | \item{nzn}{number of zone arrays to be defined; defaults to the length of zonnam} 15 | 16 | \item{zonnam}{character vector of length \code{nzn} specifying the names of zone arrays; defaults to 'ZONE'} 17 | 18 | \item{izon}{either a single 2d array or list with \code{nzn} 2d_arrays specifying the zone arrays; defaults to a \code{rmf_2d_array} with 1 for all cells} 19 | } 20 | \value{ 21 | an \code{RMODFLOW} zon object 22 | } 23 | \description{ 24 | \code{rmf_create_zon} creates an \code{RMODFLOW} zon object 25 | } 26 | \seealso{ 27 | \code{\link{rmf_read_zon}}, \code{\link{rmf_write_zon}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?zone.htm} 28 | } 29 | -------------------------------------------------------------------------------- /man/rmf_example.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/examples.R 3 | \name{rmf_example} 4 | \alias{rmf_example} 5 | \title{Access example MODFLOW files} 6 | \usage{ 7 | rmf_example(name = NULL, code = NULL) 8 | } 9 | \arguments{ 10 | \item{name}{filename or model name; if NULL provides a list of possibilities} 11 | 12 | \item{code}{identification of the MODFLOW variant, only required for the 13 | examples that come with the code archives available online} 14 | } 15 | \value{ 16 | character vector of model or file names/paths 17 | } 18 | \description{ 19 | Access example MODFLOW files 20 | } 21 | -------------------------------------------------------------------------------- /man/rmf_example_file.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/examples.R 3 | \name{rmf_example_file} 4 | \alias{rmf_example_file} 5 | \title{Path to example file} 6 | \usage{ 7 | rmf_example_file(filename = NULL) 8 | } 9 | \arguments{ 10 | \item{filename}{filename of the example file} 11 | } 12 | \value{ 13 | path to example file 14 | } 15 | \description{ 16 | Path to example file 17 | } 18 | -------------------------------------------------------------------------------- /man/rmf_example_files.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/examples.R 3 | \name{rmf_example_files} 4 | \alias{rmf_example_files} 5 | \title{Path to example files} 6 | \usage{ 7 | rmf_example_files(pattern = NULL) 8 | } 9 | \arguments{ 10 | \item{pattern}{pattern to match example file filenames. If NULL (default), returns vector of all example file filenames.} 11 | } 12 | \value{ 13 | path to example files 14 | } 15 | \description{ 16 | Path to example files 17 | } 18 | -------------------------------------------------------------------------------- /man/rmf_example_model.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/examples.R 3 | \name{rmf_example_model} 4 | \alias{rmf_example_model} 5 | \title{List example model files} 6 | \usage{ 7 | rmf_example_model(model = NULL) 8 | } 9 | \arguments{ 10 | \item{model}{} 11 | } 12 | \value{ 13 | example model files 14 | } 15 | \description{ 16 | List example model files 17 | } 18 | -------------------------------------------------------------------------------- /man/rmf_example_models.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/examples.R 3 | \name{rmf_example_models} 4 | \alias{rmf_example_models} 5 | \title{List example models} 6 | \usage{ 7 | rmf_example_models() 8 | } 9 | \value{ 10 | example model names 11 | } 12 | \description{ 13 | List example models 14 | } 15 | -------------------------------------------------------------------------------- /man/rmf_extent.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/spatial.R 3 | \name{rmf_extent} 4 | \alias{rmf_extent} 5 | \title{Obtain the corners and bounding box of the MODFLOW grid} 6 | \usage{ 7 | rmf_extent(dis, prj = rmf_get_prj(dis)) 8 | } 9 | \arguments{ 10 | \item{dis}{\code{RMODFLOW} dis object} 11 | 12 | \item{prj}{optional \code{RMODFLOW} prj object} 13 | } 14 | \value{ 15 | a list with (1) the coordinates of the grid corners as a data.frame and (2) the bounding box of the grid as 16 | a \code{sf bbox} object 17 | } 18 | \description{ 19 | Obtain the corners and bounding box of the MODFLOW grid 20 | } 21 | \examples{ 22 | dis <- rmf_create_dis() 23 | prj <- rmf_create_prj(origin = c(152082, 168000.2), rotation = -12, crs = 31370) 24 | rmf_extent(dis, prj) 25 | 26 | } 27 | -------------------------------------------------------------------------------- /man/rmf_guide.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/web.R 3 | \name{rmf_guide} 4 | \alias{rmf_guide} 5 | \title{Launch the online guide pages} 6 | \usage{ 7 | rmf_guide(name = NULL) 8 | } 9 | \arguments{ 10 | \item{name}{Name of the \code{.htm} file linked to in the online guide contents or 11 | index menu. If \code{NULL} (default), the introduction page is launched.} 12 | } 13 | \description{ 14 | This function can be used to launch the \href{https://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/}{Online Guide to MODFLOW} or 15 | specific pages thereof. Other online guides are available as well, but this 16 | one should be the most complete version with information on all different 17 | MODFLOW 2005 variants that are part of the RMODFLOW scope. Some shortcuts are 18 | available as well, to more easily access some of the pages through the 19 | MODFLOW file type or ModelMuse file extension conventions. 20 | } 21 | \examples{ 22 | rmf_guide() # Launches the introduction page. 23 | rmf_guide("name_file") # Launches the "name_file.htm" page. 24 | rmf_guide("nam") # Launches the same page using the "nam" shortcut. 25 | } 26 | \seealso{ 27 | \code{\link[=rmf_browse]{rmf_browse()}} for launching the \href{https://rogiersbart.github.io/RMODFLOW/}{RMODFLOW pkgdown website}. 28 | } 29 | -------------------------------------------------------------------------------- /man/rmf_performance.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_performance} 4 | \alias{rmf_performance} 5 | \alias{rmf_performance.default} 6 | \alias{rmf_performance.hpr} 7 | \title{Generic function to get model performance measures} 8 | \usage{ 9 | rmf_performance(...) 10 | 11 | \method{rmf_performance}{default}( 12 | sim, 13 | obs, 14 | na_value = -888, 15 | measures = c("ssq", "mse", "mae", "me", "r2", "nse", "rmse", "pbias", "kge"), 16 | ... 17 | ) 18 | 19 | \method{rmf_performance}{hpr}( 20 | hpr, 21 | hobdry = -888, 22 | measures = c("ssq", "mse", "mae", "me", "r2", "nse", "rmse", "pbias", "kge"), 23 | ... 24 | ) 25 | } 26 | \arguments{ 27 | \item{...}{arguments passes to \code{\link{hydroGOF::gof}}} 28 | 29 | \item{sim}{numeric vector with simulated values} 30 | 31 | \item{obs}{numeric vector with observed values corresponding to sim} 32 | 33 | \item{na_value}{numeric; flags values to remove from the calculations; defaults to -888} 34 | 35 | \item{measures}{character vector with the required performance measures. Possible values are any of the measures present in \code{\link{hydroGOF::gof}} + 'ssq' (sum of squared errors)} 36 | 37 | \item{hpr}{head predictions file object} 38 | 39 | \item{hobdry}{value used to flag dry cells; defaults to -888} 40 | } 41 | \value{ 42 | data.frame with performance measures 43 | 44 | data.frame with performance measures 45 | } 46 | \description{ 47 | Generic function to get model performance measures 48 | 49 | Get model performance measures 50 | 51 | Get model performance measures from a hpr object 52 | } 53 | -------------------------------------------------------------------------------- /man/rmf_plot.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/plot.R 3 | \name{rmf_plot} 4 | \alias{rmf_plot} 5 | \title{Generic function for static 2D plotting} 6 | \usage{ 7 | rmf_plot(...) 8 | } 9 | \description{ 10 | Generic function for static 2D plotting 11 | } 12 | -------------------------------------------------------------------------------- /man/rmf_plot.evt.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/plot.R 3 | \name{rmf_plot.evt} 4 | \alias{rmf_plot.evt} 5 | \title{Plot a RMODFLOW evt object} 6 | \usage{ 7 | \method{rmf_plot}{evt}(evt, dis, kper = NULL, variable = "evt", ...) 8 | } 9 | \arguments{ 10 | \item{evt}{an \code{RMODFLOW} evt object} 11 | 12 | \item{dis}{a \code{RMODFLOW} dis object} 13 | 14 | \item{kper}{integer specifying the stress-period to plot} 15 | 16 | \item{variable}{character specifying which variable to plot. Possible values are 'evt' (default), 'surf', 'exdp' and 'ievt' if defined.} 17 | 18 | \item{...}{additional arguments passed to \code{\link{rmf_plot.rmf_2d_array}}} 19 | } 20 | \value{ 21 | ggplot2 object or layer; if plot3D is TRUE, nothing is returned and the plot is made directly 22 | } 23 | \description{ 24 | Plot a RMODFLOW evt object 25 | } 26 | -------------------------------------------------------------------------------- /man/rmf_plot.hob.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/plot.R 3 | \name{rmf_plot.hob} 4 | \alias{rmf_plot.hob} 5 | \title{Plot a RMODFLOW hob object} 6 | \usage{ 7 | \method{rmf_plot}{hob}( 8 | hob, 9 | dis, 10 | i = NULL, 11 | j = NULL, 12 | k = NULL, 13 | prj = rmf_get_prj(dis), 14 | kper = NULL, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{hob}{\code{RMODFLOW} hob object} 20 | 21 | \item{dis}{\code{RMODFLOW} dis object} 22 | 23 | \item{i}{row number to plot} 24 | 25 | \item{j}{column number to plot} 26 | 27 | \item{k}{layer number to plot} 28 | 29 | \item{prj}{projection file object; defaults to NULL} 30 | 31 | \item{kper}{integer specifying the stress-period to plot} 32 | 33 | \item{...}{additional arguments passed to \code{\link{rmf_plot.rmf_list}}} 34 | } 35 | \value{ 36 | ggplot2 object or layer 37 | } 38 | \description{ 39 | Plot a RMODFLOW hob object 40 | } 41 | \details{ 42 | specifying all of the \code{i, j & k} arguments will plot a time series at that cell location. The observations are grouped by name. 43 | } 44 | -------------------------------------------------------------------------------- /man/rmf_plot.hpr.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/plot.R 3 | \name{rmf_plot.hpr} 4 | \alias{rmf_plot.hpr} 5 | \title{Plot a MODFLOW head predictions file} 6 | \usage{ 7 | \method{rmf_plot}{hpr}(hpr, type = "scatter", hobdry = -888, bins = NULL) 8 | } 9 | \arguments{ 10 | \item{hpr}{head predictions file object} 11 | 12 | \item{type}{plot type: 'scatter', 'residual' or 'histogram'} 13 | 14 | \item{hobdry}{value used to flag dry cells; defaults to -888} 15 | 16 | \item{bins}{number of bins to use in the histrogram plot; defaults to the Freedman-Diaconis rule} 17 | } 18 | \description{ 19 | Plot a MODFLOW head predictions file 20 | } 21 | -------------------------------------------------------------------------------- /man/rmf_plot.rch.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/plot.R 3 | \name{rmf_plot.rch} 4 | \alias{rmf_plot.rch} 5 | \title{Plot a RMODFLOW rch object} 6 | \usage{ 7 | \method{rmf_plot}{rch}(rch, dis, kper = NULL, variable = "recharge", ...) 8 | } 9 | \arguments{ 10 | \item{rch}{an \code{RMODFLOW} rch object} 11 | 12 | \item{dis}{a \code{RMODFLOW} dis object} 13 | 14 | \item{kper}{integer specifying the stress-period to plot} 15 | 16 | \item{variable}{character specifying which variable to plot. Possible values are 'recharge' (default) and 'irch' if defined.} 17 | 18 | \item{...}{additional arguments passed to \code{\link{rmf_plot.rmf_2d_array}}} 19 | } 20 | \value{ 21 | ggplot2 object or layer; if plot3D is TRUE, nothing is returned and the plot is made directly 22 | } 23 | \description{ 24 | Plot a RMODFLOW rch object 25 | } 26 | -------------------------------------------------------------------------------- /man/rmf_plot.rmf_4d_array.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/plot.R 3 | \name{rmf_plot.rmf_4d_array} 4 | \alias{rmf_plot.rmf_4d_array} 5 | \title{Plot a 2D section through a MODFLOW 4D array} 6 | \usage{ 7 | \method{rmf_plot}{rmf_4d_array}(array, dis, i = NULL, j = NULL, k = NULL, l = NULL, ...) 8 | } 9 | \arguments{ 10 | \item{array}{an object of class rmf_3d_array} 11 | 12 | \item{dis}{discretization file object} 13 | 14 | \item{i}{row number to plot} 15 | 16 | \item{j}{column number to plot} 17 | 18 | \item{k}{layer number to plot} 19 | 20 | \item{l}{time step number to plot} 21 | 22 | \item{...}{parameters provided to \code{\link{rmf_plot.rmf_3d_array}}} 23 | } 24 | \value{ 25 | ggplot2 object or layer; if plot3D is TRUE, nothing is returned and the plot is made directly 26 | } 27 | \description{ 28 | \code{rmf_plot.rmf_4d_array} plots a 2D section through a MODFLOW 4D array. 29 | } 30 | \details{ 31 | specifying all of the \code{i, j & k} arguments will plot a time series at that cell location 32 | } 33 | -------------------------------------------------------------------------------- /man/rmf_plot.rmf_analyze.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/plot.R 3 | \name{rmf_plot.rmf_analyze} 4 | \alias{rmf_plot.rmf_analyze} 5 | \title{Plot a MODFLOW sensitivity analysis object} 6 | \usage{ 7 | \method{rmf_plot}{rmf_analyze}(analysis, type = "css") 8 | } 9 | \arguments{ 10 | \item{analysis}{sensitivity analysis object from \link{rmf_analyze}} 11 | 12 | \item{type}{plot type: 'css' or 'dss'} 13 | } 14 | \description{ 15 | Plot a MODFLOW sensitivity analysis object 16 | } 17 | -------------------------------------------------------------------------------- /man/rmf_read.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/modflow.R 3 | \name{rmf_read} 4 | \alias{rmf_read} 5 | \title{Read a MODFLOW model} 6 | \usage{ 7 | rmf_read( 8 | file = { 9 | cat("Please select nam file ...\\n") 10 | file.choose() 11 | }, 12 | output = FALSE, 13 | precision = "single", 14 | verbose = TRUE 15 | ) 16 | } 17 | \arguments{ 18 | \item{file}{NAME file; typically '*.nam'} 19 | 20 | \item{output}{logical; should output also be read. Defaults to FALSE.} 21 | 22 | \item{precision}{either \code{'single'} or \code{'double'}. Specifies the precision of binary files. Defaults to \code{'single'}.} 23 | 24 | \item{verbose}{logical; should information on reading files be printed to the console ? Defaults to TRUE.} 25 | } 26 | \value{ 27 | a \code{modflow} object which is a list containing all MODFLOW packages and optionally, model output 28 | } 29 | \description{ 30 | \code{rmf_read} reads in a MODFLOW model and returns it as a \code{modflow} object 31 | } 32 | \seealso{ 33 | \code{\link{rmf_create}}, \code{\link{rmf_write}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html} 34 | } 35 | -------------------------------------------------------------------------------- /man/rmf_read_bas.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-bas.R 3 | \name{rmf_read_bas} 4 | \alias{rmf_read_bas} 5 | \title{Read a MODFLOW basic file} 6 | \usage{ 7 | rmf_read_bas( 8 | file = { 9 | cat("Please select bas file ...\\n") 10 | file.choose() 11 | }, 12 | dis = { 13 | cat("Please select corresponding dis file ...\\n") 14 | 15 | rmf_read_dis(file.choose()) 16 | }, 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{file}{filename; typically '*.bas'} 22 | 23 | \item{dis}{discretization file object; defaults to that with the same filename but with extension '.dis'} 24 | 25 | \item{...}{arguments passed to \code{rmfi_parse_array} and \code{rmfi_parse_variables}. Can be ignored when input is 'free' format and input arrays are INTERNAL or CONSTANT.} 26 | } 27 | \value{ 28 | object of class bas 29 | } 30 | \description{ 31 | \code{rmf_read_bas} reads in a MODFLOW basic file and returns it as an \code{\link{RMODFLOW}} bas object. 32 | } 33 | \seealso{ 34 | \code{\link{rmf_write_bas}}, \code{\link{rmf_create_bas}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?bas6.htm} 35 | } 36 | -------------------------------------------------------------------------------- /man/rmf_read_bcf.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-bcf.R 3 | \name{rmf_read_bcf} 4 | \alias{rmf_read_bcf} 5 | \title{Read a MODFLOW bcf file} 6 | \usage{ 7 | rmf_read_bcf( 8 | file = { 9 | cat("Please select bcf file ...\\n") 10 | file.choose() 11 | }, 12 | dis = { 13 | cat("Please select corresponding dis file ...\\n") 14 | 15 | rmf_read_dis(file.choose()) 16 | }, 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{file}{filename; typically '*_bcf'} 22 | 23 | \item{dis}{an \code{RMODFLOW} dis object} 24 | 25 | \item{...}{arguments passed to \code{rmfi_parse_array} and \code{rmfi_parse_variables}. Can be ignored when input is 'free' format and arrays are INTERNAL or CONSTANT.} 26 | } 27 | \value{ 28 | an \code{RMODFLOW} bcf object 29 | } 30 | \description{ 31 | \code{rmf_read_bcf} reads in a MODFLOW block-centered flow file and returns it as an \code{RMODFLOW} bcf object 32 | } 33 | \seealso{ 34 | \code{\link{rmf_write_bcf}}, \code{\link{rmf_create_bcf}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?bcf.htm} 35 | } 36 | -------------------------------------------------------------------------------- /man/rmf_read_bud.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/output.R 3 | \name{rmf_read_bud} 4 | \alias{rmf_read_bud} 5 | \alias{rmf_read_budget} 6 | \title{Reads the volumetric budget from a MODFLOW listing file} 7 | \usage{ 8 | rmf_read_bud( 9 | file = { 10 | cat("Please select listing file ...\\n") 11 | file.choose() 12 | } 13 | ) 14 | 15 | rmf_read_budget(...) 16 | } 17 | \arguments{ 18 | \item{file}{path to the listing file; typically '*.lst'} 19 | } 20 | \value{ 21 | an object of class bud which is a list with two data frames: one with cumulative fluxes and one with rates 22 | } 23 | \description{ 24 | \code{rmf_read_bud} reads a volumetric budget from a MODFLOW listing file and returns it as a list with data frame elements 25 | } 26 | -------------------------------------------------------------------------------- /man/rmf_read_chd.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-chd.R 3 | \name{rmf_read_chd} 4 | \alias{rmf_read_chd} 5 | \title{Read a MODFLOW time-variant specified-head file} 6 | \usage{ 7 | rmf_read_chd( 8 | file = { 9 | cat("Please select time-variant specified-head file ...\\n") 10 | 11 | file.choose() 12 | }, 13 | dis = { 14 | cat("Please select corresponding dis file ...\\n") 15 | 16 | rmf_read_dis(file.choose()) 17 | }, 18 | ... 19 | ) 20 | } 21 | \arguments{ 22 | \item{file}{filename; typically '*.chd'} 23 | 24 | \item{dis}{an \code{RMODFLOW} dis object} 25 | 26 | \item{...}{arguments passed to \code{rmfi_parse_variables} and \code{rmfi_parse_list}.} 27 | } 28 | \value{ 29 | \code{RMODFLOW} chd object 30 | } 31 | \description{ 32 | \code{rmf_read_chd} reads in a MODFLOW time-variant specified-head file and returns it as an \code{RMODFLOW} chd object. 33 | } 34 | \seealso{ 35 | \code{\link{rmf_write_chd}}, \code{\link{rmf_create_chd}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?chd.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_read_de4.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-de4.R 3 | \name{rmf_read_de4} 4 | \alias{rmf_read_de4} 5 | \title{Read a MODFLOW direct solver file} 6 | \usage{ 7 | rmf_read_de4( 8 | file = { 9 | cat("Please select direct solver file ...\\n") 10 | file.choose() 11 | }, 12 | ... 13 | ) 14 | } 15 | \arguments{ 16 | \item{file}{filename; typically '*_de4'} 17 | 18 | \item{...}{ignored} 19 | } 20 | \value{ 21 | \code{RMODFLOW} de4 object 22 | } 23 | \description{ 24 | \code{rmf_read_de4} reads in a MODFLOW direct solver file and returns it as an \code{RMODFLOW} de4 object 25 | } 26 | \seealso{ 27 | \code{\link{rmf_write_de4}}, \code{\link{rmf_create_de4}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?de4.htm} 28 | } 29 | -------------------------------------------------------------------------------- /man/rmf_read_dis.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-dis.R 3 | \name{rmf_read_dis} 4 | \alias{rmf_read_dis} 5 | \title{Read a MODFLOW discretization file} 6 | \usage{ 7 | rmf_read_dis( 8 | file = { 9 | cat("Please select dis file ...\\n") 10 | file.choose() 11 | }, 12 | ... 13 | ) 14 | } 15 | \arguments{ 16 | \item{file}{filename; typically '*.dis'} 17 | 18 | \item{...}{arguments passed to \code{rmfi_parse_array}. Can be ignored when input arrays are free-format and INTERNAL or CONSTANT.} 19 | } 20 | \value{ 21 | object of class dis 22 | } 23 | \description{ 24 | \code{rmf_read_dis} reads in a MODFLOW discretization file and returns it as an \code{\link{RMODFLOW}} dis object. 25 | } 26 | \seealso{ 27 | \code{\link{rmf_write_dis}}, \code{\link{rmf_create_dis}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?dis.htm} 28 | } 29 | -------------------------------------------------------------------------------- /man/rmf_read_drn.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-drn.R 3 | \name{rmf_read_drn} 4 | \alias{rmf_read_drn} 5 | \title{Read a MODFLOW drain file} 6 | \usage{ 7 | rmf_read_drn( 8 | file = { 9 | cat("Please select drain file ...\\n") 10 | file.choose() 11 | }, 12 | dis = { 13 | cat("Please select corresponding dis file ...\\n") 14 | 15 | rmf_read_dis(file.choose()) 16 | }, 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{file}{filename; typically '*.drn'} 22 | 23 | \item{dis}{an \code{RMODFLOW} dis object} 24 | 25 | \item{...}{arguments passed to \code{rmfi_parse_variables} and \code{rmfi_parse_list}.} 26 | } 27 | \value{ 28 | \code{RMODFLOW} drn object 29 | } 30 | \description{ 31 | \code{rmf_read_drn} reads in a MODFLOW drain file and returns it as an \code{RMODFLOW} drn object. 32 | } 33 | \seealso{ 34 | \code{\link{rmf_write_drn}}, \code{\link{rmf_create_drn}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?drn.htm} 35 | } 36 | -------------------------------------------------------------------------------- /man/rmf_read_evt.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-evt.R 3 | \name{rmf_read_evt} 4 | \alias{rmf_read_evt} 5 | \title{Read a MODFLOW evapotranspiration file} 6 | \usage{ 7 | rmf_read_evt( 8 | file = { 9 | cat("Please select evt file ...\\n") 10 | file.choose() 11 | }, 12 | dis = { 13 | cat("Please select corresponding dis file ...\\n") 14 | 15 | rmf_read_dis(file.choose()) 16 | }, 17 | mlt = NULL, 18 | zon = NULL, 19 | ... 20 | ) 21 | } 22 | \arguments{ 23 | \item{file}{filename; typically '*.evt'} 24 | 25 | \item{dis}{an \code{RMODFLOW} dis object} 26 | 27 | \item{mlt}{a \code{RMODFLOW} mlt object. Only needed when reading parameter arrays defined by multiplier arrays} 28 | 29 | \item{zon}{a \code{RMODFLOW} zon object. Only needed when reading parameter arrays defined by zone arrays} 30 | 31 | \item{...}{arguments passed to \code{rmfi_parse_array}. Can be ignored when input arrays are free-format and INTERNAL or CONSTANT.} 32 | } 33 | \value{ 34 | \code{RMODFLOW} evt object 35 | } 36 | \description{ 37 | \code{rmf_read_evt} reads in a MODFLOW evapotranspiration file and returns it as an \code{RMODFLOW} evt object. 38 | } 39 | \seealso{ 40 | \code{\link{rmf_write_evt}}, \code{\link{rmf_create_evt}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?evt.htm} 41 | } 42 | -------------------------------------------------------------------------------- /man/rmf_read_ghb.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-ghb.R 3 | \name{rmf_read_ghb} 4 | \alias{rmf_read_ghb} 5 | \title{Read a MODFLOW general-head boundary file} 6 | \usage{ 7 | rmf_read_ghb( 8 | file = { 9 | cat("Please select general-head boundary file ...\\n") 10 | 11 | file.choose() 12 | }, 13 | dis = { 14 | cat("Please select corresponding dis file ...\\n") 15 | 16 | rmf_read_dis(file.choose()) 17 | }, 18 | ... 19 | ) 20 | } 21 | \arguments{ 22 | \item{file}{filename; typically '*.ghb'} 23 | 24 | \item{dis}{an \code{RMODFLOW} dis object} 25 | 26 | \item{...}{arguments passed to \code{rmfi_parse_variables} and \code{rmfi_parse_list}.} 27 | } 28 | \value{ 29 | \code{RMODFLOW} ghb object 30 | } 31 | \description{ 32 | \code{rmf_read_ghb} reads in a MODFLOW general-head boundary file and returns it as an \code{RMODFLOW} ghb object. 33 | } 34 | \seealso{ 35 | \code{\link{rmf_write_ghb}}, \code{\link{rmf_create_ghb}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?ghb.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_read_gmg.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-gmg.R 3 | \name{rmf_read_gmg} 4 | \alias{rmf_read_gmg} 5 | \title{Read a MODFLOW Geometric Multigrid Solver file} 6 | \usage{ 7 | rmf_read_gmg( 8 | file = { 9 | cat("Please select gmg file ...\\n") 10 | file.choose() 11 | }, 12 | ... 13 | ) 14 | } 15 | \arguments{ 16 | \item{file}{filename; typically '*.gmg'} 17 | 18 | \item{...}{ignored} 19 | } 20 | \value{ 21 | object of class gmg 22 | } 23 | \description{ 24 | \code{rmf_read_gmg} reads in a MODFLOW Geometric Multigrid Solver file and returns it as an \code{\link{RMODFLOW}} gmg object. 25 | } 26 | \seealso{ 27 | \code{\link{rmf_write_gmg}}, \code{\link{rmf_create_gmg}} and \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?gmg.htm} 28 | } 29 | -------------------------------------------------------------------------------- /man/rmf_read_hfb.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-hfb.R 3 | \name{rmf_read_hfb} 4 | \alias{rmf_read_hfb} 5 | \title{Read a MODFLOW horizontal flow barrier file} 6 | \usage{ 7 | rmf_read_hfb( 8 | file = { 9 | cat("Please select horizontal flow barrier file ...\\n") 10 | 11 | file.choose() 12 | }, 13 | dis = { 14 | cat("Please select corresponding dis file ...\\n") 15 | 16 | rmf_read_dis(file.choose()) 17 | }, 18 | ... 19 | ) 20 | } 21 | \arguments{ 22 | \item{file}{filename; typically '*.hfb'} 23 | 24 | \item{dis}{an \code{RMODFLOW} dis object} 25 | 26 | \item{...}{arguments passed to \code{rmfi_parse_list}.} 27 | } 28 | \value{ 29 | \code{RMODFLOW} hfb object 30 | } 31 | \description{ 32 | \code{rmf_read_hfb} reads in a MODFLOW horizontal flow barrier file and returns it as an \code{RMODFLOW} hfb object. 33 | } 34 | \seealso{ 35 | \code{\link{rmf_write_hfb}}, \code{\link{rmf_create_hfb}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?hfb6.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_read_hob.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-hob.R 3 | \name{rmf_read_hob} 4 | \alias{rmf_read_hob} 5 | \alias{rmf_read_ob_hob} 6 | \title{Read a MODFLOW head observations file} 7 | \usage{ 8 | rmf_read_hob( 9 | file = { 10 | cat("Please select hob file ...\\n") 11 | file.choose() 12 | }, 13 | ... 14 | ) 15 | 16 | rmf_read_ob_hob(...) 17 | } 18 | \arguments{ 19 | \item{file}{filename; typically '*.hob'} 20 | 21 | \item{...}{arguments passed to \code{rmfi_parse_variables}. Can be ignored when input is 'free' format.} 22 | } 23 | \value{ 24 | object of class hob 25 | } 26 | \description{ 27 | \code{read_hob} reads in a MODFLOW head observations file and returns it as an \code{\link{RMODFLOW}} hob object. 28 | } 29 | \section{Functions}{ 30 | \itemize{ 31 | \item \code{rmf_read_ob_hob()}: Compatible with default ModelMuse file extensions 32 | 33 | }} 34 | \seealso{ 35 | \code{\link{rmf_create_hob}}, \code{\link{rmf_write_hob}} and \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?hob.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_read_hpr.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/output.R 3 | \name{rmf_read_hpr} 4 | \alias{rmf_read_hpr} 5 | \alias{rmf_read_hob_out} 6 | \title{Read a MODFLOW head predictions file} 7 | \usage{ 8 | rmf_read_hpr( 9 | file = { 10 | cat("Please select hpr file ...\\n") 11 | file.choose() 12 | } 13 | ) 14 | 15 | rmf_read_hob_out(...) 16 | } 17 | \arguments{ 18 | \item{file}{filename; typically '*.hpr'} 19 | } 20 | \value{ 21 | object of class hpr 22 | } 23 | \description{ 24 | \code{rmf_read_hpr} reads in a MODFLOW head predictions file and returns it as an \code{\link{RMODFLOW}} hpr object. 25 | } 26 | \section{Functions}{ 27 | \itemize{ 28 | \item \code{rmf_read_hob_out()}: Compatible with default ModelMuse file extension 29 | 30 | }} 31 | -------------------------------------------------------------------------------- /man/rmf_read_kdep.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-huf.R 3 | \name{rmf_read_kdep} 4 | \alias{rmf_read_kdep} 5 | \title{Read a MODFLOW hydraulic conductivity depth-dependence capability file} 6 | \usage{ 7 | rmf_read_kdep( 8 | file = { 9 | cat("Please select kdep file ...\\n") 10 | file.choose() 11 | }, 12 | dis = { 13 | cat("Please select corresponding dis file ...\\n") 14 | 15 | rmf_read_dis(file.choose()) 16 | }, 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{dis}{\code{RMODFLOW} dis object} 22 | 23 | \item{...}{arguments passed to \code{rmfi_parse_array}. Can be ignored when input arrays are free-format and INTERNAL or CONSTANT.} 24 | 25 | \item{filename}{filename; typically *.kdep} 26 | } 27 | \value{ 28 | object of class kdep 29 | } 30 | \description{ 31 | \code{rmf_read_kdep} reads in a MODFLOW Hydraulic-Conductivity Depth-Dependence Capability file and returns it as an \code{RMODFLOW} kdep object. 32 | } 33 | \details{ 34 | Note that the parameters are defined on the HUF grid, not the numerical grid 35 | \code{\link{rmf_convert_huf_to_grid}} can be used to convert parameters defined on the huf grid to the numerical grid 36 | } 37 | \seealso{ 38 | \code{\link{rmf_convert_huf_to_grid}}, \code{\link{rmf_create_kdep}}, \code{\link{rmf_write_kdep}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?kdep.htm} 39 | } 40 | -------------------------------------------------------------------------------- /man/rmf_read_lmt.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-lmt.R 3 | \name{rmf_read_lmt} 4 | \alias{rmf_read_lmt} 5 | \title{Read a MODFLOW Link-MT3DMS Package file} 6 | \usage{ 7 | rmf_read_lmt( 8 | file = { 9 | cat("Please select lmt file ...\\n") 10 | file.choose() 11 | }, 12 | ... 13 | ) 14 | } 15 | \arguments{ 16 | \item{file}{filename; typically '*.lmt'} 17 | 18 | \item{...}{ignored} 19 | } 20 | \value{ 21 | object of class lmt 22 | } 23 | \description{ 24 | Read a MODFLOW Link-MT3DMS Package file 25 | } 26 | \examples{ 27 | file <- rmf_example_file('rocky-mountain-arsenal.lmt') 28 | rmf_read_lmt(file) 29 | 30 | } 31 | \seealso{ 32 | \code{\link{rmf_create_lmt}}, \code{\link{rmf_write_lmt}} and \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?lmt6.htm} 33 | } 34 | -------------------------------------------------------------------------------- /man/rmf_read_lpf.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-lpf.R 3 | \name{rmf_read_lpf} 4 | \alias{rmf_read_lpf} 5 | \title{Read a MODFLOW layer-property flow file} 6 | \usage{ 7 | rmf_read_lpf( 8 | file = { 9 | cat("Please select lpf file ...\\n") 10 | file.choose() 11 | }, 12 | dis = { 13 | cat("Please select corresponding dis file ...\\n") 14 | 15 | rmf_read_dis(file.choose()) 16 | }, 17 | mlt = NULL, 18 | zon = NULL, 19 | ... 20 | ) 21 | } 22 | \arguments{ 23 | \item{file}{filename; typically '*.lpf'.} 24 | 25 | \item{dis}{an \code{RMODFLOW} dis object} 26 | 27 | \item{mlt}{a \code{RMODFLOW} mlt object. Only needed when reading parameter arrays defined by multiplier arrays} 28 | 29 | \item{zon}{a \code{RMODFLOW} zon object. Only needed when reading parameter arrays defined by zone arrays} 30 | 31 | \item{...}{arguments passed to \code{rmfi_parse_array}. Can be ignored when input arrays are free-format and INTERNAL or CONSTANT.} 32 | } 33 | \value{ 34 | object of class lpf 35 | } 36 | \description{ 37 | \code{read_lpf} reads in a MODFLOW layer property file and returns it as an \code{\link{RMODFLOW}} lpf object. 38 | } 39 | \seealso{ 40 | \code{\link{rmf_write_lpf}}, \code{\link{rmf_create_lpf}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?lpf.htm} 41 | } 42 | -------------------------------------------------------------------------------- /man/rmf_read_lvda.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-huf.R 3 | \name{rmf_read_lvda} 4 | \alias{rmf_read_lvda} 5 | \title{Read a MODFLOW model-layer variable-direction horizontal anisotropy capability file} 6 | \usage{ 7 | rmf_read_lvda( 8 | file, 9 | dis = { 10 | cat("Please select corresponding dis file ...\\n") 11 | 12 | rmf_read_dis(file.choose()) 13 | }, 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{dis}{\code{RMODFLOW} dis object} 19 | 20 | \item{...}{ignored} 21 | 22 | \item{filename}{filename; typically *.lvda} 23 | } 24 | \value{ 25 | object of class lvda 26 | } 27 | \description{ 28 | \code{rmf_read_lvda} reads in a MODFLOW Model-Layer Variable-Direction Horizontal Anisotropy Capability file and returns it as an \code{RMODFLOW} lvda object. 29 | } 30 | \details{ 31 | Note that the parameters are defined on the numerical grid, not the HUF grid 32 | } 33 | \seealso{ 34 | \code{\link{rmf_create_lvda}}, \code{\link{rmf_write_lvda}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?lvda.htm} 35 | } 36 | -------------------------------------------------------------------------------- /man/rmf_read_mlt.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-mlt.R 3 | \name{rmf_read_mlt} 4 | \alias{rmf_read_mlt} 5 | \title{Read a MODFLOW multiplier file} 6 | \usage{ 7 | rmf_read_mlt( 8 | file = { 9 | cat("Please select mlt file ...\\n") 10 | file.choose() 11 | }, 12 | dis = { 13 | cat("Please select dis file ...\\n") 14 | rmf_read_dis(file.choose()) 15 | }, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{file}{filename; typically '*.mlt'} 21 | 22 | \item{dis}{discretization file object; defaults to that with the same filename but with extension '.dis'} 23 | 24 | \item{...}{arguments passed to \code{rmfi_parse_array}. Can be ignored when input arrays are free-format and INTERNAL or CONSTANT.} 25 | } 26 | \value{ 27 | \code{RMODFLOW} mlt object 28 | } 29 | \description{ 30 | \code{read_mlt} reads in a MODFLOW multiplier file and returns it as an \code{\link{RMODFLOW}} mlt object. 31 | } 32 | \seealso{ 33 | \code{\link{rmf_write_mlt}}, \code{\link{rmf_create_mlt}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?mult.htm} 34 | } 35 | -------------------------------------------------------------------------------- /man/rmf_read_nam.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-nam.R 3 | \name{rmf_read_nam} 4 | \alias{rmf_read_nam} 5 | \title{Read a MODFLOW name file} 6 | \usage{ 7 | rmf_read_nam( 8 | file = { 9 | cat("Please select nam file ...\\n") 10 | file.choose() 11 | } 12 | ) 13 | } 14 | \arguments{ 15 | \item{file}{filename; typically '*.nam'} 16 | } 17 | \value{ 18 | object of class nam 19 | } 20 | \description{ 21 | \code{rmf_read_nam} reads in a MODFLOW name file and returns it as an \code{\link{RMODFLOW}} nam object. 22 | } 23 | \seealso{ 24 | \code{\link{rmf_read_nam}}, \code{\link{rmf_write_nam}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?name_file.htm} 25 | } 26 | -------------------------------------------------------------------------------- /man/rmf_read_nwt.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-nwt.R 3 | \name{rmf_read_nwt} 4 | \alias{rmf_read_nwt} 5 | \title{Read a MODFLOW Newton solver package file} 6 | \usage{ 7 | rmf_read_nwt( 8 | file = { 9 | cat("Please select nwt file ...\\n") 10 | file.choose() 11 | }, 12 | ... 13 | ) 14 | } 15 | \arguments{ 16 | \item{file}{filename; typically '*.nwt'} 17 | 18 | \item{...}{arguments passed to \code{rmfi_parse_variables}. Can be ignored when input is 'free' format.} 19 | } 20 | \value{ 21 | object of class nwt 22 | } 23 | \description{ 24 | \code{rmf_read_nwt} reads in a MODFLOW Newton solver package file and returns it as an \code{\link{RMODFLOW}} nwt object. 25 | } 26 | \seealso{ 27 | \code{\link{rmf_write_nwt}}, \code{\link{rmf_create_nwt}} and \url{https://water.usgs.gov/ogw/modflow-nwt/MODFLOW-NWT-Guide/} 28 | } 29 | -------------------------------------------------------------------------------- /man/rmf_read_oc.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-oc.R 3 | \name{rmf_read_oc} 4 | \alias{rmf_read_oc} 5 | \title{Read a MODFLOW output control option file} 6 | \usage{ 7 | rmf_read_oc( 8 | file = { 9 | cat("Please select oc file ...\\n") 10 | file.choose() 11 | }, 12 | dis = { 13 | cat("Please select corresponding dis file ...\\n") 14 | 15 | rmf_read_dis(file.choose()) 16 | }, 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{file}{filename; typically '*.oc'} 22 | 23 | \item{dis}{an \code{RMODFLOW} dis object. Used when reading OC specified using numeric codes.} 24 | 25 | \item{...}{arguments passed to \code{rmfi_parse_variables}. Can be ignored when input is 'free' format.} 26 | } 27 | \value{ 28 | object of class oc 29 | } 30 | \description{ 31 | \code{read_oc} reads in a MODFLOW output control option file and returns it as an \code{\link{RMODFLOW}} oc object. 32 | } 33 | \seealso{ 34 | \code{\link{rmf_write_oc}}, \code{\link{rmf_create_oc}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?oc.htm} 35 | } 36 | -------------------------------------------------------------------------------- /man/rmf_read_pcg.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-pcg.R 3 | \name{rmf_read_pcg} 4 | \alias{rmf_read_pcg} 5 | \title{Read a MODFLOW preconditioned conjugate-gradient package file} 6 | \usage{ 7 | rmf_read_pcg( 8 | file = { 9 | cat("Please select pcg file ...\\n") 10 | file.choose() 11 | }, 12 | ... 13 | ) 14 | } 15 | \arguments{ 16 | \item{file}{filename; typically '*.pcg'} 17 | 18 | \item{...}{arguments passed to \code{rmfi_parse_variables}. Can be ignored when input is 'free' format.} 19 | } 20 | \value{ 21 | object of class pcg 22 | } 23 | \description{ 24 | \code{read_pcg} reads in a MODFLOW preconditioned conjugate-gradient package file and returns it as an \code{\link{RMODFLOW}} pcg object. 25 | } 26 | \seealso{ 27 | \code{\link{rmf_write_pcg}}, \code{\link{rmf_create_pcg}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?pcg.htm} 28 | } 29 | -------------------------------------------------------------------------------- /man/rmf_read_pval.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-pval.R 3 | \name{rmf_read_pval} 4 | \alias{rmf_read_pval} 5 | \title{Read a MODFLOW parameter value file} 6 | \usage{ 7 | rmf_read_pval(path) 8 | } 9 | \arguments{ 10 | \item{path}{Path to the PVAL file. Typically with extension \code{.pval}.} 11 | } 12 | \value{ 13 | object of class pval 14 | } 15 | \description{ 16 | \code{rmf_read_pval} reads in a MODFLOW parameter value file and returns it as an \code{\link{RMODFLOW}} pval object. 17 | } 18 | \seealso{ 19 | \code{\link{rmf_create_pval}}, \code{\link{rmf_write_pval}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?pval.htm} 20 | } 21 | -------------------------------------------------------------------------------- /man/rmf_read_rch.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-rch.R 3 | \name{rmf_read_rch} 4 | \alias{rmf_read_rch} 5 | \title{Read a MODFLOW recharge file} 6 | \usage{ 7 | rmf_read_rch( 8 | file = { 9 | cat("Please select rch file ...\\n") 10 | file.choose() 11 | }, 12 | dis = { 13 | cat("Please select corresponding dis file ...\\n") 14 | 15 | rmf_read_dis(file.choose()) 16 | }, 17 | mlt = NULL, 18 | zon = NULL, 19 | ... 20 | ) 21 | } 22 | \arguments{ 23 | \item{file}{filename; typically '*.rch'} 24 | 25 | \item{dis}{an \code{RMODFLOW} dis object} 26 | 27 | \item{mlt}{a \code{RMODFLOW} mlt object. Only needed when reading parameter arrays defined by multiplier arrays} 28 | 29 | \item{zon}{a \code{RMODFLOW} zon object. Only needed when reading parameter arrays defined by zone arrays} 30 | 31 | \item{...}{arguments passed to \code{rmfi_parse_array}. Can be ignored when input arrays are free-format and INTERNAL or CONSTANT.} 32 | } 33 | \value{ 34 | \code{RMODFLOW} rch object 35 | } 36 | \description{ 37 | \code{rmf_read_rch} reads in a MODFLOW recharge file and returns it as an \code{RMODFLOW} rch object. 38 | } 39 | \seealso{ 40 | \code{\link{rmf_write_rch}}, \code{\link{rmf_create_rch}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?rch.htm} 41 | } 42 | -------------------------------------------------------------------------------- /man/rmf_read_riv.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-riv.R 3 | \name{rmf_read_riv} 4 | \alias{rmf_read_riv} 5 | \title{Read a MODFLOW river file} 6 | \usage{ 7 | rmf_read_riv( 8 | file = { 9 | cat("Please select river file ...\\n") 10 | file.choose() 11 | }, 12 | dis = { 13 | cat("Please select corresponding dis file ...\\n") 14 | 15 | rmf_read_dis(file.choose()) 16 | }, 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{file}{filename; typically '*.riv'} 22 | 23 | \item{dis}{an \code{RMODFLOW} dis object} 24 | 25 | \item{...}{arguments passed to \code{rmfi_parse_variables} and \code{rmfi_parse_list}.} 26 | } 27 | \value{ 28 | \code{RMODFLOW} riv object 29 | } 30 | \description{ 31 | \code{rmf_read_riv} reads in a MODFLOW river file and returns it as an \code{RMODFLOW} riv object. 32 | } 33 | \seealso{ 34 | \code{\link{rmf_write_riv}}, \code{\link{rmf_create_riv}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?riv.htm} 35 | } 36 | -------------------------------------------------------------------------------- /man/rmf_read_sip.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-sip.R 3 | \name{rmf_read_sip} 4 | \alias{rmf_read_sip} 5 | \title{Read a MODFLOW strongly implicit procedure file} 6 | \usage{ 7 | rmf_read_sip( 8 | file = { 9 | cat("Please select strongly implicit procedure file ...\\n") 10 | 11 | file.choose() 12 | }, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{file}{filename; typically '*_sip'} 18 | 19 | \item{...}{arguments passed to \code{rmfi_parse_variables}. Can be ignored when input is 'free' format.} 20 | } 21 | \value{ 22 | \code{RMODFLOW} sip object 23 | } 24 | \description{ 25 | \code{rmf_read_sip} reads in a MODFLOW strongly implicit procedure file and returns it as an \code{RMODFLOW} sip object 26 | } 27 | \seealso{ 28 | \code{\link{rmf_write_sip}}, \code{\link{rmf_create_sip}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?sip.htm} 29 | } 30 | -------------------------------------------------------------------------------- /man/rmf_read_usgs_model_reference.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/spatial.R 3 | \name{rmf_read_usgs_model_reference} 4 | \alias{rmf_read_usgs_model_reference} 5 | \title{Read RMODFLOW projection information from a USGS model reference file} 6 | \usage{ 7 | rmf_read_usgs_model_reference( 8 | file = { 9 | cat("Please select usgs.model.reference file ...\\n") 10 | file.choose() 11 | 12 | }, 13 | dis = { 14 | cat("Please select corresponding dis file ...\\n") 15 | 16 | rmf_read_dis(file.choose()) 17 | } 18 | ) 19 | } 20 | \arguments{ 21 | \item{file}{path to the USGS model reference file; typically "usgs.model.reference"} 22 | 23 | \item{dis}{\code{RMODFLOW} dis object} 24 | } 25 | \value{ 26 | a \code{prj} object 27 | } 28 | \description{ 29 | Read RMODFLOW projection information from a USGS model reference file 30 | } 31 | -------------------------------------------------------------------------------- /man/rmf_read_wel.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-wel.R 3 | \name{rmf_read_wel} 4 | \alias{rmf_read_wel} 5 | \title{Read a MODFLOW well file} 6 | \usage{ 7 | rmf_read_wel( 8 | file = { 9 | cat("Please select well file ...\\n") 10 | file.choose() 11 | }, 12 | dis = { 13 | cat("Please select corresponding dis file ...\\n") 14 | 15 | rmf_read_dis(file.choose()) 16 | }, 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{file}{filename; typically '*.wel'} 22 | 23 | \item{dis}{an \code{RMODFLOW} dis object} 24 | 25 | \item{...}{arguments passed to \code{rmfi_parse_variables} and \code{rmfi_parse_list}.} 26 | } 27 | \value{ 28 | \code{RMODFLOW} wel object 29 | } 30 | \description{ 31 | \code{rmf_read_wel} reads in a MODFLOW well file and returns it as an \code{RMODFLOW} wel object. 32 | } 33 | \seealso{ 34 | \code{\link{rmf_write_wel}}, \code{\link{rmf_create_wel}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?wel.htm} 35 | } 36 | -------------------------------------------------------------------------------- /man/rmf_read_zon.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-zon.R 3 | \name{rmf_read_zon} 4 | \alias{rmf_read_zon} 5 | \title{Read a MODFLOW zone file} 6 | \usage{ 7 | rmf_read_zon( 8 | file = { 9 | cat("Please select zon file ...\\n") 10 | file.choose() 11 | }, 12 | dis = { 13 | cat("Please select dis file ...\\n") 14 | rmf_read_dis(file.choose()) 15 | }, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{file}{filename; typically '*.zon'} 21 | 22 | \item{dis}{discretization file object; defaults to that with the same filename but with extension '.dis'} 23 | 24 | \item{...}{arguments passed to \code{rmfi_parse_array}. Can be ignored when input arrays are free-format and INTERNAL or CONSTANT.} 25 | } 26 | \value{ 27 | \code{RMODFLOW} zon object 28 | } 29 | \description{ 30 | \code{rmf_read_zon} reads in a MODFLOW zone file and returns it as an \code{RMODFLOW} zon object 31 | } 32 | \seealso{ 33 | \code{\link{rmf_write_zon}}, \code{\link{rmf_create_zon}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?zone.htm} 34 | } 35 | -------------------------------------------------------------------------------- /man/rmf_saturated_thickness.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_saturated_thickness} 4 | \alias{rmf_saturated_thickness} 5 | \title{Calculate saturated thicknesses} 6 | \usage{ 7 | rmf_saturated_thickness(hed, dis, l = NULL, na_values = NULL) 8 | } 9 | \arguments{ 10 | \item{hed}{3d or 4d array object containing hydraulic head values for each cell} 11 | 12 | \item{dis}{\code{RMODFLOW} dis object} 13 | 14 | \item{l}{integer used to subset the 4th dimension of \code{hed}. If not supplied, the final time step is used.} 15 | 16 | \item{na_values}{optional; specifies which \code{hed} values should be set to \code{NA}.} 17 | } 18 | \value{ 19 | a \code{rmf_3d_array} with saturated thicknesses for each cell. 20 | } 21 | \description{ 22 | Calculate saturated thicknesses 23 | } 24 | -------------------------------------------------------------------------------- /man/rmf_time_steps.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils.R 3 | \name{rmf_time_steps} 4 | \alias{rmf_time_steps} 5 | \title{Calculate the internal time step sequence of a transient MODFLOW model} 6 | \usage{ 7 | rmf_time_steps( 8 | dis = NULL, 9 | perlen = NULL, 10 | tsmult = NULL, 11 | nstp = NULL, 12 | incl_ss = TRUE 13 | ) 14 | } 15 | \arguments{ 16 | \item{dis}{optional, an \code{RMODFLOW} dis object} 17 | 18 | \item{perlen}{optional, only read when a \code{dis} object is not supplied; numeric vector of length \code{nper} specifying the stress period lengths} 19 | 20 | \item{tsmult}{optional, only read when a \code{dis} object is not supplied; numeric vector of length \code{nper} specifying the time step multipliers} 21 | 22 | \item{nstp}{optional, only read when a \code{dis} object is not supplied; numeric vector of length \code{nper} specifying the number of time steps in each stress period} 23 | 24 | \item{incl_ss}{logical, only read when a \code{dis} object is supplied; should the lengths of steady-state stress periods in the \code{dis} object be incorporated in the calculation; defaults to TRUE} 25 | } 26 | \value{ 27 | a list holding the numeric vectors of the computed sequence of time step lengths and its cumulative sum 28 | } 29 | \description{ 30 | \code{rmf_time_steps} calculates the internal sequence of time steps of a transient MODFLOW model from either an \code{RMODFLOW} dis object or separate parameters 31 | } 32 | \seealso{ 33 | \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?dis.htm} 34 | } 35 | -------------------------------------------------------------------------------- /man/rmf_write_bas.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-bas.R 3 | \name{rmf_write_bas} 4 | \alias{rmf_write_bas} 5 | \title{Write a MODFLOW basic file} 6 | \usage{ 7 | rmf_write_bas( 8 | bas, 9 | file = { 10 | 11 | cat("Please select bas file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | iprn = -1, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{bas}{an \code{\link{RMODFLOW}} bas object} 21 | 22 | \item{file}{filename to write to; typically '*.bas'} 23 | 24 | \item{iprn}{format code for printing arrays in the listing file; defaults to -1 (no printing)} 25 | 26 | \item{...}{arguments passed to \code{rmfi_write_array}. Can be ignored when arrays are INTERNAL or CONSTANT.} 27 | } 28 | \value{ 29 | \code{NULL} 30 | } 31 | \description{ 32 | \code{rmf_write_bas} writes a MODFLOW basic file based on an \code{\link{RMODFLOW}} bas object. 33 | } 34 | \seealso{ 35 | \code{\link{rmf_read_bas}}, \code{\link{rmf_create_bas}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?bas6.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_write_bcf.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-bcf.R 3 | \name{rmf_write_bcf} 4 | \alias{rmf_write_bcf} 5 | \title{Write a MODFLOW block-centered flow file} 6 | \usage{ 7 | rmf_write_bcf( 8 | bcf, 9 | dis = { 10 | cat("Please select corresponding dis file ...\\n") 11 | 12 | rmf_read_dis(file.choose()) 13 | }, 14 | file = { 15 | 16 | cat("Please select bcf file to overwrite or provide new filename ...\\n") 17 | 18 | file.choose() 19 | }, 20 | iprn = -1, 21 | ... 22 | ) 23 | } 24 | \arguments{ 25 | \item{bcf}{an \code{RMODFLOW} bcf object} 26 | 27 | \item{dis}{an \code{RMODFLOW} dis object} 28 | 29 | \item{file}{filename to write to; typically '*.bcf'} 30 | 31 | \item{iprn}{format code for printing arrays in the listing file; defaults to -1 (no printing)} 32 | 33 | \item{...}{arguments passed to \code{rmfi_write_array} and \code{rmfi_write_variables}. Can be ignored when format is free and arrays are INTERNAL or CONSTANT.} 34 | } 35 | \value{ 36 | \code{NULL} 37 | } 38 | \description{ 39 | \code{rmf_write_bcf} writes a MODFLOW block-centered flow file based on an \code{RMODFLOW} bcf object 40 | } 41 | \seealso{ 42 | \code{\link{rmf_read_bcf}}, \code{\link{rmf_create_bcf}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?bcf.htm} 43 | } 44 | -------------------------------------------------------------------------------- /man/rmf_write_chd.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-chd.R 3 | \name{rmf_write_chd} 4 | \alias{rmf_write_chd} 5 | \title{Write a MODFLOW time-variant specified-head file} 6 | \usage{ 7 | rmf_write_chd( 8 | chd, 9 | dis = rmf_read_dis(), 10 | file = { 11 | 12 | cat("Please choose chd file to overwrite or provide new filename ...\\n") 13 | 14 | file.choose() 15 | }, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{chd}{an \code{RMODFLOW} chd object} 21 | 22 | \item{dis}{an \code{RMODFLOW} dis object} 23 | 24 | \item{file}{filename to write to; typically '*.chd'} 25 | 26 | \item{...}{arguments passed to \code{rmfi_write_variables} and \code{rmfi_write_list} when writing a fixed format file.} 27 | } 28 | \value{ 29 | \code{NULL} 30 | } 31 | \description{ 32 | \code{rmf_write_chd} writes a MODFLOW time-variant specified-head file based on an \code{RMODFLOW} chd object 33 | } 34 | \seealso{ 35 | \code{\link{rmf_read_chd}}, \code{\link{rmf_create_chd}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?chd.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_write_de4.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-de4.R 3 | \name{rmf_write_de4} 4 | \alias{rmf_write_de4} 5 | \title{Write a MODFLOW direct solver package} 6 | \usage{ 7 | rmf_write_de4( 8 | de4, 9 | file = { 10 | 11 | cat("Please choose de4 file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{de4}{an \code{RMODFLOW} de4 object} 20 | 21 | \item{file}{filename to write to; typically '*.de4'} 22 | 23 | \item{...}{ignored} 24 | } 25 | \value{ 26 | \code{NULL} 27 | } 28 | \description{ 29 | \code{rmf_write_de4} writes a MODFLOW direct solver file based on an \code{RMODFLOW} de4 object 30 | } 31 | \seealso{ 32 | \code{\link{rmf_read_de4}}, \code{\link{rmf_create_de4}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?de4.htm} 33 | } 34 | -------------------------------------------------------------------------------- /man/rmf_write_dis.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-dis.R 3 | \name{rmf_write_dis} 4 | \alias{rmf_write_dis} 5 | \title{Write a MODFLOW discretization file} 6 | \usage{ 7 | rmf_write_dis( 8 | dis, 9 | file = { 10 | 11 | cat("Please select dis file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | iprn = -1, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{dis}{an \code{\link{RMODFLOW}} dis object} 21 | 22 | \item{file}{filename to write to; typically '*.dis'} 23 | 24 | \item{iprn}{format code for printing arrays in the listing file; defaults to -1 (no printing)} 25 | 26 | \item{...}{arguments passed to \code{rmfi_write_array}. Can be ignored when arrays are INTERNAL or CONSTANT.} 27 | } 28 | \value{ 29 | \code{NULL} 30 | } 31 | \description{ 32 | Write a MODFLOW discretization file 33 | } 34 | \seealso{ 35 | \code{\link{rmf_read_dis}}, \code{\link{rmf_create_dis}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?dis.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_write_drn.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-drn.R 3 | \name{rmf_write_drn} 4 | \alias{rmf_write_drn} 5 | \title{Write a MODFLOW drain file} 6 | \usage{ 7 | rmf_write_drn( 8 | drn, 9 | dis = rmf_read_dis(), 10 | file = { 11 | 12 | cat("Please choose drn file to overwrite or provide new filename ...\\n") 13 | 14 | file.choose() 15 | }, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{drn}{an \code{RMODFLOW} drn object} 21 | 22 | \item{dis}{an \code{RMODFLOW} dis object} 23 | 24 | \item{file}{filename to write to; typically '*.drn'} 25 | 26 | \item{...}{arguments passed to \code{rmfi_write_variables} and \code{rmfi_write_list} when writing a fixed format file.} 27 | } 28 | \value{ 29 | \code{NULL} 30 | } 31 | \description{ 32 | \code{rmf_write_drn} writes a MODFLOW drain file based on an \code{RMODFLOW} drn object 33 | } 34 | \seealso{ 35 | \code{\link{rmf_read_drn}}, \code{\link{rmf_create_drn}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?drn.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_write_evt.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-evt.R 3 | \name{rmf_write_evt} 4 | \alias{rmf_write_evt} 5 | \title{Write a MODFLOW evapotranspiration file} 6 | \usage{ 7 | rmf_write_evt( 8 | evt, 9 | dis = { 10 | cat("Please select corresponding dis file ...\\n") 11 | 12 | rmf_read_dis(file.choose()) 13 | }, 14 | file = { 15 | 16 | cat("Please choose evt file to overwrite or provide new filename ...\\n") 17 | 18 | file.choose() 19 | }, 20 | iprn = -1, 21 | ... 22 | ) 23 | } 24 | \arguments{ 25 | \item{evt}{an \code{RMODFLOW} evt object} 26 | 27 | \item{dis}{an \code{RMODFLOW} dis object} 28 | 29 | \item{file}{filename to write to; typically '*.evt'} 30 | 31 | \item{iprn}{format code for printing arrays in the listing file; defaults to -1 (no printing)} 32 | 33 | \item{...}{arguments passed to \code{rmfi_write_variables} and \code{rmfi_write_array}} 34 | } 35 | \value{ 36 | \code{NULL} 37 | } 38 | \description{ 39 | \code{rmf_write_evt} writes a MODFLOW evapotranspiration file based on an \code{RMODFLOW} evt object 40 | } 41 | \seealso{ 42 | \code{\link{rmf_read_evt}}, \code{\link{rmf_create_evt}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?evt.htm} 43 | } 44 | -------------------------------------------------------------------------------- /man/rmf_write_ghb.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-ghb.R 3 | \name{rmf_write_ghb} 4 | \alias{rmf_write_ghb} 5 | \title{Write a MODFLOW general-head boundary file} 6 | \usage{ 7 | rmf_write_ghb( 8 | ghb, 9 | dis = rmf_read_dis(), 10 | file = { 11 | 12 | cat("Please choose ghb file to overwrite or provide new filename ...\\n") 13 | 14 | file.choose() 15 | }, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{ghb}{an \code{RMODFLOW} ghb object} 21 | 22 | \item{dis}{an \code{RMODFLOW} dis object} 23 | 24 | \item{file}{filename to write to; typically '*.ghb'} 25 | 26 | \item{...}{arguments passed to \code{rmfi_write_variables} and \code{rmfi_write_list} when writing a fixed format file.} 27 | } 28 | \value{ 29 | \code{NULL} 30 | } 31 | \description{ 32 | \code{rmf_write_ghb} writes a MODFLOW general-head boundary file based on an \code{RMODFLOW} ghb object 33 | } 34 | \seealso{ 35 | \code{\link{rmf_read_ghb}}, \code{\link{rmf_create_ghb}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?ghb.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_write_gmg.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-gmg.R 3 | \name{rmf_write_gmg} 4 | \alias{rmf_write_gmg} 5 | \title{Write a MODFLOW Geometric Multigrid Solver file} 6 | \usage{ 7 | rmf_write_gmg( 8 | gmg, 9 | file = { 10 | 11 | cat("Please select gmg file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{gmg}{an \code{\link{RMODFLOW}} gmg object} 20 | 21 | \item{file}{filename to write to; typically '*.gmg'} 22 | 23 | \item{...}{ignored} 24 | } 25 | \value{ 26 | \code{NULL} 27 | } 28 | \description{ 29 | Write a MODFLOW Geometric Multigrid Solver file 30 | } 31 | \seealso{ 32 | \code{\link{rmf_read_gmg}}, \code{\link{rmf_create_gmg}} and \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?gmg.htm} 33 | } 34 | -------------------------------------------------------------------------------- /man/rmf_write_hfb.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-hfb.R 3 | \name{rmf_write_hfb} 4 | \alias{rmf_write_hfb} 5 | \title{Write a MODFLOW horizontal flow barrier file} 6 | \usage{ 7 | rmf_write_hfb( 8 | hfb, 9 | dis = rmf_read_dis(), 10 | file = { 11 | 12 | cat("Please choose hfb file to overwrite or provide new filename ...\\n") 13 | 14 | file.choose() 15 | }, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{hfb}{an \code{RMODFLOW} hfb object} 21 | 22 | \item{dis}{an \code{RMODFLOW} dis object} 23 | 24 | \item{file}{filename to write to; typically '*.hfb'} 25 | 26 | \item{...}{ignored} 27 | } 28 | \value{ 29 | \code{NULL} 30 | } 31 | \description{ 32 | \code{rmf_write_hfb} writes a MODFLOW horizontal flow barrier file based on an \code{RMODFLOW} hfb object 33 | } 34 | \seealso{ 35 | \code{\link{rmf_read_hfb}}, \code{\link{rmf_create_hfb}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?hfb6.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_write_hob.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-hob.R 3 | \name{rmf_write_hob} 4 | \alias{rmf_write_hob} 5 | \title{Write a MODFLOW head observations file} 6 | \usage{ 7 | rmf_write_hob( 8 | hob, 9 | file = { 10 | 11 | cat("Please select hob file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{hob}{a \code{\link{RMODFLOW}} hob object} 20 | 21 | \item{file}{filename to write to; typically '*.hob'} 22 | 23 | \item{...}{arguments passed to \code{rmfi_write_variables} when writing a fixed format file.} 24 | } 25 | \value{ 26 | \code{NULL} 27 | } 28 | \description{ 29 | Write a MODFLOW head observations file 30 | } 31 | \seealso{ 32 | \code{\link{rmf_create_hob}}, \code{\link{rmf_read_hob}} and \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?hob.htm} 33 | } 34 | -------------------------------------------------------------------------------- /man/rmf_write_huf.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-huf.R 3 | \name{rmf_write_huf} 4 | \alias{rmf_write_huf} 5 | \title{Write a MODFLOW hydrogeologic unit flow file} 6 | \usage{ 7 | rmf_write_huf( 8 | huf, 9 | file = { 10 | 11 | cat("Please select huf file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | iprn = -1, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{huf}{an \code{\link{RMODFLOW}} huf object} 21 | 22 | \item{file}{filename to write to; typically '*.huf'} 23 | 24 | \item{iprn}{format code for printing arrays in the listing file; defaults to -1 (no printing)} 25 | 26 | \item{...}{arguments passed to \code{rmfi_write_array}. Can be ignored when arrays are INTERNAL or CONSTANT.} 27 | } 28 | \value{ 29 | \code{NULL} 30 | } 31 | \description{ 32 | Write a MODFLOW hydrogeologic unit flow file 33 | } 34 | \seealso{ 35 | \code{\link{rmf_convert_huf_to_grid}}, \code{\link{rmf_create_huf}}, \code{\link{rmf_read_huf}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?huf.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_write_kdep.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-huf.R 3 | \name{rmf_write_kdep} 4 | \alias{rmf_write_kdep} 5 | \title{Write a MODFLOW hydraulic conductivity depth-dependence capability file} 6 | \usage{ 7 | rmf_write_kdep( 8 | kdep, 9 | file = { 10 | 11 | cat("Please select kdep file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | iprn = -1, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{kdep}{an \code{RMODFLOW} kdep object} 21 | 22 | \item{file}{filename to write to; typically '*.kdep'} 23 | 24 | \item{iprn}{format code for printing arrays in the listing file; defaults to -1 (no printing)} 25 | 26 | \item{...}{arguments passed to \code{rmfi_write_array}. Can be ignored when arrays are INTERNAL or CONSTANT.} 27 | } 28 | \value{ 29 | \code{NULL} 30 | } 31 | \description{ 32 | Write a MODFLOW hydraulic conductivity depth-dependence capability file 33 | } 34 | \seealso{ 35 | \code{\link{rmf_create_kdep}}, \code{\link{rmf_read_kdep}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?kdep.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_write_lmt.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-lmt.R 3 | \name{rmf_write_lmt} 4 | \alias{rmf_write_lmt} 5 | \title{Write a MODFLOW Link-MT3DMS Package file} 6 | \usage{ 7 | rmf_write_lmt( 8 | lmt, 9 | file = { 10 | 11 | cat("Please choose lmt file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{lmt}{\code{RMODFLOW} lmt object} 20 | 21 | \item{file}{filename to write to; typically '*.lmt'} 22 | 23 | \item{...}{ignored} 24 | } 25 | \value{ 26 | \code{NULL} 27 | } 28 | \description{ 29 | Write a MODFLOW Link-MT3DMS Package file 30 | } 31 | \examples{ 32 | lmt <- rmf_create_lmt() 33 | rmf_write_lmt(lmt, file = file.path(tempdir(), 'input.lmt')) 34 | 35 | } 36 | \seealso{ 37 | \code{\link{rmf_create_lmt}}, \code{\link{rmf_read_lmt}} and \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?lmt6.htm} 38 | } 39 | -------------------------------------------------------------------------------- /man/rmf_write_lpf.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-lpf.R 3 | \name{rmf_write_lpf} 4 | \alias{rmf_write_lpf} 5 | \title{Write a MODFLOW layer-property flow file} 6 | \usage{ 7 | rmf_write_lpf( 8 | lpf, 9 | file = { 10 | 11 | cat("Please select lpf file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | dis = { 16 | cat("Please select corresponding dis file ...\\n") 17 | 18 | rmf_read_dis(file.choose()) 19 | }, 20 | iprn = -1, 21 | ... 22 | ) 23 | } 24 | \arguments{ 25 | \item{lpf}{an \code{\link{RMODFLOW}} lpf object} 26 | 27 | \item{file}{filename to write to; typically '*.lpf'} 28 | 29 | \item{iprn}{format code for printing arrays in the listing file; defaults to -1 (no printing)} 30 | 31 | \item{...}{arguments passed to \code{rmfi_write_array}. Can be ignored when arrays are INTERNAL or CONSTANT.} 32 | } 33 | \value{ 34 | \code{NULL} 35 | } 36 | \description{ 37 | Write a MODFLOW layer-property flow file 38 | } 39 | -------------------------------------------------------------------------------- /man/rmf_write_lvda.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-huf.R 3 | \name{rmf_write_lvda} 4 | \alias{rmf_write_lvda} 5 | \title{Write a MODFLOW model-layer variable-direction horizontal anisotropy capability file} 6 | \usage{ 7 | rmf_write_lvda( 8 | lvda, 9 | file = { 10 | 11 | cat("Please select lvda file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{lvda}{an \code{RMODFLOW} lvda object} 20 | 21 | \item{file}{filename to write to; typically '*.lvda'} 22 | 23 | \item{...}{ignored} 24 | } 25 | \value{ 26 | \code{NULL} 27 | } 28 | \description{ 29 | Write a MODFLOW model-layer variable-direction horizontal anisotropy capability file 30 | } 31 | \seealso{ 32 | \code{\link{rmf_create_lvda}}, \code{\link{rmf_read_lvda}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?lvda.htm} 33 | } 34 | -------------------------------------------------------------------------------- /man/rmf_write_mlt.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-mlt.R 3 | \name{rmf_write_mlt} 4 | \alias{rmf_write_mlt} 5 | \title{Write a MODFLOW multiplier file} 6 | \usage{ 7 | rmf_write_mlt( 8 | mlt, 9 | file = { 10 | 11 | cat("Please choose mlt file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | iprn = -1, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{mlt}{an \code{RMODFLOW} mlt object} 21 | 22 | \item{file}{filename to write to; typically '*.mlt'} 23 | 24 | \item{iprn}{format code for printing arrays in the listing file; defaults to -1 (no printing)} 25 | 26 | \item{...}{arguments passed to \code{rmfi_write_array}. Can be ignored when arrays are INTERNAL or CONSTANT.} 27 | } 28 | \value{ 29 | \code{NULL} 30 | } 31 | \description{ 32 | \code{rmf_write_mlt} writes an MODFLOW multiplier file based on a \code{RMODFLOW} mlt object 33 | } 34 | \seealso{ 35 | \code{\link{rmf_read_mlt}}, \code{\link{rmf_create_mlt}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?mult.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_write_nam.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-nam.R 3 | \name{rmf_write_nam} 4 | \alias{rmf_write_nam} 5 | \title{Write a MODFLOW name file} 6 | \usage{ 7 | rmf_write_nam( 8 | nam, 9 | file = { 10 | 11 | cat("Please select nam file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | exclude = NULL 16 | ) 17 | } 18 | \arguments{ 19 | \item{nam}{an \code{\link{RMODFLOW}} nam object} 20 | 21 | \item{file}{filename to write to; typically '*.nam'} 22 | 23 | \item{exclude}{character vector with packages names to exclude from the simulation. Defaults to NULL} 24 | } 25 | \value{ 26 | \code{NULL} 27 | } 28 | \description{ 29 | \code{rmf_write_nam} writes a MODFLOW name file based on an \code{\link{RMODFLOW}} nam object. 30 | } 31 | \seealso{ 32 | \code{\link{rmf_read_nam}}, \code{\link{rmf_write_nam}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?name_file.htm} 33 | } 34 | -------------------------------------------------------------------------------- /man/rmf_write_nwt.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-nwt.R 3 | \name{rmf_write_nwt} 4 | \alias{rmf_write_nwt} 5 | \title{Write a MODFLOW Newton solver package file} 6 | \usage{ 7 | rmf_write_nwt( 8 | nwt, 9 | file = { 10 | 11 | cat("Please select nwt file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{nwt}{an \code{\link{RMODFLOW}} nwt object} 20 | 21 | \item{file}{filename to write to; typically '*.nwt'} 22 | 23 | \item{...}{arguments passed to \code{rmfi_write_variables} when writing a fixed format file.} 24 | } 25 | \value{ 26 | \code{NULL} 27 | } 28 | \description{ 29 | Write a MODFLOW Newton solver package file 30 | } 31 | \seealso{ 32 | \code{\link{rmf_read_nwt}}, \code{\link{rmf_create_nwt}} and \url{https://water.usgs.gov/ogw/modflow-nwt/MODFLOW-NWT-Guide/} 33 | } 34 | -------------------------------------------------------------------------------- /man/rmf_write_oc.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-oc.R 3 | \name{rmf_write_oc} 4 | \alias{rmf_write_oc} 5 | \title{Write a MODFLOW output control option file} 6 | \usage{ 7 | rmf_write_oc( 8 | oc, 9 | file = { 10 | cat("Please select oc file to overwrite or provide new filename ...\\n") 11 | 12 | file.choose() 13 | }, 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{oc}{an \code{\link{RMODFLOW}} oc object} 19 | 20 | \item{file}{filename to write to; typically '*.oc'} 21 | 22 | \item{...}{arguments passed to \code{rmfi_write_variables} when writing a fixed format OC file using numeric codes.} 23 | } 24 | \value{ 25 | \code{NULL} 26 | } 27 | \description{ 28 | \code{rmf_write_oc} writes a MODFLOW output control option file based on an \code{\link{RMODFLOW}} oc object. 29 | } 30 | \seealso{ 31 | \code{\link{rmf_read_oc}}, \code{\link{rmf_create_oc}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?oc.htm} 32 | } 33 | -------------------------------------------------------------------------------- /man/rmf_write_pcg.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-pcg.R 3 | \name{rmf_write_pcg} 4 | \alias{rmf_write_pcg} 5 | \title{Write a MODFLOW preconditioned conjugate-gradient package file} 6 | \usage{ 7 | rmf_write_pcg( 8 | pcg, 9 | file = { 10 | 11 | cat("Please select pcg file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{pcg}{an \code{\link{RMODFLOW}} pcg object} 20 | 21 | \item{file}{filename to write to; typically '*.pcg'} 22 | 23 | \item{...}{arguments passed to \code{rmfi_write_variables} when writing a fixed format file.} 24 | } 25 | \value{ 26 | \code{NULL} 27 | } 28 | \description{ 29 | Write a MODFLOW preconditioned conjugate-gradient package file 30 | } 31 | \seealso{ 32 | \code{\link{rmf_read_pcg}}, \code{\link{rmf_create_pcg}} and \url{http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?pcg.htm} 33 | } 34 | -------------------------------------------------------------------------------- /man/rmf_write_pval.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-pval.R 3 | \name{rmf_write_pval} 4 | \alias{rmf_write_pval} 5 | \title{Write a MODFLOW parameter value file} 6 | \usage{ 7 | rmf_write_pval(pval, path) 8 | } 9 | \arguments{ 10 | \item{pval}{an \code{\link{RMODFLOW}} pval object} 11 | 12 | \item{path}{Path to write the PVAL file. Typically with extension \code{.pval}.} 13 | } 14 | \value{ 15 | \code{NULL} 16 | } 17 | \description{ 18 | Write a MODFLOW parameter value file 19 | } 20 | \seealso{ 21 | \code{\link{rmf_create_pval}}, \code{\link{rmf_read_pval}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?pval.htm} 22 | } 23 | -------------------------------------------------------------------------------- /man/rmf_write_rch.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-rch.R 3 | \name{rmf_write_rch} 4 | \alias{rmf_write_rch} 5 | \title{Write a MODFLOW recharge file} 6 | \usage{ 7 | rmf_write_rch( 8 | rch, 9 | dis = { 10 | cat("Please select corresponding dis file ...\\n") 11 | 12 | rmf_read_dis(file.choose()) 13 | }, 14 | file = { 15 | 16 | cat("Please choose rch file to overwrite or provide new filename ...\\n") 17 | 18 | file.choose() 19 | }, 20 | iprn = -1, 21 | ... 22 | ) 23 | } 24 | \arguments{ 25 | \item{rch}{an \code{RMODFLOW} rch object} 26 | 27 | \item{dis}{an \code{RMODFLOW} dis object} 28 | 29 | \item{file}{filename to write to; typically '*.rch'} 30 | 31 | \item{iprn}{format code for printing arrays in the listing file; defaults to -1 (no printing)} 32 | 33 | \item{...}{arguments passed to \code{rmfi_write_variables} and \code{rmfi_write_array}} 34 | } 35 | \value{ 36 | \code{NULL} 37 | } 38 | \description{ 39 | \code{rmf_write_rch} writes a MODFLOW recharge file based on an \code{RMODFLOW} rch object 40 | } 41 | \seealso{ 42 | \code{\link{rmf_read_rch}}, \code{\link{rmf_create_rch}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?rch.htm} 43 | } 44 | -------------------------------------------------------------------------------- /man/rmf_write_riv.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-riv.R 3 | \name{rmf_write_riv} 4 | \alias{rmf_write_riv} 5 | \title{Write a MODFLOW river file} 6 | \usage{ 7 | rmf_write_riv( 8 | riv, 9 | dis = rmf_read_dis(), 10 | file = { 11 | 12 | cat("Please choose riv file to overwrite or provide new filename ...\\n") 13 | 14 | file.choose() 15 | }, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{riv}{an \code{RMODFLOW} riv object} 21 | 22 | \item{dis}{an \code{RMODFLOW} dis object} 23 | 24 | \item{file}{filename to write to; typically '*.riv'} 25 | 26 | \item{...}{arguments passed to \code{rmfi_write_variables} and \code{rmfi_write_list} when writing a fixed format file.} 27 | } 28 | \value{ 29 | \code{NULL} 30 | } 31 | \description{ 32 | \code{rmf_write_riv} writes a MODFLOW river file based on an \code{RMODFLOW} riv object 33 | } 34 | \seealso{ 35 | \code{\link{rmf_read_riv}}, \code{\link{rmf_create_riv}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?riv.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_write_sip.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-sip.R 3 | \name{rmf_write_sip} 4 | \alias{rmf_write_sip} 5 | \title{Write a MODFLOW strongly implicit procedure package} 6 | \usage{ 7 | rmf_write_sip( 8 | sip, 9 | file = { 10 | 11 | cat("Please choose sip file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{sip}{an \code{RMODFLOW} sip object} 20 | 21 | \item{file}{filename to write to; typically '*.sip'} 22 | 23 | \item{...}{arguments passed to \code{rmfi_write_variables} when writing a fixed format file.} 24 | } 25 | \value{ 26 | \code{NULL} 27 | } 28 | \description{ 29 | \code{rmf_write_sip} writes a MODFLOW strongly implicit procedure file based on an \code{RMODFLOW} sip object 30 | } 31 | \seealso{ 32 | \code{\link{rmf_read_sip}}, \code{\link{rmf_create_sip}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?sip.htm} 33 | } 34 | -------------------------------------------------------------------------------- /man/rmf_write_upw.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-upw.R 3 | \name{rmf_write_upw} 4 | \alias{rmf_write_upw} 5 | \title{Write a MODFLOW-NWT upstream weighting file} 6 | \usage{ 7 | rmf_write_upw( 8 | upw, 9 | file = { 10 | 11 | cat("Please select upw file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | dis = { 16 | cat("Please select corresponding dis file ...\\n") 17 | 18 | rmf_read_dis(file.choose()) 19 | }, 20 | iprn = -1, 21 | ... 22 | ) 23 | } 24 | \arguments{ 25 | \item{upw}{an \code{\link{RMODFLOW}} upw object} 26 | 27 | \item{file}{filename to write to; typically '*.upw'} 28 | 29 | \item{iprn}{format code for printing arrays in the listing file; defaults to -1 (no printing)} 30 | 31 | \item{...}{arguments passed to \code{rmfi_write_array}. Can be ignored when arrays are INTERNAL or CONSTANT.} 32 | } 33 | \value{ 34 | \code{NULL} 35 | } 36 | \description{ 37 | Write a MODFLOW-NWT upstream weighting file 38 | } 39 | \note{ 40 | upw input structure is nearly identical to lpf but calculations are done differently. Differences include the addition of the iphdry value and the ommision of optional keywords. Layer wetting capabilities are also not supported by upw. 41 | 42 | upw must be used with the Newton solver. See also \code{\link{rmf_create_nwt}}. 43 | } 44 | -------------------------------------------------------------------------------- /man/rmf_write_wel.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-wel.R 3 | \name{rmf_write_wel} 4 | \alias{rmf_write_wel} 5 | \title{Write a MODFLOW well file} 6 | \usage{ 7 | rmf_write_wel( 8 | wel, 9 | dis = rmf_read_dis(), 10 | file = { 11 | 12 | cat("Please choose wel file to overwrite or provide new filename ...\\n") 13 | 14 | file.choose() 15 | }, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{wel}{an \code{RMODFLOW} wel object} 21 | 22 | \item{dis}{an \code{RMODFLOW} dis object} 23 | 24 | \item{file}{filename to write to; typically '*.wel'} 25 | 26 | \item{...}{arguments passed to \code{rmfi_write_variables} and \code{rmfi_write_list} when writing a fixed format file.} 27 | } 28 | \value{ 29 | \code{NULL} 30 | } 31 | \description{ 32 | \code{rmf_write_wel} writes a MODFLOW well file based on an \code{RMODFLOW} wel object 33 | } 34 | \seealso{ 35 | \code{\link{rmf_read_wel}}, \code{\link{rmf_create_wel}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?wel.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmf_write_zon.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/package-zon.R 3 | \name{rmf_write_zon} 4 | \alias{rmf_write_zon} 5 | \title{Write a MODFLOW zone file} 6 | \usage{ 7 | rmf_write_zon( 8 | zon, 9 | file = { 10 | 11 | cat("Please choose zon file to overwrite or provide new filename ...\\n") 12 | 13 | file.choose() 14 | }, 15 | iprn = -1, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{zon}{an \code{RMODFLOW} zon object} 21 | 22 | \item{file}{filename to write to; typically '*.zon'} 23 | 24 | \item{iprn}{format code for printing arrays in the listing file; defaults to -1 (no printing)} 25 | 26 | \item{...}{arguments passed to \code{rmfi_write_array}. Can be ignored when arrays are INTERNAL or CONSTANT.} 27 | } 28 | \value{ 29 | \code{NULL} 30 | } 31 | \description{ 32 | \code{rmf_write_zon} writes a MODFLOW zone file based on a \code{RMODFLOW} zon object 33 | } 34 | \seealso{ 35 | \code{\link{rmf_read_zon}}, \code{\link{rmf_create_zon}}, \url{https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?zone.htm} 36 | } 37 | -------------------------------------------------------------------------------- /man/rmfi_backup_pval.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/execute.R 3 | \name{rmfi_backup_pval} 4 | \alias{rmfi_backup_pval} 5 | \title{Backup a PVAL file} 6 | \usage{ 7 | rmfi_backup_pval(dir, nam) 8 | } 9 | \arguments{ 10 | \item{dir}{Character. Path to directory containing the NAM file.} 11 | 12 | \item{nam}{Character. File name of the NAM file.} 13 | } 14 | \description{ 15 | Backup a PVAL file 16 | } 17 | -------------------------------------------------------------------------------- /man/rmfi_bilinear_intp.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_bilinear_intp} 4 | \alias{rmfi_bilinear_intp} 5 | \title{Bilinear interpolation on a rectilinear grid} 6 | \usage{ 7 | rmfi_bilinear_intp(x, y, f, xout, yout) 8 | } 9 | \arguments{ 10 | \item{x}{x coordinates of known points} 11 | 12 | \item{y}{y coordinates of known points} 13 | 14 | \item{f}{values at known poins (length 4). Order: bottom-left, bottom-right, top-left, top-right; using R's column-major ordering} 15 | 16 | \item{xout}{x coordinate of point to interpolate} 17 | 18 | \item{yout}{y coordinate of point to interpolate} 19 | } 20 | \value{ 21 | single bilinear interpolated value 22 | } 23 | \description{ 24 | Bilinear interpolation on a rectilinear grid 25 | } 26 | \keyword{internal} 27 | -------------------------------------------------------------------------------- /man/rmfi_confining_beds.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_confining_beds} 4 | \alias{rmfi_confining_beds} 5 | \title{Create sequence of confining bed indicators} 6 | \usage{ 7 | rmfi_confining_beds(dis) 8 | } 9 | \arguments{ 10 | \item{dis}{\code{RMODFLOW} dis object} 11 | } 12 | \value{ 13 | vector of length \code{dis$nlay + confining beds} indicating indicating if the index represents a confining bed 14 | } 15 | \description{ 16 | Create sequence of confining bed indicators 17 | } 18 | \details{ 19 | When confining beds are present, \code{dis$botm} has \code{dis$nlay + number of confining beds} layers. 20 | This functions returns a logical vector indicating which of those layers is a confining bed. This is useful 21 | when handling calculations with \code{dis$botm}, e.g. calculating thicknesses. 22 | } 23 | \keyword{internal} 24 | -------------------------------------------------------------------------------- /man/rmfi_convert_coordinates.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_convert_coordinates} 4 | \alias{rmfi_convert_coordinates} 5 | \title{Convert data frame coordinates to another coordinate reference system} 6 | \usage{ 7 | rmfi_convert_coordinates(dat, from, to) 8 | } 9 | \arguments{ 10 | \item{dat}{data frame with x and y (and/or z) coordinates} 11 | 12 | \item{from}{coordinate reference system of the data} 13 | 14 | \item{to}{target coordinate reference system} 15 | } 16 | \value{ 17 | data frame with converted coordinates 18 | } 19 | \description{ 20 | Convert data frame coordinates to another coordinate reference system 21 | } 22 | \keyword{internal} 23 | -------------------------------------------------------------------------------- /man/rmfi_convert_huf_to_nlay.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_convert_huf_to_nlay} 4 | \alias{rmfi_convert_huf_to_nlay} 5 | \title{Convert a huf object to an rmf_3d_array with the number of numerical layers per hydrogeological unit} 6 | \usage{ 7 | rmfi_convert_huf_to_nlay(huf, dis, bas = NULL) 8 | } 9 | \arguments{ 10 | \item{huf}{huf object} 11 | 12 | \item{dis}{dis object, corresponding to the huf object} 13 | 14 | \item{bas}{bas object, corresponding to the huf object; defaults to NULL} 15 | } 16 | \value{ 17 | nlay rmf_3d_array 18 | } 19 | \description{ 20 | Convert a huf object to an rmf_3d_array with the number of numerical layers per hydrogeological unit 21 | } 22 | \keyword{internal} 23 | -------------------------------------------------------------------------------- /man/rmfi_create_bc_array.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_create_bc_array} 4 | \alias{rmfi_create_bc_array} 5 | \title{Set array input for a MODFLOW boundary condition package} 6 | \usage{ 7 | rmfi_create_bc_array(arg, dis) 8 | } 9 | \arguments{ 10 | \item{arg}{list of (1) \code{rmf_2d_array's} and/or rmf_parameter array objects or (2) a single nested \code{list} with \code{rmf_2d_array's} and/or rmf_parameter elements or (3) a \code{matrix}; defines the boundary condition input.} 11 | 12 | \item{dis}{dis object. If not explicitely suplied, the function will look in the arg argument for an object of class 'dis'.} 13 | } 14 | \value{ 15 | list with the parameters, input arrays and the kper argument 16 | } 17 | \description{ 18 | Set array input for a MODFLOW boundary condition package 19 | } 20 | \details{ 21 | typically, \code{arg} is \code{list(...)} where the ellipsis contains all the input \code{rmf_arrays} for the \code{rmf_create_*} function. When matrix elements are present, they are coerced to rmf_2d_arrays which are active for all stress-periods with a warning. 22 | } 23 | \seealso{ 24 | \code{\link{rmfi_create_bc_list}}, \code{\link{rmfi_write_bc_list}}, \code{\link{rmfi_parse_bc_list}}, \code{\link{rmfi_parse_array_parameters}}, \code{\link{rmfi_write_array_parameters}} 25 | } 26 | \keyword{internal} 27 | -------------------------------------------------------------------------------- /man/rmfi_create_bc_list.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_create_bc_list} 4 | \alias{rmfi_create_bc_list} 5 | \title{Set list input for a MODFLOW boundary condition package} 6 | \usage{ 7 | rmfi_create_bc_list(arg, dis, varnames, aux = NULL) 8 | } 9 | \arguments{ 10 | \item{arg}{list of (1) rmf_list and/or rmf_parameter list objects or (2) a single nested \code{list} with rmf_list and/or rmf_parameter elements or (3) a \code{data.frame} that will be coerced to a rmf_list; defines the boundary condition input.} 11 | 12 | \item{dis}{dis object. If not explicitely suplied, the function will look in the arg argument for an object of class 'dis'.} 13 | 14 | \item{varnames}{character vector with the names of the variables starting from the 4th column (so after ijk)} 15 | 16 | \item{aux}{optional character vector with the names of the auxiliary variables} 17 | } 18 | \value{ 19 | list with the data, possible parameter values, dimensions and the kper data.frame 20 | } 21 | \description{ 22 | Set list input for a MODFLOW boundary condition package 23 | } 24 | \details{ 25 | typically, \code{arg} is \code{list(...)} where the ellipsis contains all the input \code{rmf_lists} for the \code{rmf_create_*} function. All elements should have corresponding columns. 26 | } 27 | \seealso{ 28 | \code{\link{rmfi_create_bc_array}}, \code{\link{rmfi_write_bc_list}}, \code{\link{rmfi_parse_bc_list}} 29 | } 30 | \keyword{internal} 31 | -------------------------------------------------------------------------------- /man/rmfi_download_code.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/install.R 3 | \name{rmfi_download_code} 4 | \alias{rmfi_download_code} 5 | \title{Download a code} 6 | \usage{ 7 | rmfi_download_code(code, dir, os, overwrite) 8 | } 9 | \arguments{ 10 | \item{code}{Character vector with the codes to install, or \code{"all"} (default).} 11 | 12 | \item{dir}{Installation directory.} 13 | 14 | \item{os}{Operating system.} 15 | 16 | \item{overwrite}{Logical. Overwrite when the code is already installed? If 17 | \code{NULL} (default), the user is asked what to do in an interactive session. 18 | An error message is issued otherwise.} 19 | } 20 | \description{ 21 | Download a code 22 | } 23 | -------------------------------------------------------------------------------- /man/rmfi_find.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/execute.R 3 | \name{rmfi_find} 4 | \alias{rmfi_find} 5 | \title{Find paths to executables} 6 | \usage{ 7 | rmfi_find(code = "2005", precision = "single") 8 | } 9 | \arguments{ 10 | \item{code}{Name of the MODFLOW variant to use, or path to the executable.} 11 | 12 | \item{precision}{Character. Can be \code{"single"} or \code{"double"}. Only 13 | relevant for MODFLOW-2005.} 14 | } 15 | \value{ 16 | Path to the executable. 17 | } 18 | \description{ 19 | This function tries to locate external code executables. 20 | } 21 | \details{ 22 | It first looks for the executable in the current working directory. If not 23 | there, it looks in the bin subfolder of \code{getOption("RMODFLOW.path")}, where 24 | the software might have been installed by \code{\link[=rmf_install]{rmf_install()}}. If the executable 25 | cannot be found, a final attempt is made by checking the system path 26 | variable. If it still cannot be located, an error is thrown. 27 | } 28 | -------------------------------------------------------------------------------- /man/rmfi_fortran_format.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_fortran_format} 4 | \alias{rmfi_fortran_format} 5 | \title{Returns character lengths per value from a FORTRAN format} 6 | \usage{ 7 | rmfi_fortran_format(format) 8 | } 9 | \arguments{ 10 | \item{format}{character; FORTRAN format within parentheses as read from a MODFLOW array header} 11 | } 12 | \value{ 13 | integer vector with the number of characters per value as specified by the FORTRAN format 14 | } 15 | \description{ 16 | Returns character lengths per value from a FORTRAN format 17 | } 18 | \keyword{internal} 19 | -------------------------------------------------------------------------------- /man/rmfi_geomean.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_geomean} 4 | \alias{rmfi_geomean} 5 | \title{Calculate a geometric mean} 6 | \usage{ 7 | rmfi_geomean(x, ...) 8 | } 9 | \arguments{ 10 | \item{x}{An R object.} 11 | 12 | \item{...}{further arguments passed to \code{\link{prod}}} 13 | } 14 | \description{ 15 | Calculate a geometric mean 16 | } 17 | \seealso{ 18 | \code{\link{rmfi_harmean}} and \code{\link{mean}} 19 | } 20 | \keyword{internal} 21 | -------------------------------------------------------------------------------- /man/rmfi_guide_url.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/web.R 3 | \name{rmfi_guide_url} 4 | \alias{rmfi_guide_url} 5 | \title{Complete guide url from page name or shortcut} 6 | \usage{ 7 | rmfi_guide_url(name) 8 | } 9 | \arguments{ 10 | \item{name}{Name of the online guide page to launch, or a shortcut from 11 | \code{rmfd_guide_shortcuts} that can be translated to one.} 12 | } 13 | \value{ 14 | Complete URL of the online guide page. 15 | } 16 | \description{ 17 | Complete guide url from page name or shortcut 18 | } 19 | -------------------------------------------------------------------------------- /man/rmfi_harmean.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_harmean} 4 | \alias{rmfi_harmean} 5 | \title{Calculate a harmonic mean} 6 | \usage{ 7 | rmfi_harmean(x, ...) 8 | } 9 | \arguments{ 10 | \item{x}{An invertable R object.} 11 | 12 | \item{...}{further arguments passed to \code{\link{mean}}} 13 | } 14 | \description{ 15 | Calculate a harmonic mean 16 | } 17 | \seealso{ 18 | \code{\link{rmfi_geomean}} and \code{\link{mean}} 19 | } 20 | \keyword{internal} 21 | -------------------------------------------------------------------------------- /man/rmfi_ifelse0.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_ifelse0} 4 | \alias{rmfi_ifelse0} 5 | \title{Conditional return} 6 | \usage{ 7 | rmfi_ifelse0(test, yes, no) 8 | } 9 | \arguments{ 10 | \item{test}{an object which can be coerced to logical mode.} 11 | 12 | \item{yes}{return value for \code{test==TRUE}} 13 | 14 | \item{no}{return value for \code{test==FALSE}} 15 | } 16 | \description{ 17 | \code{rmfi_ifelse0} returns \code{yes} if \code{test} is \code{TRUE}. If \code{test} is \code{FALSE}, it returns \code{no}. 18 | } 19 | \keyword{internal} 20 | -------------------------------------------------------------------------------- /man/rmfi_install_code.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/install.R 3 | \name{rmfi_install_code} 4 | \alias{rmfi_install_code} 5 | \title{Install codes} 6 | \usage{ 7 | rmfi_install_code(code, overwrite) 8 | } 9 | \arguments{ 10 | \item{code}{Character vector with the codes to install, or \code{"all"} (default).} 11 | 12 | \item{overwrite}{Logical. Overwrite when the code is already installed? If 13 | \code{NULL} (default), the user is asked what to do in an interactive session. 14 | An error message is issued otherwise.} 15 | } 16 | \description{ 17 | Install codes 18 | } 19 | -------------------------------------------------------------------------------- /man/rmfi_list_packages.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_list_packages} 4 | \alias{rmfi_list_packages} 5 | \title{List supported MODFLOW packages} 6 | \usage{ 7 | rmfi_list_packages(type = "all") 8 | } 9 | \arguments{ 10 | \item{type}{character denoting type of packages to list; possible values are \code{'all' (default), 'basic', 'flow', 'boundary', 'solver', 'oc', 'sub', 'obs', 'swr', 'cfp', 'farm', 'cbc', 'output'}} 11 | } 12 | \value{ 13 | data.frame with ftype and rmf columns denoting the MODFLOW and \code{RMODFLOW} abbreviations for the requested packages 14 | } 15 | \description{ 16 | List supported MODFLOW packages 17 | } 18 | \details{ 19 | 'cbc' returns all packages which allow a i*cbc flag to be set which is a flag and unit number for writing cell-by-cell flow data. 'output' lists all supported output types. 20 | } 21 | \note{ 22 | this function should be updated every time a new MODFLOW package is supported in \code{RMODFLOW} 23 | } 24 | \keyword{internal} 25 | -------------------------------------------------------------------------------- /man/rmfi_look_for_path.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/execute.R 3 | \name{rmfi_look_for_path} 4 | \alias{rmfi_look_for_path} 5 | \title{Look for a file path in a NAM file} 6 | \usage{ 7 | rmfi_look_for_path(dir, nam, type = NULL, unit = NULL) 8 | } 9 | \arguments{ 10 | \item{dir}{Character. Path to directory containing the NAM file.} 11 | 12 | \item{nam}{Character. File name of the NAM file.} 13 | 14 | \item{type}{Character. File type (ftype) of the entry to look for.} 15 | 16 | \item{unit}{Integer. Unit number of the entry to look for.} 17 | } 18 | \description{ 19 | Look for a file path in a NAM file 20 | } 21 | -------------------------------------------------------------------------------- /man/rmfi_parse_array_parameters.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_parse_array_parameters} 4 | \alias{rmfi_parse_array_parameters} 5 | \title{Read MODFLOW array parameters for boundary-condition packages} 6 | \usage{ 7 | rmfi_parse_array_parameters(lines, dis, np, mlt = NULL, zon = NULL) 8 | } 9 | \arguments{ 10 | \item{lines}{lines to read the parameter arrays from} 11 | 12 | \item{dis}{\code{RMODFLOW} dis object} 13 | 14 | \item{np}{numeric; number of parameters to read} 15 | 16 | \item{mlt}{a \code{RMODFLOW} mlt object. Only needed when reading parameter arrays defined by multiplier arrays} 17 | 18 | \item{zon}{a \code{RMODFLOW} zon object. Only needed when reading parameter arrays defined by zone arrays} 19 | } 20 | \value{ 21 | A list containing the parameter arrays and the remaining text of the MODFLOW input file 22 | } 23 | \description{ 24 | Read MODFLOW array parameters for boundary-condition packages 25 | } 26 | \seealso{ 27 | \code{\link{rmfi_write_array_parameters}} 28 | } 29 | \keyword{internal} 30 | -------------------------------------------------------------------------------- /man/rmfi_parse_bc_list.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_parse_bc_list} 4 | \alias{rmfi_parse_bc_list} 5 | \title{Read input for a MODFLOW boundary condition package which uses list-directed input} 6 | \usage{ 7 | rmfi_parse_bc_list(lines, dis, varnames, option, scalevar, ...) 8 | } 9 | \arguments{ 10 | \item{lines}{lines as returned from readr::read_lines} 11 | 12 | \item{dis}{an \code{RMODFLOW} dis object} 13 | 14 | \item{varnames}{character vector with the names of the variables starting from the 4th column (so after ijk)} 15 | 16 | \item{option}{optional named logical vector with the names of the options besides aux} 17 | 18 | \item{scalevar}{integer, indicating which column is (possibly) scaled by SFAC} 19 | 20 | \item{...}{arguments passed to \code{rmfi_parse_variables} and \code{rmfi_parse_list}.} 21 | } 22 | \value{ 23 | list with (optional) comments, icb, option, aux and rmf_lists 24 | } 25 | \description{ 26 | Read input for a MODFLOW boundary condition package which uses list-directed input 27 | } 28 | \seealso{ 29 | \code{\link{rmfi_create_bc_list}}, \code{\link{rmfi_write_bc_list}} 30 | } 31 | \keyword{internal} 32 | -------------------------------------------------------------------------------- /man/rmfi_parse_comments.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_parse_comments} 4 | \alias{rmfi_parse_comments} 5 | \title{Read comments 6 | Internal function used in the read_* functions to read comments} 7 | \usage{ 8 | rmfi_parse_comments(remaining_lines) 9 | } 10 | \description{ 11 | Read comments 12 | Internal function used in the read_* functions to read comments 13 | } 14 | \details{ 15 | removes empty comments and prevents copying of RMODFLOW header comment 16 | } 17 | \keyword{internal} 18 | -------------------------------------------------------------------------------- /man/rmfi_parse_list.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_parse_list} 4 | \alias{rmfi_parse_list} 5 | \title{Reads a MODFLOW list} 6 | \usage{ 7 | rmfi_parse_list( 8 | remaining_lines, 9 | nlst, 10 | l = NULL, 11 | varnames, 12 | scalevar = 4, 13 | file, 14 | naux = 0, 15 | format = "free", 16 | precision = "single", 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{nlst}{number of list rows to read} 22 | 23 | \item{l}{stress period number} 24 | 25 | \item{varnames}{character vector; names of the variables starting from the 4th column (so after ijk). Length of varnames is used to dimension the dataframe} 26 | 27 | \item{scalevar}{column name or integer; this column will be scaled} 28 | 29 | \item{file}{the file that is being read; needed if list is specified through an OPEN/CLOSE statement} 30 | 31 | \item{naux}{integer; number of auxiliary variables to read (which are always free format). Defaults to 0.} 32 | 33 | \item{format}{either 'fixed' or 'free'} 34 | 35 | \item{...}{ignored} 36 | } 37 | \description{ 38 | Reads a MODFLOW list 39 | } 40 | \keyword{internal} 41 | -------------------------------------------------------------------------------- /man/rmfi_parse_prj.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/spatial.R 3 | \name{rmfi_parse_prj} 4 | \alias{rmfi_parse_prj} 5 | \title{Read RMODFLOW projection information from header comments} 6 | \usage{ 7 | rmfi_parse_prj(comments) 8 | } 9 | \arguments{ 10 | \item{comments}{strings possibly containing RMODFLOW projection information.} 11 | } 12 | \value{ 13 | a list with a \code{prj} object and the remaining comments 14 | } 15 | \description{ 16 | Read RMODFLOW projection information from header comments 17 | } 18 | \details{ 19 | \code{comments} is typically the output of \code{rmfi_parse_comments} as called when reading the discretization file. 20 | RMODFLOW projection is typically present in the header comments of the discretization file. 21 | } 22 | \keyword{internal} 23 | -------------------------------------------------------------------------------- /man/rmfi_parse_variables.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_parse_variables} 4 | \alias{rmfi_parse_variables} 5 | \title{Read modflow variables 6 | If all are numbers, returns numeric, otherwise returns character vector} 7 | \usage{ 8 | rmfi_parse_variables( 9 | remaining_lines, 10 | n, 11 | nlay = NULL, 12 | character = FALSE, 13 | format = "free", 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{n}{integer; number of variables to be returned. Only used when format is \code{'fixed'}.} 19 | 20 | \item{nlay}{integer; number of layers for which values are to be read. Only used when format is \code{'free'} and a 1D(NLAY) variable is read which may be specified on multiple lines.} 21 | 22 | \item{character}{logical; should a character vector be returned. Prevents conversion from character names to numeric. Defaults to FALSE. Useful if only characters are present on the line.} 23 | 24 | \item{format}{character, either \code{'free'} or \code{'fixed'}. When 'fixed', reads 10-character fields and converts to numeric. Empty fields are set to zero.} 25 | 26 | \item{...}{ignored} 27 | } 28 | \description{ 29 | Read modflow variables 30 | If all are numbers, returns numeric, otherwise returns character vector 31 | } 32 | \keyword{internal} 33 | -------------------------------------------------------------------------------- /man/rmfi_performance_measures.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_performance_measures} 4 | \alias{rmfi_performance_measures} 5 | \title{Model performance measures} 6 | \usage{ 7 | rmfi_performance_measures( 8 | observations, 9 | predictions, 10 | print = FALSE, 11 | measures = c("ssq", "mse", "mae", "me", "r2", "nse", "rmse", "pbias", "kge"), 12 | ... 13 | ) 14 | } 15 | \arguments{ 16 | \item{measures}{any of the measures present in \code{\link{hydroGOF::gof}} + 'ssq' (sum of squared errors)} 17 | 18 | \item{...}{arguments passes to \code{\link{hydroGOF::gof}}} 19 | } 20 | \description{ 21 | Model performance measures 22 | } 23 | \keyword{internal} 24 | -------------------------------------------------------------------------------- /man/rmfi_prj_length_multiplier.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/spatial.R 3 | \name{rmfi_prj_length_multiplier} 4 | \alias{rmfi_prj_length_multiplier} 5 | \title{Obtain a multiplier to convert MODFLOW length units to projection length units} 6 | \usage{ 7 | rmfi_prj_length_multiplier(dis, prj, to) 8 | } 9 | \arguments{ 10 | \item{dis}{\code{RMODFLOW} dis object} 11 | 12 | \item{prj}{\code{RMODFLOW} prj object} 13 | 14 | \item{to}{either 'grid' or 'xyz' specifying if the multiplier should convert coordinates to the modflow grid or to real world coordinates (inverse)} 15 | } 16 | \value{ 17 | single numeric value which can be used to multiply MODFLOW coordinates with so to convert them to prj length units. 18 | } 19 | \description{ 20 | Obtain a multiplier to convert MODFLOW length units to projection length units 21 | } 22 | \details{ 23 | The MODFLOW length unit \code{(dis$lenuni)} can be different from the projection unit \code{(prj$crs$units)}. When converting coordinates 24 | using \code{rmf_convert_grid_to_xyz} or \code{rmf_convert_xyz_to_grid} the difference in length unit needs to be corrected for. 25 | } 26 | \keyword{internal} 27 | -------------------------------------------------------------------------------- /man/rmfi_remove_comments_end_of_line.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_remove_comments_end_of_line} 4 | \alias{rmfi_remove_comments_end_of_line} 5 | \title{Remove comments at the end of a string} 6 | \usage{ 7 | rmfi_remove_comments_end_of_line(line) 8 | } 9 | \arguments{ 10 | \item{line}{A string.} 11 | } 12 | \value{ 13 | The string, without the commented part. 14 | } 15 | \description{ 16 | Remove comments at the end of a string 17 | } 18 | \keyword{internal} 19 | -------------------------------------------------------------------------------- /man/rmfi_remove_empty_strings.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_remove_empty_strings} 4 | \alias{rmfi_remove_empty_strings} 5 | \title{Remove empty elements from a vector of strings.} 6 | \usage{ 7 | rmfi_remove_empty_strings(vector_of_strings) 8 | } 9 | \arguments{ 10 | \item{vector_of_strings}{Vector of strings.} 11 | } 12 | \value{ 13 | Vector of strings without the empty items. 14 | } 15 | \description{ 16 | Remove empty elements from a vector of strings. 17 | } 18 | \keyword{internal} 19 | -------------------------------------------------------------------------------- /man/rmfi_replace_in_vector.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/execute.R 3 | \name{rmfi_replace_in_vector} 4 | \alias{rmfi_replace_in_vector} 5 | \title{Replace values in a vector with corresponding parameter names} 6 | \usage{ 7 | rmfi_replace_in_vector(parnam, parval, new, start = parval) 8 | } 9 | \arguments{ 10 | \item{parnam}{Character vector of parameter names from a PVAL file.} 11 | 12 | \item{parval}{Vector of values. Can be numeric as in PVAL file, but also 13 | character for \emph{e.g.} the transformation.} 14 | 15 | \item{new}{Named numeric vector, or named list of functions and/or numeric 16 | values.} 17 | } 18 | \description{ 19 | This function is a helper for processing the arguments of \code{\link[=rmf_execute]{rmf_execute()}}, 20 | \code{\link[=rmf_analyze]{rmf_analyze()}} and \code{\link[=rmf_optimize]{rmf_optimize()}} that can be named vectors, a named 21 | lists of functions. 22 | } 23 | -------------------------------------------------------------------------------- /man/rmfi_rev_rainbow.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_rev_rainbow} 4 | \alias{rmfi_rev_rainbow} 5 | \title{Reversed rainbow color palette} 6 | \usage{ 7 | rmfi_rev_rainbow(...) 8 | } 9 | \description{ 10 | Reversed rainbow color palette 11 | } 12 | \keyword{internal} 13 | -------------------------------------------------------------------------------- /man/rmfi_trilinear_intp.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_trilinear_intp} 4 | \alias{rmfi_trilinear_intp} 5 | \title{Trilinear interpolation on a rectilinear grid} 6 | \usage{ 7 | rmfi_trilinear_intp(x, y, z, f, xout, yout, zout) 8 | } 9 | \arguments{ 10 | \item{x}{x coordinates of known points} 11 | 12 | \item{y}{y coordinates of known points} 13 | 14 | \item{z}{z coordinates of known points} 15 | 16 | \item{f}{values at known poins (length 8). Order: upper:bottom-left, bottom-right, top-left, top-right; bottom:bottom-left, bottom-right, top-left, top-right; using R's column-major ordering} 17 | 18 | \item{xout}{x coordinate of point to interpolate} 19 | 20 | \item{yout}{y coordinate of point to interpolate} 21 | 22 | \item{zout}{z coordinate of points to interpolate} 23 | } 24 | \value{ 25 | single trilinear interpolated value 26 | } 27 | \description{ 28 | Trilinear interpolation on a rectilinear grid 29 | } 30 | \keyword{internal} 31 | -------------------------------------------------------------------------------- /man/rmfi_weighted_geomean.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_weighted_geomean} 4 | \alias{rmfi_weighted_geomean} 5 | \title{Calculate a weighted geometric mean} 6 | \usage{ 7 | rmfi_weighted_geomean(x, w, ...) 8 | } 9 | \arguments{ 10 | \item{x}{An R object.} 11 | 12 | \item{...}{further arguments passed to \code{\link{prod}}} 13 | } 14 | \description{ 15 | Calculate a weighted geometric mean 16 | } 17 | \seealso{ 18 | \code{\link{rmfi_weighted_harmean}}, \code{\link{weighted.mean}}, \code{\link{rmfi_geomean}}, \code{\link{rmfi_harmean}} and \code{\link{mean}} 19 | } 20 | \keyword{internal} 21 | -------------------------------------------------------------------------------- /man/rmfi_weighted_harmean.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_weighted_harmean} 4 | \alias{rmfi_weighted_harmean} 5 | \title{Calculate a weighted harmonic mean} 6 | \usage{ 7 | rmfi_weighted_harmean(x, w, ...) 8 | } 9 | \arguments{ 10 | \item{x}{An invertable R object.} 11 | 12 | \item{...}{further arguments passed to \code{\link{sum}}} 13 | } 14 | \description{ 15 | Calculate a weighted harmonic mean 16 | } 17 | \seealso{ 18 | \code{\link{rmfi_weighted_geomean}}, \code{\link{weighted.mean}}, \code{\link{rmfi_harmean}} \code{\link{rmfi_geomean}} and \code{\link{mean}} 19 | } 20 | \keyword{internal} 21 | -------------------------------------------------------------------------------- /man/rmfi_write_array.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_write_array} 4 | \alias{rmfi_write_array} 5 | \title{Write modflow array 6 | Internal function used in the write_* functions for writing array datasets} 7 | \usage{ 8 | rmfi_write_array( 9 | array, 10 | file, 11 | cnstnt = 1, 12 | iprn = -1, 13 | append = TRUE, 14 | external = NULL, 15 | fname = NULL, 16 | binary = NULL, 17 | precision = "single", 18 | nam = NULL, 19 | xsection = FALSE, 20 | ... 21 | ) 22 | } 23 | \arguments{ 24 | \item{external}{character vector with names corresponding to the dataset; used to write external arrays} 25 | 26 | \item{fname}{character vector with names corresponding to the dataset; used to write open/close arrays} 27 | 28 | \item{binary}{character vector with names corresponding to the dataset; used to write external or open/close arrays} 29 | 30 | \item{precision}{character: either \code{'single'} (default) or \code{'double'}. Denotes the precision of binary files} 31 | 32 | \item{nam}{\code{\link{RMODFLOW}} nam object; used when writing external arrays} 33 | 34 | \item{xsection}{logical; does the array represent a NLAY x NCOL cross-section. Passed to \code{rmf_write_array}} 35 | 36 | \item{...}{ignored} 37 | } 38 | \description{ 39 | Write modflow array 40 | Internal function used in the write_* functions for writing array datasets 41 | } 42 | \details{ 43 | if the array should be written as integers, an integer array should be provided 44 | } 45 | -------------------------------------------------------------------------------- /man/rmfi_write_array_parameters.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_write_array_parameters} 4 | \alias{rmfi_write_array_parameters} 5 | \title{Write MODFLOW array parameters for boundary-condition packages} 6 | \usage{ 7 | rmfi_write_array_parameters(obj, arrays, file, partyp, ...) 8 | } 9 | \arguments{ 10 | \item{obj}{\code{RMODFLOW} object to write} 11 | 12 | \item{arrays}{list of arrays to write} 13 | 14 | \item{file}{filename to write to} 15 | 16 | \item{...}{additional arguments passed to \code{rmfi_write_array}} 17 | 18 | \item{type}{character; type of array parameter. Allowed values are \code{'bc'} for boundary-condition arrays and \code{'flow'} for flow package arrays} 19 | } 20 | \description{ 21 | Write MODFLOW array parameters for boundary-condition packages 22 | } 23 | \seealso{ 24 | \code{\link{rmfi_parse_array_parameters}} 25 | } 26 | \keyword{internal} 27 | -------------------------------------------------------------------------------- /man/rmfi_write_bc_list.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_write_bc_list} 4 | \alias{rmfi_write_bc_list} 5 | \title{Write a MODFLOW boundary condition package which uses list-directed input to a file} 6 | \usage{ 7 | rmfi_write_bc_list(file, obj, dis, varnames, header, package, partyp, ...) 8 | } 9 | \arguments{ 10 | \item{file}{filename to write to} 11 | 12 | \item{obj}{an \code{RMODFLOW} boundary condition rmf_package object with list directed input} 13 | 14 | \item{dis}{an \code{RMODFLOW} dis object} 15 | 16 | \item{varnames}{character vector with the names of the variables starting from the 4th column (so after ijk)} 17 | 18 | \item{header}{character; package name. Part of the header comment written to the output file} 19 | 20 | \item{package}{character; acronym (often 3 letters) used by MODFLOW to name to package} 21 | 22 | \item{partyp}{character; specifies the parameter type} 23 | 24 | \item{...}{arguments passed to \code{rmfi_write_variables} and \code{rmfi_write_list} when writing a fixed format file.} 25 | } 26 | \value{ 27 | \code{NULL} 28 | } 29 | \description{ 30 | Write a MODFLOW boundary condition package which uses list-directed input to a file 31 | } 32 | \seealso{ 33 | \code{\link{rmfi_create_bc_list}}, \code{\link{rmfi_parse_bc_list}} 34 | } 35 | \keyword{internal} 36 | -------------------------------------------------------------------------------- /man/rmfi_write_list.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_write_list} 4 | \alias{rmfi_write_list} 5 | \title{Write a RMODFLOW list} 6 | \usage{ 7 | rmfi_write_list( 8 | df, 9 | file, 10 | varnames, 11 | aux = NULL, 12 | format = "free", 13 | append = TRUE, 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{df}{\code{RMODFLOW} list} 19 | 20 | \item{file}{filename to write to} 21 | 22 | \item{varnames}{character vector with the names of the variables starting from the 4th column (so after ijk) including optional auxiliary variables} 23 | 24 | \item{aux}{character vector with the names of the auxiliary variables defined in \code{varnames}} 25 | 26 | \item{format}{either \code{"free"} (default) or \code{"fixed"}} 27 | 28 | \item{append}{logical} 29 | 30 | \item{...}{ignored} 31 | } 32 | \value{ 33 | \code{NULL} 34 | } 35 | \description{ 36 | Write a RMODFLOW list 37 | } 38 | \keyword{internal} 39 | -------------------------------------------------------------------------------- /man/rmfi_write_prj.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/spatial.R 3 | \name{rmfi_write_prj} 4 | \alias{rmfi_write_prj} 5 | \title{Write prj object information to file header} 6 | \usage{ 7 | rmfi_write_prj(dis, prj, file) 8 | } 9 | \arguments{ 10 | \item{dis}{\code{RMODFLOW} dis object} 11 | 12 | \item{prj}{\code{RMODFLOW} prj object} 13 | 14 | \item{file}{character with path of file to write to. Typically the discretization file.} 15 | } 16 | \value{ 17 | \code{NULL} 18 | } 19 | \description{ 20 | Write prj object information to file header 21 | } 22 | \details{ 23 | Writes RMODFLOW projection information into the header of a file, typically the discretization file. All lines start with "#". 24 | This information consists of a starter line, the coordinates of the 4 model corners, the grid rotation angle in degrees counterclockwise, 25 | the z coordinate of the lower left corner and the crs description. This might be a EPSG code, a proj4string, or a wkt string. 26 | A ending line specifies the end of the RMODFLOW projection information. 27 | } 28 | \keyword{internal} 29 | -------------------------------------------------------------------------------- /man/rmfi_write_variables.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/internals.R 3 | \name{rmfi_write_variables} 4 | \alias{rmfi_write_variables} 5 | \title{Write MODFLOW variables 6 | Internal function used in the rmf_write_* functions for writing single line datasets} 7 | \usage{ 8 | rmfi_write_variables( 9 | ..., 10 | file, 11 | append = TRUE, 12 | width = 10, 13 | format = "free", 14 | integer = FALSE, 15 | iprn = -1 16 | ) 17 | } 18 | \arguments{ 19 | \item{width}{numeric vector with the character widths for each variable. If a single value, it is repeated.} 20 | 21 | \item{format}{either \code{'fixed'} or \code{'free'}. Fixed format assumes fixed width character spaces for each value as determined by the width argument} 22 | 23 | \item{integer}{logical; should all values be converted to integers? MODFLOW does not allow for exponents in integer values} 24 | 25 | \item{iprn}{ignored} 26 | } 27 | \description{ 28 | Write MODFLOW variables 29 | Internal function used in the rmf_write_* functions for writing single line datasets 30 | } 31 | \keyword{internal} 32 | -------------------------------------------------------------------------------- /vignettes/top_level.R: -------------------------------------------------------------------------------- 1 | ## ----setup, echo=FALSE-------------------------------------------------------- 2 | options(rmarkdown.html_vignette.check_title = FALSE) 3 | knitr::opts_chunk$set(echo = TRUE, collapse = TRUE, comment = "#>") 4 | library(RMODFLOW) 5 | 6 | ## ----------------------------------------------------------------------------- 7 | rma <- rmf_example_file("rocky-mountain-arsenal.nam") %>% 8 | rmf_read() 9 | 10 | ## ----------------------------------------------------------------------------- 11 | modflow <- rmf_create(rma$dis, rma$bas, rma$lpf, rma$oc, rma$pcg, rma$wel, rma$chd, cbc = 88) 12 | str(modflow) 13 | 14 | ## ---- eval = FALSE------------------------------------------------------------ 15 | # rmf_write(modflow, file = "input.nam", verbose = FALSE) 16 | 17 | ## ---- eval = FALSE------------------------------------------------------------ 18 | # rmf_write(modflow, file = "input.nam", verbose = FALSE, exclude = c("wel", "chd")) 19 | 20 | --------------------------------------------------------------------------------