% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/geSiteTable.R
\name{geSiteTable}
\alias{geSiteTable}
\title{Single-realisation synthetic soil profile and site properties}
\usage{
geSiteTable(
  Hs,
  Water = 0,
  USCS,
  Group = NULL,
  h = 0.5,
  DrID = NULL,
  Vref = 760,
  UniformDistribution = TRUE,
  POP = 100,
  IgnoreModelIntervals = TRUE,
  getSiteLayers = FALSE
)
}
\arguments{
\item{Hs}{Numeric scalar. Total height to hard ground (m).}

\item{Water}{Numeric scalar. Water-table depth as fraction of
\code{Hs}: \code{zw = Hs - Water * Hs}.}

\item{USCS}{Character vector. Unified Soil Classification System
codes (e.g. \code{c("GC", "CL", "ML")}).}

\item{Group}{Character vector or \code{NULL}. Soil groups,
\code{c("Gravels","Fines","Sands")}; if \code{NULL}, derived from
\code{USCS}.}

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

\item{DrID}{Character or \code{NULL}. Relative-density label,
\code{c("Very Dense","Dense","Compact","Loose","Very Loose")};
\code{NULL} samples relative density from the standard prior.}

\item{Vref}{Numeric. Reference shear-wave velocity (m/s) for the
site-class assignment. Default 760.}

\item{UniformDistribution}{Logical. If \code{TRUE} (default),
sample soil properties from uniform distributions; if
\code{FALSE}, use normal distributions.}

\item{POP}{Numeric. Pre-consolidation pressure (kPa); enters the
over-consolidation ratio \code{OCR = (pm + POP) / pm}.
Default 100.}

\item{IgnoreModelIntervals}{Logical. If \code{TRUE} (default),
ignore model-specific layer-thickness intervals and use \code{h}
as the discretisation step.}

\item{getSiteLayers}{Logical. If \code{TRUE}, return the per-layer
detail in addition to the per-site summary.}
}
\value{
data.table with one row per (Hs, POP, Hw, sample)
combination and columns Hs, Hw, NL, Z500, Z1000, SID, Go, mo,
Ts, VSo, VS30, plus USCS-fraction columns.
}
\description{
Builds one Monte Carlo realisation of a layered soil column from a
total height \code{Hs} and a USCS classification, samples random
geotechnical properties (void ratio, unit weight, plasticity,
shear modulus parameters), computes the fundamental period
\code{Ts} via Rayleigh's method (\code{fitModel.Ts}) and the
Vs30-equivalent shear-wave velocity. \code{getSiteProperties}
calls this function repeatedly to assemble the Monte Carlo
ensemble; call directly when one realisation suffices.
}
