Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
abarbour committed Apr 5, 2021
1 parent b5c58b3 commit 72d0787
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 0 deletions.
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ export(mogi.pressure)
export(mogi.volume)
export(poroelastic_stress_coefficient)
export(r96_drainage_pressure)
export(rc76_edge_disloc_poro)
export(rigid_hydraulic_diffusivity)
export(rudnicki86)
export(segall85)
Expand Down
20 changes: 20 additions & 0 deletions R/ricecleary76.R
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
#' Rice and Cleary solutions
#'
#' @details \code{\link{rc76_edge_disloc_poro}} is the 2D solution
#' to an edge dislocation (e.g., fault) embedded in a poroelastic medium
#'
#' @param Times numeric; times to calculate at \code{depth} [s]
#' @param slip numeric; relative slip along the edge dislocation [m]
#' @param radial_dist numeric; distance from xxx to xxx [m]
#' @param angFromEast
#' @param diffusiv
#' @param nuu
#' @param nu
#' @param B
#' @param mu
#' @param ...
#'
#' @return
#' @export
#'
#' @examples
rc76_edge_disloc_poro <- function(Times, slip, radial_dist, angFromEast=30,
diffusiv=1,
nuu=0.33, nu=0.25, B = 0.6,
Expand Down
50 changes: 50 additions & 0 deletions man/rc76_edge_disloc_poro.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 72d0787

Please sign in to comment.