Skip to content
OFFICIAL SS DOCUMENTATION

SS.SoilMechanics 1.2.0

Validated borehole profiles, staged layered settlement, 2D seepage networks, safety-factor envelopes, soil phases, strength, earth pressure and bearing fundamentals
API 1.2.0
MIT
source

Language compatibility: >=1.0.0 <2.0.0
Runtime compatibility: >=1.0.0 <2.0.0

No package dependencies declared.

Public API

Public signature
export function activeEarthPressure(double height, double unitWeight, double frictionAngle, double surcharge)->EarthPressure

Parameters: height: double, unitWeight: double, frictionAngle: double, surcharge: double


Public signature
export record BearingCapacity(public double ultimate, public double netUltimate, public double factorOfSafety, public string diagnostic)

Parameters: ultimate: double, netUltimate: double, factorOfSafety: double, diagnostic: string


Public signature
export function consolidationDegree(double timeFactor)->double

Parameters: timeFactor: double


Public signature
export record ConsolidationFit(public double coefficientOfConsolidation, public double time50, public double drainagePath, public string method)

Parameters: coefficientOfConsolidation: double, time50: double, drainagePath: double, method: string


Public signature
export record ConsolidationState(public double degree, public double settlement, public double timeFactor, public bool valid)

Parameters: degree: double, settlement: double, timeFactor: double, valid: bool


Public signature
export function darcyDischarge(double hydraulicConductivity, double area, double headLoss, double lengthValue)->double

Parameters: hydraulicConductivity: double, area: double, headLoss: double, lengthValue: double


Public signature
export record EarthPressure(public double coefficient, public double resultant, public double applicationHeight)

Parameters: coefficient: double, resultant: double, applicationHeight: double


Public signature
export function effectiveVerticalStress(double depth, double totalUnitWeight, double waterTableDepth, double waterUnitWeight)->StressState

Parameters: depth: double, totalUnitWeight: double, waterTableDepth: double, waterUnitWeight: double


Public signature
export function fitConsolidationCoefficient(double time50, double drainagePath)->ConsolidationFit

Parameters: time50: double, drainagePath: double


Public signature
export function intrinsicPermeability(double hydraulicConductivity, double dynamicViscosity, double fluidDensity, double gravity)->double

Parameters: hydraulicConductivity: double, dynamicViscosity: double, fluidDensity: double, gravity: double


Public signature
export function layeredConsolidation(SoilLayer[] layers, double waterTableDepth, double waterUnitWeight, double appliedStressIncrease, double time, bool doubleDrainage)->LayeredSettlement

Parameters: layers: SoilLayer[], waterTableDepth: double, waterUnitWeight: double, appliedStressIncrease: double, time: double, doubleDrainage: bool


Public signature
export function layeredSeepage(SoilLayer[] layers, double headLoss)->LayeredSeepage

Parameters: layers: SoilLayer[], headLoss: double


Public signature
export record LayeredSeepage(public double equivalentConductivity, public double dischargePerArea, public double[] headDrops, public double totalHeadLoss, public double continuityResidual, public string provenance)

Parameters: equivalentConductivity: double, dischargePerArea: double, headDrops: double[], totalHeadLoss: double, continuityResidual: double, provenance: string


Public signature
export record LayeredSettlement(public double[] initialEffectiveStress, public double[] finalEffectiveStress, public double[] ultimateByLayer, public double[] degreeByLayer, public double[] settlementByLayer, public double ultimateSettlement, public double settlement, public double time, public bool compatible, public string provenance)

Parameters: initialEffectiveStress: double[], finalEffectiveStress: double[], ultimateByLayer: double[], degreeByLayer: double[], settlementByLayer: double[], ultimateSettlement: double, settlement: double, time: double, compatible: bool, provenance: string


Public signature
export function mohrCoulombStrength(double effectiveNormalStress, double cohesion, double frictionAngle)->double

Parameters: effectiveNormalStress: double, cohesion: double, frictionAngle: double


Public signature
export function oneDimensionalConsolidation(double compressionIndex, double initialVoidRatio, double initialEffectiveStress, double finalEffectiveStress, double layerThickness, double time, double coefficientOfConsolidation, double drainagePath)->ConsolidationState

Parameters: compressionIndex: double, initialVoidRatio: double, initialEffectiveStress: double, finalEffectiveStress: double, layerThickness: double, time: double, coefficientOfConsolidation: double, drainagePath: double


Public signature
export function phaseRelations(double solidVolume, double waterVolume, double airVolume, double solidDensity, double waterDensity)->PhaseRelations

Parameters: solidVolume: double, waterVolume: double, airVolume: double, solidDensity: double, waterDensity: double


Public signature
export record PhaseRelations(public double voidRatio, public double porosity, public double degreeSaturation, public double dryDensity, public double bulkDensity)

Parameters: voidRatio: double, porosity: double, degreeSaturation: double, dryDensity: double, bulkDensity: double


Public signature
export function rankineActiveCoefficient(double frictionAngle)->double

