roms_vgrid module

Various vertical coordinates

Presently, only ocean s-coordinates are supported. Future plans will be to include all of the vertical coordinate systems defined by the CF conventions.

This module is a modified copy from [HHT+21].

class gridtools.grids.roms_vgrid.s_coordinate(h, theta_b, theta_s, Tcline, N, hraw=None, zeta=None)

Bases: object

Song and Haidvogel (1994) vertical coordinate transformation (Vtransform=1) and stretching functions (Vstretching=1).

return an object that can be indexed to return depths

s = s_coordinate(h, theta_b, theta_s, Tcline, N)

class gridtools.grids.roms_vgrid.s_coordinate_2(h, theta_b, theta_s, Tcline, N, hraw=None, zeta=None)

Bases: gridtools.grids.roms_vgrid.s_coordinate

A. Shchepetkin (2005) UCLA-ROMS vertical coordinate transformation (Vtransform=2) and stretching functions (Vstretching=2).

return an object that can be indexed to return depths

s = s_coordinate_2(h, theta_b, theta_s, Tcline, N)

class gridtools.grids.roms_vgrid.s_coordinate_4(h, theta_b, theta_s, Tcline, N, hraw=None, zeta=None)

Bases: gridtools.grids.roms_vgrid.s_coordinate

A. Shchepetkin (2005) UCLA-ROMS vertical coordinate transformation (Vtransform=2) and stretching functions (Vstretching=4).

return an object that can be indexed to return depths

s = s_coordinate_4(h, theta_b, theta_s, Tcline, N)

class gridtools.grids.roms_vgrid.s_coordinate_5(h, theta_b, theta_s, Tcline, N, hraw=None, zeta=None)

Bases: gridtools.grids.roms_vgrid.s_coordinate

A. Shchepetkin (2005) UCLA-ROMS vertical coordinate transformation (Vtransform=2) and stretching functions (Vstretching=5).

return an object that can be indexed to return depths

s = s_coordinate_5(h, theta_b, theta_s, Tcline, N)

Brian Powell’s surface stretching.

class gridtools.grids.roms_vgrid.z_coordinate(h, depth, N)

Bases: object

return an object that can be indexed to return depths

z = z_coordinate(h, depth, N)

class gridtools.grids.roms_vgrid.z_r(h, hc, N, s_rho, Cs_r, zeta, Vtrans)

Bases: object

return an object that can be indexed to return depths of rho point

z_r = z_r(h, hc, N, s_rho, Cs_r, zeta, Vtrans)

class gridtools.grids.roms_vgrid.z_w(h, hc, Np, s_w, Cs_w, zeta, Vtrans)

Bases: object

return an object that can be indexed to return depths of w point

z_w = z_w(h, hc, Np, s_w, Cs_w, zeta, Vtrans)