Skip to content
OFFICIAL SS DOCUMENTATION

SS.Hydrodynamics 1.2.0

Triangulated wetted-hull hydrostatics, deterministic spectral wave synthesis, RAO-integrated heave response, Morison load histories, section hydrostatics, wave kinematics and time-domain heave
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 addedMassForce(double addedMassCoefficient, double fluidDensity, double displacedVolume, double acceleration)->double

Parameters: addedMassCoefficient: double, fluidDensity: double, displacedVolume: double, acceleration: double


Public signature
export function buoyancy(double fluidDensity, double gravity, double displacedVolume)->double

Parameters: fluidDensity: double, gravity: double, displacedVolume: double


Public signature
export function deepWaterWavelength(double gravity, double period)->double

Parameters: gravity: double, period: double


Public signature
export function dispersionWaveNumber(double angularFrequency, double depth, double gravity, double tolerance, int maximumIterations)->double

Parameters: angularFrequency: double, depth: double, gravity: double, tolerance: double, maximumIterations: int


Public signature
export function floatingSubmergedFraction(double bodyDensity, double fluidDensity)->double

Parameters: bodyDensity: double, fluidDensity: double


Public signature
export function gaugePressure(double density, double gravity, double depth)->double

Parameters: density: double, gravity: double, depth: double


Public signature
export record HeaveHistory(public double[] times, public double[] displacements, public double[] velocities, public double[] accelerations, public double maximumAbsoluteDisplacement)

Parameters: times: double[], displacements: double[], velocities: double[], accelerations: double[], maximumAbsoluteDisplacement: double


Public signature
export function heaveResponseSpectrum(WaveSpectrum spectrum, double mass, double addedMass, double damping, double stiffness)->HeaveResponseSpectrumResult

Parameters: spectrum: WaveSpectrum, mass: double, addedMass: double, damping: double, stiffness: double


Public signature
export record HeaveResponseSpectrumResult(public double[] responseAmplitudeOperators, public ResponseStatistics statistics, public double mass, public double addedMass, public double damping, public double stiffness, public string diagnostic)

Parameters: responseAmplitudeOperators: double[], statistics: ResponseStatistics, mass: double, addedMass: double, damping: double, stiffness: double, diagnostic: string


Public signature
export record HullHydrostatics3D(public double displacedVolume, public double buoyancyForce, public double centerOfBuoyancyX, public double centerOfBuoyancyY, public double centerOfBuoyancyZ, public int submergedTriangles, public bool watertightAssumed, public string diagnostic)

Parameters: displacedVolume: double, buoyancyForce: double, centerOfBuoyancyX: double, centerOfBuoyancyY: double, centerOfBuoyancyZ: double, submergedTriangles: int, watertightAssumed: bool, diagnostic: string


Public signature
export function hydrostaticCurve(double[] drafts, SectionalBody[] bodies, double fluidDensity, double gravity, double centerOfGravityZ)->HydrostaticCurve

Parameters: drafts: double[], bodies: SectionalBody[], fluidDensity: double, gravity: double, centerOfGravityZ: double


Public signature
export record HydrostaticCurve(public double[] drafts, public HydrostaticState[] states)

Parameters: drafts: double[], states: HydrostaticState[]


Public signature
export record HydrostaticForce(public double force, public double centerOfPressureDepth)

Parameters: force: double, centerOfPressureDepth: double


Public signature
export record HydrostaticState(public double displacedVolume, public double displacementWeight, public double centerOfBuoyancyX, public double centerOfBuoyancyZ, public double waterplaneArea, public double centerOfFlotationX, public double transverseWaterplaneSecondMoment, public double metacentricHeight, public bool staticallyStable)

Parameters: displacedVolume: double, displacementWeight: double, centerOfBuoyancyX: double, centerOfBuoyancyZ: double, waterplaneArea: double, centerOfFlotationX: double, transverseWaterplaneSecondMoment: double, metacentricHeight: double, staticallyStable: bool


Public signature
export function integrateHullHydrostatics3D(double[] x, double[] y, double[] z, int[] triangles, double freeSurfaceZ, double fluidDensity, double gravity)->HullHydrostatics3D

Parameters: x: double[], y: double[], z: double[], triangles: int[], freeSurfaceZ: double, fluidDensity: double, gravity: double


Public signature
export function integrateHydrostatics(SectionalBody body, double fluidDensity, double gravity, double centerOfGravityZ)->HydrostaticState

Parameters: body: SectionalBody, fluidDensity: double, gravity: double, centerOfGravityZ: double


Public signature
export function jonswapSpectrum(double significantHeight, double peakPeriod, double peakEnhancement, double[] angularFrequencies)->WaveSpectrum

Parameters: significantHeight: double, peakPeriod: double, peakEnhancement: double, angularFrequencies: double[]


Public signature
export function linearWaveKinematics(double amplitude, double angularFrequency, double waveNumber, double depth, double horizontalPosition, double verticalPosition, double time, double fluidDensity, double gravity)->WaveKinematics

