% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/getSiteProperties.R
\name{getSiteProperties}
\alias{getSiteProperties}
\title{Monte Carlo site properties from synthetic soil profiles}
\usage{
getSiteProperties(
  Hs,
  USCS,
  POP = 100,
  Water = 0,
  NR = 1,
  h = 1,
  levels = c(0.05, 0.5, "mean", 0.95),
  Vref = 760
)
}
\arguments{
\item{Hs}{Numeric vector. Total height(s) to hard ground (m).}

\item{USCS}{Character vector. USCS soil classification codes
(e.g. \code{c("GC", "CL", "ML")}).}

\item{POP}{Numeric. Pre-consolidation pressure (kPa). Default 100.}

\item{Water}{Numeric. Water-table depth as fraction of \code{Hs}.
Default 0 (no water).}

\item{NR}{Integer. Number of Monte Carlo realisations. Default 1.}

\item{h}{Numeric. Layer thickness (m) in the discretisation.
Default 1.00.}

\item{levels}{Vector. Quantile levels to report; entries can be
numeric in (0, 1) and/or the literal \code{"mean"}.
Default \code{c(0.05, 0.5, "mean", 0.95)}.}

\item{Vref}{Numeric. Reference shear-wave velocity (m/s) for
site-class assignment. Default 760.}
}
\value{
data.table with one row per (Hs, POP, Hw, level)
combination and columns USCS, Go, mo, Ts, VSo, VS30, Z500,
Z1000, level. Numeric properties are rounded for readability.
}
\description{
Generates \code{NR} realisations of synthetic soil profiles for a given
total height \code{Hs} and USCS classification, then summarises the
resulting Ts, mo, Go, VSo and VS30 by user-requested quantile
levels (and/or the mean). Each realisation is built by
\code{geSiteTable()}.
}
\examples{
\donttest{
getSiteProperties(
  Hs   = 30,
  USCS = c("GC", "CL", "ML"),
  NR   = 50,
  levels = c(0.16, "mean", 0.84)
)
}
}