Parameters: frictionAngle: double


Public signature
export function rankinePassiveCoefficient(double frictionAngle)->double

Parameters: frictionAngle: double


Public signature
export function seepageNetwork2D(int columns, int rows, double spacingX, double spacingY, double[] conductivity, bool[] fixedHead, double[] boundaryHeads, double tolerance, int maximumIterations)->SeepageNetwork2DResult

Parameters: columns: int, rows: int, spacingX: double, spacingY: double, conductivity: double[], fixedHead: bool[], boundaryHeads: double[], tolerance: double, maximumIterations: int


Public signature
export record SeepageNetwork2DResult(public double[] heads, public double[] flowX, public double[] flowY, public double boundaryInflow, public double boundaryOutflow, public double massBalanceResidual, public int iterations, public bool converged, public string diagnostic)

Parameters: heads: double[], flowX: double[], flowY: double[], boundaryInflow: double, boundaryOutflow: double, massBalanceResidual: double, iterations: int, converged: bool, diagnostic: string


Public signature
export function soilBoreholeProfile(SoilLayer[] layers, double groundwaterDepth, string provenance)->SoilBoreholeProfileResult

Parameters: layers: SoilLayer[], groundwaterDepth: double, provenance: string


Public signature
export record SoilBoreholeProfileResult(public SoilLayer[] layers, public double[] topDepths, public double[] bottomDepths, public double groundwaterDepth, public double totalDepth, public string provenance, public string diagnostic)

Parameters: layers: SoilLayer[], topDepths: double[], bottomDepths: double[], groundwaterDepth: double, totalDepth: double, provenance: string, diagnostic: string


Public signature
export function soilLayer(string name, double thickness, double dryUnitWeight, double saturatedUnitWeight, double hydraulicConductivity, double initialVoidRatio, double recompressionIndex, double compressionIndex, double preconsolidationStress, double coefficientOfConsolidation, string provenance)->SoilLayer

Parameters: name: string, thickness: double, dryUnitWeight: double, saturatedUnitWeight: double, hydraulicConductivity: double, initialVoidRatio: double, recompressionIndex: double, compressionIndex: double, preconsolidationStress: double, coefficientOfConsolidation: double, provenance: string


Public signature
export record SoilLayer(public string name, public double thickness, public double dryUnitWeight, public double saturatedUnitWeight, public double hydraulicConductivity, public double initialVoidRatio, public double recompressionIndex, public double compressionIndex, public double preconsolidationStress, public double coefficientOfConsolidation, public string provenance)

Parameters: name: string, thickness: double, dryUnitWeight: double, saturatedUnitWeight: double, hydraulicConductivity: double, initialVoidRatio: double, recompressionIndex: double, compressionIndex: double, preconsolidationStress: double, coefficientOfConsolidation: double, provenance: string


Public signature
export function soilSafetyFactorEnvelope(string[] identities, double[] resistances, double[] demands, double minimumAcceptable, string assumptions, string provenance)->SoilSafetyFactorEnvelopeResult

Parameters: identities: string[], resistances: double[], demands: double[], minimumAcceptable: double, assumptions: string, provenance: string


Public signature
export record SoilSafetyFactorEnvelopeResult(public double[] factors, public int governingIndex, public double minimumFactor, public string[] identities, public string assumptions, public string provenance, public bool acceptable, public string diagnostic)

Parameters: factors: double[], governingIndex: int, minimumFactor: double, identities: string[], assumptions: string, provenance: string, acceptable: bool, diagnostic: string


Public signature
export function stagedLayeredSettlement(SoilBoreholeProfileResult profile, double waterUnitWeight, double[] stageTimes, double[] loadIncrements, double evaluationTime, bool doubleDrainage)->StagedLayeredSettlementResult

Parameters: profile: SoilBoreholeProfileResult, waterUnitWeight: double, stageTimes: double[], loadIncrements: double[], evaluationTime: double, doubleDrainage: bool


Public signature
export record StagedLayeredSettlementResult(public double[] stageTimes, public double[] cumulativeLoads, public double[] ultimateContributions, public double[] settlementContributions, public double ultimateSettlement, public double settlement, public double evaluationTime, public string diagnostic)

Parameters: stageTimes: double[], cumulativeLoads: double[], ultimateContributions: double[], settlementContributions: double[], ultimateSettlement: double, settlement: double, evaluationTime: double, diagnostic: string


Public signature
export record StressState(public double totalStress, public double porePressure, public double effectiveStress)

Parameters: totalStress: double, porePressure: double, effectiveStress: double


Public signature
export function stripBearingCapacity(double cohesion, double surcharge, double unitWeight, double width, double frictionAngle, double appliedPressure)->BearingCapacity

Parameters: cohesion: double, surcharge: double, unitWeight: double, width: double, frictionAngle: double, appliedPressure: double


Documentation version

Language 1.0.0, compiler 1.0.0, runtime 1.0.0. This reference is generated from the official SS documentation so package and language details stay consistent with the release.