romshcoords: Coordinates at depth

In mdsumner/oms: Tools for 'ROMS' the Regional Ocean Modeling System

Coordinates at depth

Description

Extract the multi-layer 'h'eight grid with S-coordinate stretching applied

Usage

romshcoords(x, grid_type = "rho", slice, ..., depth = "h", simple = FALSE)

Arguments

x	ROMS file name
grid_type	string: "rho","psi","u","v","w"
slice	integer: if non-missing, use this time slice to index into zeta (free-surface). Otherwise assume zeta is zero (and hence depth is time-independent)
...	dots
depth	string: the name of the appropriate variable to use for depth
simple	logical: if TRUE, use the old "simple" depth method, which may not be correct

Details

Compute ROMS grid depth from vertical stretched variables Given a bathymetry (h), free-surface (zeta) and terrain-following parameters, this function computes the 3D depths for the requested C-grid location. If the free-surface is not provided, a zero value is assumed resulting in unperturb depths. This function can be used when generating initial conditions or climatology data for an application. Check the following link for details: https://www.myroms.org/wiki/index.php/Vertical_S-coordinate See https://github.com/dcherian/tools/blob/master/ROMS/arango/utility/set_depth.m Original Matlab code by Hernan Arango.

Value

RasterStack with a layer for every depth

mdsumner/oms documentation built on Oct. 11, 2024, 10:37 p.m.