Parameters: amplitude: double, angularFrequency: double, waveNumber: double, depth: double, horizontalPosition: double, verticalPosition: double, time: double, fluidDensity: double, gravity: double


Public signature
export function morisonCylinderForce(double fluidDensity, double diameter, double length, double dragCoefficient, double inertiaCoefficient, double velocity, double acceleration)->double

Parameters: fluidDensity: double, diameter: double, length: double, dragCoefficient: double, inertiaCoefficient: double, velocity: double, acceleration: double


Public signature
export function quadraticDrag(double density, double speed, double area, double dragCoefficient)->double

Parameters: density: double, speed: double, area: double, dragCoefficient: double


Public signature
export function responseStatistics(WaveSpectrum spectrum, double[] responseAmplitudeOperators)->ResponseStatistics

Parameters: spectrum: WaveSpectrum, responseAmplitudeOperators: double[]


Public signature
export record ResponseStatistics(public double responseVariance, public double responseRms, public double significantResponse, public double meanZeroCrossingPeriod)

Parameters: responseVariance: double, responseRms: double, significantResponse: double, meanZeroCrossingPeriod: double


Public signature
export function sectionalBody(string name, double[] longitudinalPositions, double[] submergedAreas, double[] waterlineBreadths, double[] verticalCentroids)->SectionalBody

Parameters: name: string, longitudinalPositions: double[], submergedAreas: double[], waterlineBreadths: double[], verticalCentroids: double[]


Public signature
export record SectionalBody(public string name, public double[] longitudinalPositions, public double[] submergedAreas, public double[] waterlineBreadths, public double[] verticalCentroids)

Parameters: name: string, longitudinalPositions: double[], submergedAreas: double[], waterlineBreadths: double[], verticalCentroids: double[]


Public signature
export function shallowWaterCelerity(double gravity, double depth)->double

Parameters: gravity: double, depth: double


Public signature
export function simulateHeave(double mass, double addedMass, double damping, double stiffness, double[] forces, double timeStep, double initialDisplacement, double initialVelocity)->HeaveHistory

Parameters: mass: double, addedMass: double, damping: double, stiffness: double, forces: double[], timeStep: double, initialDisplacement: double, initialVelocity: double


Public signature
export function spectrumToWaveSeries(WaveSpectrum spectrum, double timeStep, int samples, long seed)->WaveSeries

Parameters: spectrum: WaveSpectrum, timeStep: double, samples: int, seed: long


Public signature
export record Stability(public double metacentricHeight, public double rightingMoment, public bool stable)

Parameters: metacentricHeight: double, rightingMoment: double, stable: bool


Public signature
export function transverseStability(double displacedVolume, double waterplaneSecondMoment, double centerBuoyancy, double centerGravity, double displacementWeight, double heelAngle)->Stability

Parameters: displacedVolume: double, waterplaneSecondMoment: double, centerBuoyancy: double, centerGravity: double, displacementWeight: double, heelAngle: double


Public signature
export function verticalRectangleForce(double density, double gravity, double width, double height, double topDepth)->HydrostaticForce

Parameters: density: double, gravity: double, width: double, height: double, topDepth: double


Public signature
export record WaveKinematics(public double horizontalVelocity, public double verticalVelocity, public double horizontalAcceleration, public double verticalAcceleration, public double dynamicPressure)

Parameters: horizontalVelocity: double, verticalVelocity: double, horizontalAcceleration: double, verticalAcceleration: double, dynamicPressure: double


Public signature
export record WaveLoadHistory(public double[] times, public double[] dragLoads, public double[] inertiaLoads, public double[] totalLoads, public double maximumAbsoluteLoad, public string model, public string diagnostic)

Parameters: times: double[], dragLoads: double[], inertiaLoads: double[], totalLoads: double[], maximumAbsoluteLoad: double, model: string, diagnostic: string


Public signature
export function waveLoadTimeHistory(double fluidDensity, double diameter, double cylinderLength, double dragCoefficient, double inertiaCoefficient, double[] velocities, double[] accelerations, double timeStep)->WaveLoadHistory

Parameters: fluidDensity: double, diameter: double, cylinderLength: double, dragCoefficient: double, inertiaCoefficient: double, velocities: double[], accelerations: double[], timeStep: double


Public signature
export record WaveSeries(public double[] times, public double[] elevations, public double[] componentAmplitudes, public double[] componentPhases, public long seed, public double variance, public string diagnostic)

Parameters: times: double[], elevations: double[], componentAmplitudes: double[], componentPhases: double[], seed: long, variance: double, diagnostic: string


Public signature
export record WaveSpectrum(public double[] angularFrequencies, public double[] spectralDensities, public double zerothMoment, public double significantHeight, public double peakAngularFrequency)

Parameters: angularFrequencies: double[], spectralDensities: double[], zerothMoment: double, significantHeight: double, peakAngularFrequency: 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.