rmf_as_list.sf: Convert a simple features object to rmf_list

In rogiersbart/RMODFLOW: Pre- and post-processing of MODFLOW files

Convert a simple features object to rmf_list

Description

Convert a simple features object to rmf_list

Usage

## S3 method for class 'sf'
rmf_as_list(
  obj,
  dis,
  select = colnames(sf::st_set_geometry(obj, NULL)),
  prj = rmf_get_prj(dis),
  k = NULL,
  kper = attr(obj, "kper"),
  op = sf::st_intersects,
  ...
)

Arguments

obj	sf object
dis	RMODFLOW dis object
select	integer or character specifying columns from obj to select. Defaults to all columns
prj	RMODFLOW prj object
k	optional integer vector of length nrow(obj) specifying the layer index for each feature. If not present, all features are assumed to be in layer 1.
kper	optional integers specifying the stress-periods during which this rmf_list is active
op	geometric operator to use in the spatial join. Defaults to sf::st_intersects. See details.
...	additional arguments passed to sf::st_join

Details

A spatial join between the MODFLOW grid (as polygons) and obj is performed using sf::st_join(left = FALSE, op = op). The geometric operator op can be any kind described in the sf help pages. See ?sf::st_intersects.

Value

a RMODFLOW rmf_list object

Examples

dis <- rmf_create_dis()

# point
pts <- sf::st_sfc(list(sf::st_point(c(150, 312)), sf::st_point(c(500, 500)), sf::st_point(c(850, 566))))
obj <- sf::st_sf(q = c(-500, -400, -300), geom = pts)

(rlst <- rmf_as_list(obj, dis))

# 4 cells selected for second point on cell edges
rmf_plot(rlst, dis, k = 1, grid = TRUE) +
  ggplot2::geom_sf(data = obj, inherit.aes = FALSE)

prj <- rmf_create_prj(rotation = 12)
rmf_as_list(obj, dis, prj = prj, k = c(2, 2, 3))

# multipoint
mp <- sf::st_multipoint(rbind(c(150,312), c(500, 500), c(850, 566)))
obj <- sf::st_sf(q = -500, geom = sf::st_sfc(mp))

rmf_as_list(obj, dis)

# linestring
s1 <- rbind(c(150,312), c(500, 500), c(850, 566))
ls1 <- sf::st_linestring(s1)
s2 <- rbind(c(100,100), c(500, 555))
ls2 <- sf::st_linestring(s2)

obj <- sf::st_sf(conductance = 500, quality = c('good', 'poor'), geom = sf::st_sfc(ls1, ls2))

rmf_as_list(obj, dis, select = 'conductance')

# multilinestring
mls <- sf::st_multilinestring(list(s1, s2))

obj <- sf::st_sf(conductance = 500, quality = 'mixed', geom =   sf::st_sfc(mls))

rmf_as_list(obj, dis) %>% 
  rmf_plot(dis, k = 1, grid = TRUE) +
  ggplot2::geom_sf(data = obj, inherit.aes = FALSE)

# op = sf::st_crosses
rmf_as_list(obj, dis, op = sf::st_crosses) %>% 
  rmf_plot(dis, k = 1, grid = TRUE) +
  ggplot2::geom_sf(data = obj, inherit.aes = FALSE)

# polygon
p1 <- rbind(c(120, 120), c(120, 760), c(800, 800), c(120, 120))
pol1 <- sf::st_polygon(list(p1))

obj <- sf::st_sf(head = 15, geom = sf::st_sfc(pol1))

# op = sf::st_intersects
rmf_as_list(obj, dis) %>%
  rmf_plot(dis, k = 1, grid = TRUE) +
  ggplot2::geom_sf(data = obj, inherit.aes = FALSE, alpha = 0.4, fill = 'yellow')

# op = sf::st_covers
rmf_as_list(obj, dis, op = sf::st_covers) %>%
  rmf_plot(dis, k = 1, grid = TRUE) +
  ggplot2::geom_sf(data = obj, inherit.aes = FALSE, alpha = 0.4, fill = 'yellow')

p2 <- rbind(c(410, 125), c(812, 133), c(902, 488), c(410, 125))
pol2 <- sf::st_polygon(list(p1, p2))

(obj <- sf::st_sf(head = 15, geom = sf::st_sfc(pol2)))

rmf_as_list(obj, dis) %>%
  rmf_plot(dis, k = 1, grid = TRUE, variable = 'head', type = 'factor') +
  ggplot2::geom_sf(data = obj, inherit.aes = FALSE, alpha = 0.4, fill = 'yellow')

pol2 <- sf::st_polygon(list(p2))
(obj <- sf::st_sf(head = c(15, 12), geom = sf::st_sfc(pol1, pol2)))

rmf_as_list(obj, dis) %>%
  rmf_plot(dis, k = 1, grid = TRUE, variable = 'head', type = 'factor') +
  ggplot2::geom_sf(data = obj, inherit.aes = FALSE, alpha = 0.4, fill = 'yellow')

# multipolygon
p3 <- rbind(c(150, 960), c(440, 960), c(440, 875), c(150, 875), c(150, 960))
mpol <- sf::st_multipolygon(list(list(p1, p2), list(p3)))

(obj <- sf::st_sf(head = 15, geom = sf::st_sfc(mpol)))

rmf_as_list(obj, dis) %>%
  rmf_plot(dis, k = 1, grid = TRUE, variable = 'head', type = 'factor') +
  ggplot2::geom_sf(data = obj, inherit.aes = FALSE, alpha = 0.4, fill = 'yellow')

# geometry collection
gc <- sf::st_geometrycollection(list(mp, mpol, ls1))

(obj <- sf::st_sf(head = 15, geom = sf::st_sfc(gc)))

rogiersbart/RMODFLOW documentation built on Jan. 14, 2023, 4:21 a.m.