R/anem_data.R

In gopalpenny/anem: Analytical element models for simple aquifers

# anem_data.R

#' Aquifer confined example
#'
#' @format aquifer object set as \code{aquifer_type="confined"}
"aquifer_confined_example"

#' Aquifer unconfined example
#'
#' @format aquifer object set as \code{aquifer_type="unconfined"}
"aquifer_unconfined_example"

#' Wells example
#'
#' @format wells \code{data.frame} object (needs to be supplyed to \code{define_wells})
"wells_example"

#' Groundwater district anem-app scenario
#'
#' anem-app scenario with four pumping wells near a river
#'
#' @format a list object containing named items associated with anem-app
#' @keywords internal
"groundwater_district"

#' Municipal contamination anem-app scenario
#'
#' anem-app scenario with urban contamination at a well
#'
#' @format a list object containing named items associated with anem-app
#' @keywords internal
"municipal_contamination"

#' Bounds example
#'
#' @format bounds \code{data.frame} object (needs to be supplyed to \code{define_bounds})
#' @keywords internal
"bounds_example"

#' anem-app scenario
#'
#' @format a list object containing named items associated with anem-app
#' @keywords internal
"anem_app_scenario"