Skip to content

Commit

Permalink
Update gsw_geo_strf_dyn_height_1 docstring with new interpolation option
Browse files Browse the repository at this point in the history
  • Loading branch information
mauzey1 committed Sep 25, 2024
1 parent 6170072 commit e0418ce
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions gsw_oceanographic_toolbox.c
Original file line number Diff line number Diff line change
Expand Up @@ -4010,8 +4010,9 @@ gsw_geo_strf_dyn_height_1(double *sa, double *ct, double *p, double p_ref,
!
! This function evaluates the pressure integral of specific volume using
! SA and CT interpolated with respect to pressure. The interpolation method
! may be chosen as linear or "PCHIP", piecewise cubic Hermite using a shape-
! preserving algorithm for setting the derivatives.
! may be chosen as linear, "PCHIP" (piecewise cubic Hermite using a shape-
! preserving algorithm for setting the derivatives), or "MRST-PCHIP"
! (Multiply-Rotated Salinity–Temperature PCHIP).
!
! SA = Absolute Salinity [ g/kg ]
! CT = Conservative Temperature (ITS-90) [ deg C ]
Expand All @@ -4023,7 +4024,7 @@ gsw_geo_strf_dyn_height_1(double *sa, double *ct, double *p, double p_ref,
! geo_strf_dyn_height = dynamic height anomaly [ m^2/s^2 ]
! max_dp_i = maximum pressure difference between points for triggering
! interpolation.
! interp_method = 1 for linear, 2 for PCHIP
! interp_method = 1 for linear, 2 for PCHIP, 3 for MRST-PCHIP
!
! Note. If p_ref falls outside the range of a
! vertical profile, the dynamic height anomaly for each bottle
Expand Down

0 comments on commit e0418ce

Please sign in to comment.