Package ucar.nc2.geoloc.vertical

Class OceanS

  • All Implemented Interfaces:
    VerticalTransform
    public class OceanS
extends Object
    Implement CF "ocean_s_coordinate". 
     standard_name = "ocean_s_coordinate"
 Definition
 z(n,k,j,i) = eta(n,j,i)*(1+s(k)) + depth_c*s(k) + (depth(j,i)-depth_c)*C(k)
 where
 C(k) = (1-b)*sinh(a*s(k))/sinh(a) + b*[tanh(a*(s(k)+0.5))/(2*tanh(0.5*a)) - 0.5]
 where
 z(n,k,j,i) is height (positive upwards) relative to the datum (e.g. mean sea level) at gridpoint (n,k,j,i),
 eta(n,j,i) is the height of the sea surface (positive upwards) relative to the datum at gridpoint (n,j,i), s(k) is
 the
 dimensionless coordinate at vertical gridpoint (k), and depth(j,i) is the distance (a positive value) from the datum
 to the sea floor at horizontal gridpoint (j,i). The constants a, b, and depth_c control the stretching. The constants
 a and b are dimensionless, and depth_c must have units of length.

 The format for the formula_terms attribute is
 formula_terms = "s: var1 eta: var2 depth: var3 a: var4 b: var5 depth_c: var6"
    See Also:
    "http://cfconventions.org/Data/cf-conventions/cf-conventions-1.9/cf-conventions.html#_ocean_s_coordinate"