buildHighTideScenario: Build high tides into scenario table

View source: R/buildHighTideScenario.R

buildHighTideScenarioR Documentation

Build high tides into scenario table

Description

This function takes a sea-level scenario table and elevations for 1 to 3 tidal cycles and outputs a scenario table with annualized high tide levels.

Usage

buildHighTideScenario(
  scenarioCurve,
  meanSeaLevelDatum = scenarioCurve$meanSeaLevel[1],
  meanHighWaterDatum,
  meanHighHighWaterDatum,
  meanHighHighWaterSpringDatum,
  lunarNodalAmp,
  lunarNodalPhase = 2011.181
)

Arguments

scenarioCurve

a data frame, including year, mean sea level, and suspended sediment concentration, with each row being a year in the scenario

meanSeaLevelDatum

a numeric, Mean Sea Level over a tidal datum period

meanHighWaterDatum

a numeric, Mean High Water level over the last datum period

meanHighHighWaterDatum

a numeric, Mean Higher High Water level over the last datum period

meanHighHighWaterSpringDatum

a numeric, Mean Higher High Spring Tide Water level over the last datum period

lunarNodalAmp

the amplitude of the 18-year lunar nodal cycle

lunarNodalPhase

a numeric, in decimal years (YYYY) the start year of the sine wave representing the lunar nodal cycle

Value

a data frame, including the sea-level and suspended sediment concentration scenario inputted, with annual high tide datum(s) added


tilbud/rCTM documentation built on March 30, 2024, 10:06 a.m.