roms_tools.Grid.update_vertical_coordinate

roms_tools.Grid.update_vertical_coordinate#

Grid.update_vertical_coordinate(N=None, theta_s=None, theta_b=None, hc=None, verbose=False) → None#

Create vertical coordinate variables for the ROMS grid.

This method computes the S-coordinate stretching curves at rho- and w-points.

Parameters:

  • N (int) – Number of vertical levels. If not provided, N will remain unchanged (i.e., the existing value will not be overwritten).

  • theta_s (float) – S-coordinate surface control parameter. If not provided, theta_s will remain unchanged (i.e., the existing value will not be overwritten).

  • theta_b (float) – S-coordinate bottom control parameter. If not provided, theta_b will remain unchanged (i.e., the existing value will not be overwritten).

  • hc (float) – Critical depth (m) used in ROMS vertical coordinate stretching. If not provided, hc will remain unchanged (i.e., the existing value will not be overwritten).

  • verbose (bool, optional) – Indicates whether to print vertical coordinate generation steps with timing. Defaults to False.

Returns:

None – This method modifies the dataset in place by adding vertical coordinate variables.