Function reference • RMODFLOW

Model-level functionality Work with complete models
`rmf_read`	Read a MODFLOW model
`rmf_write()`	Write a MODFLOW model
`rmf_create()`	Create an `RMODFLOW` modflow object
Execute, analyze and optimize models Run MODFLOW, perform sensitivity analysis and local optimization
`rmf_execute()`	Execute a MODFLOW model
`rmf_analyze()`	Analyze a MODFLOW model
`rmf_optimize()`	Optimize a MODFLOW model
`rmf_performance()`	Generic function to get model performance measures
Install the MODFLOW-2005 family of codes Download the MODFLOW codes and put them in a known location
`rmf_install()` `rmf_installed_codes()`	Install external codes
Work with a coordinate reference system
`rmf_get_prj()` `rmf_has_prj()` `rmf_set_prj()` `rmf_transform_prj()`	Functions to get, set, transform and check presence of prj objects
`rmf_create_prj()`	Create a RMODFLOW projection object
`rmf_read_usgs_model_reference`	Read RMODFLOW projection information from a USGS model reference file
Work with example models
`rmf_example()`	Access example MODFLOW files
`rmf_example_file()`	Path to example file
`rmf_example_files()`	Path to example files
`rmf_example_model()`	List example model files
`rmf_example_models()`	List example models
Read MODFLOW files Functions to read MODFLOW files and return RMODFLOW objects
`rmf_read_array()`	Read a MODFLOW array from a separate file.
`rmf_read_bas`	Read a MODFLOW basic file
`rmf_read_bcf`	Read a MODFLOW bcf file
`rmf_read_bud`	Reads the volumetric budget from a MODFLOW listing file
`rmf_read_cbc`	Read a MODFLOW cell-by-cell budget file
`rmf_read_chd()`	Read a MODFLOW time-variant specified-head file
`rmf_read_ddn`	Read a MODFLOW drawdown file
`rmf_read_de4`	Read a MODFLOW direct solver file
`rmf_read_dis`	Read a MODFLOW discretization file
`rmf_read_drn`	Read a MODFLOW drain file
`rmf_read_evt`	Read a MODFLOW evapotranspiration file
`rmf_read_ghb`	Read a MODFLOW general-head boundary file
`rmf_read_gmg`	Read a MODFLOW Geometric Multigrid Solver file
`rmf_read_hed`	Read a MODFLOW head file
`rmf_read_hfb()`	Read a MODFLOW horizontal flow barrier file
`rmf_read_hob`	Read a MODFLOW head observations file
`rmf_read_hpr`	Read a MODFLOW head predictions file
`rmf_read_huf`	Read a MODFLOW hydrogeologic unit flow file
`rmf_read_kdep`	Read a MODFLOW hydraulic conductivity depth-dependence capability file
`rmf_read_lmt`	Read a MODFLOW Link-MT3DMS Package file
`rmf_read_lpf`	Read a MODFLOW layer-property flow file
`rmf_read_lvda()`	Read a MODFLOW model-layer variable-direction horizontal anisotropy capability file
`rmf_read_mlt`	Read a MODFLOW multiplier file
`rmf_read_nam`	Read a MODFLOW name file
`rmf_read_nwt`	Read a MODFLOW Newton solver package file
`rmf_read_oc`	Read a MODFLOW output control option file
`rmf_read_pcg`	Read a MODFLOW preconditioned conjugate-gradient package file
`rmf_read_pval()`	Read a MODFLOW parameter value file
`rmf_read_rch`	Read a MODFLOW recharge file
`rmf_read_riv`	Read a MODFLOW river file
`rmf_read_sip()`	Read a MODFLOW strongly implicit procedure file
`rmf_read_upw`	Read a MODFLOW-NWT Upstream Weighting file
`rmf_read_usgs_model_reference`	Read RMODFLOW projection information from a USGS model reference file
`rmf_read_wel`	Read a MODFLOW well file
`rmf_read_zon`	Read a MODFLOW zone file
Write MODFLOW files Functions to write RMODFLOW objects as MODFLOW files
`rmf_write_array()`	Write a MODFLOW array to a separate file.
`rmf_write_bas()`	Write a MODFLOW basic file
`rmf_write_bcf()`	Write a MODFLOW block-centered flow file
`rmf_write_chd()`	Write a MODFLOW time-variant specified-head file
`rmf_write_de4()`	Write a MODFLOW direct solver package
`rmf_write_dis()`	Write a MODFLOW discretization file
`rmf_write_drn()`	Write a MODFLOW drain file
`rmf_write_evt()`	Write a MODFLOW evapotranspiration file
`rmf_write_ghb()`	Write a MODFLOW general-head boundary file
`rmf_write_gmg()`	Write a MODFLOW Geometric Multigrid Solver file
`rmf_write_hfb()`	Write a MODFLOW horizontal flow barrier file
`rmf_write_hob()`	Write a MODFLOW head observations file
`rmf_write_huf()`	Write a MODFLOW hydrogeologic unit flow file
`rmf_write_kdep()`	Write a MODFLOW hydraulic conductivity depth-dependence capability file
`rmf_write_lmt()`	Write a MODFLOW Link-MT3DMS Package file
`rmf_write_lpf()`	Write a MODFLOW layer-property flow file
`rmf_write_lvda()`	Write a MODFLOW model-layer variable-direction horizontal anisotropy capability file
`rmf_write_mlt()`	Write a MODFLOW multiplier file
`rmf_write_nam()`	Write a MODFLOW name file
`rmf_write_nwt()`	Write a MODFLOW Newton solver package file
`rmf_write_oc()`	Write a MODFLOW output control option file
`rmf_write_pcg()`	Write a MODFLOW preconditioned conjugate-gradient package file
`rmf_write_pval()`	Write a MODFLOW parameter value file
`rmf_write_rch()`	Write a MODFLOW recharge file
`rmf_write_riv()`	Write a MODFLOW river file
`rmf_write_sip()`	Write a MODFLOW strongly implicit procedure package
`rmf_write_upw()`	Write a MODFLOW-NWT upstream weighting file
`rmf_write_vtk()`	Write RMODFLOW objects to VTK files
`rmf_write_wel()`	Write a MODFLOW well file
`rmf_write_zon()`	Write a MODFLOW zone file
Create RMODFLOW objects Functions to create RMODFLOW objects
`rmf_create_array()`	Add rmf array class to object based on object dimensions
`rmf_create_bas()`	Create an `RMODFLOW` bas object
`rmf_create_bcf()`	Create an `RMODFLOW` bcf object
`rmf_create_chd()`	Create an `RMODFLOW` chd object.
`rmf_create_de4()`	Create an `RMODFLOW` de4 object.
`rmf_create_dis()`	Create an `RMODFLOW` dis object
`rmf_create_drn()`	Create an `RMODFLOW` drn object.
`rmf_create_evt()`	Create an `RMODFLOW` evt object.
`rmf_create_ghb()`	Create an `RMODFLOW` ghb object.
`rmf_create_gmg()`	Create an `RMODFLOW` gmg object
`rmf_create_hfb()`	Create an `RMODFLOW` hfb object.
`rmf_create_hob()`	Create an `RMODFLOW` hob object
`rmf_create_huf()`	Create an `RMODFLOW` huf object
`rmf_create_kdep()`	Create an `RMODFLOW` kdep object
`rmf_create_list()`	Add rmf list class to data.frame and check if k, i and j columns are present
`rmf_create_lmt()`	Create a `RMODFLOW` lmt object
`rmf_create_lpf()`	Create an `RMODFLOW` lpf object
`rmf_create_lvda()`	Create an `RMODFLOW` lvda object
`rmf_create_mlt()`	Create an `RMODFLOW` mlt object
`rmf_create_nam()`	Create an `RMODFLOW` nam object
`rmf_create_nwt()`	Create an `RMODFLOW` nwt object
`rmf_create_oc()`	Create an `RMODFLOW` oc object
`rmf_create_parameter(<default>)`	Create an array parameter
`rmf_create_parameter()`	Create a MODFLOW parameter
`rmf_create_parameter(<rmf_2d_array>)`	Concise function for creating a 2D-array parameter.
`rmf_create_parameter(<rmf_3d_array>)`	Concise function for creating a 3D-array parameter.
`rmf_create_parameter(<rmf_list>)`	Create a List Data input parameter
`rmf_create_pcg()`	Create an `RMODFLOW` pcg object
`rmf_create_prj()`	Create a RMODFLOW projection object
`rmf_create_pval()`	Create an `RMODFLOW` pval object
`rmf_create_rch()`	Create an `RMODFLOW` rch object.
`rmf_create_riv()`	Create an `RMODFLOW` riv object.
`rmf_create_sip()`	Create an `RMODFLOW` sip object.
`rmf_create_upw()`	Create an `RMODFLOW` upw object
`rmf_create_wel()`	Create an `RMODFLOW` wel object.
`rmf_create_zon()`	Create an `RMODFLOW` zon object
Convert RMODFLOW objects Convert between object types, coordinates, …
`rmf_convert_bcf_to_lpf()`	Convert a bcf to a lpf object
`rmf_convert_cbc_to_darcy()`	Convert cbc object fluxes to darcy velocities
`rmf_convert_dis_to_saturated_dis()`	Convert a dis object to correspond to the saturated volume
`rmf_convert_grid_to_xyz()`	Convert modflow coordinates to real world coordinates
`rmf_convert_hed_to_water_table()`	Obtain the water table elevation from a hydraulic head array
`rmf_convert_hob_to_locations()`	Convert a hob object to a locations data frame
`rmf_convert_hob_to_time_series()`	Convert a hob object to a time series data frame
`rmf_convert_huf_to_dis()`	Convert a huf to a dis object (for plotting)
`rmf_convert_huf_to_grid()`	Convert a parameter defined on the HUF grid to the numerical grid
`rmf_convert_huf_to_lpf()`	Convert a huf to a lpf object
`rmf_convert_huf_to_mask()`	Convert a huf to a mask object
`rmf_convert_ibound_to_neighbours()`	Convert an `ibound` array to lower, upper, left, right, front and back logical arrays indicating presence of a neighbouring active cell
`rmf_convert_id_to_id()`	Convert id to id
`rmf_convert_id_to_ijk()`	Convert id to ijk
`rmf_convert_ijk_to_id()`	Convert ijk to id
`rmf_convert_lpf_to_upw()`	Convert a lpf to a upw object
`rmf_convert_upw_to_lpf()`	Convert a upw to a lpf object
`rmf_convert_xyz_to_grid()`	Convert real world coordinates to modflow coordinates
`rmf_as_array(<Raster>)`	Convert a raster object to rmf_array
`rmf_as_array()`	Convert an object to a RMODFLOW array
`rmf_as_array(<sf>)`	Convert a simple features object to a rmf_array (rasterize)
`rmf_as_array(<stars>)`	Convert a stars object to rmf_array
`rmf_as_list()`	Convert objects to a rmf_list
`rmf_as_list(<sf>)`	Convert a simple features object to rmf_list
`rmf_as_list(<stars>)`	Convert a stars object to rmf_list
`rmf_as_raster()`	Functions to convert rmf_array and rmf_list objects to raster objects
`rmf_as_sf()`	Functions to convert rmf_array and rmf_list objects to simple features
`rmf_as_stars()`	Functions to convert rmf_array and rmf_list objects to stars objects
`rmf_as_tibble()`	Generic function to convert RMODFLOW objects to tibbles
Other
`rmf_guide()`	Launch the online guide pages
`rmf_gradient()`	Calculate a gradient field
`rmf_interpolate()`	Interpolation of points on a rmf_2d/3d/4d_array
`rmf_plot(<bud>)`	Plot a MODFLOW volumetric budget
`rmf_plot(<cbc>)`	Plot a flux component of a cell-by-cell budget object
`rmf_plot(<chd>)`	Plot a RMODFLOW chd object
`rmf_plot(<ddn>)`	Plot a MODFLOW drawdown file object
`rmf_plot(<drn>)`	Plot a RMODFLOW drn object
`rmf_plot(<evt>)`	Plot a RMODFLOW evt object
`rmf_plot(<ghb>)`	Plot a RMODFLOW ghb object
`rmf_plot(<hed>)`	Plot a MODFLOW head file object
`rmf_plot(<hfb>)`	Plot a RMODFLOW hfb object
`rmf_plot(<hob>)`	Plot a RMODFLOW hob object
`rmf_plot(<hpr>)`	Plot a MODFLOW head predictions file
`rmf_plot(<huf>)`	Plot a 2D section through a MODFLOW 3D array
`rmf_plot(<modflow>)`	Plot a 2D section through a MODFLOW model
`rmf_plot(<rch>)`	Plot a RMODFLOW rch object
`rmf_plot()`	Generic function for static 2D plotting
`rmf_plot(<riv>)`	Plot a RMODFLOW riv object
`rmf_plot(<rmf_2d_array>)`	Plot a MODFLOW 2D array
`rmf_plot(<rmf_3d_array>)`	Plot a 2D section through a MODFLOW 3D array
`rmf_plot(<rmf_4d_array>)`	Plot a 2D section through a MODFLOW 4D array
`rmf_plot(<rmf_analyze>)`	Plot a MODFLOW sensitivity analysis object
`rmf_plot(<rmf_list>)`	Plot a RMODFLOW list object
`rmf_plot(<wel>)`	Plot a RMODFLOW wel object
`rmf_saturated_thickness()`	Calculate saturated thicknesses
`rmf_time_steps()`	Calculate the internal time step sequence of a transient MODFLOW model
`rmf_copy_to_wd()`	Copy files from specified paths to current working directory
`rmf_browse()`	Browse the RMODFLOW pkgdown website
`rmf_cell_coordinates()` `rmf_get_cell_coordinates()`	Generic functions to get cell coordinates
`rmf_cell_dimensions()`	Generic function to get cell dimensions
`rmf_cell_info()`	Generic function to print information at a certain grid cell
`rmf_calculate_array()`	Calculate a `rmf_2d_array` or `rmf_3d_array` from multiplier arrays, zone arrays and/or parameter values
`rmf_calculate_thickness()`	Calculate layer thicknesses
`rmf_animate()`	Generic function to make animations from RMODFLOW arrays

Reference

Model-level functionality

Execute, analyze and optimize models

Install the MODFLOW-2005 family of codes

Work with a coordinate reference system

Work with example models

Read MODFLOW files

Write MODFLOW files

Create RMODFLOW objects

Convert RMODFLOW objects

Other