Skip to content

Commit

Permalink
add doxygen documentation for new subroutines
Browse files Browse the repository at this point in the history
  • Loading branch information
mickaelaccensi committed Mar 29, 2024
1 parent 17644f8 commit 5635032
Showing 1 changed file with 32 additions and 4 deletions.
36 changes: 32 additions & 4 deletions model/src/w3iogomd.F90
Original file line number Diff line number Diff line change
Expand Up @@ -4650,7 +4650,19 @@ SUBROUTINE CALC_WBT (A)
!/
END SUBROUTINE CALC_WBT
!/ ------------------------------------------------------------------- /

!/
!>
!> @brief Computation of second order harmonics and
!> relevant tables for the altimeter corrections
!>
!> @param[in] NKHF Extended number of frequencies.
!> @param[out] FAC0 2nd order coef correction.
!> @param[out] FAC1 2nd order coef correction.
!> @param[out] FAC2 2nd order coef correction.
!> @param[out] FAC3 2nd order coef correction.
!>
!> @author P. Janssen @date 29-Mar-2024
!>
SUBROUTINE SECONDHH(NKHF,FAC0,FAC1,FAC2,FAC3)
!----------------------------------------------------------------

Expand Down Expand Up @@ -4890,9 +4902,25 @@ END FUNCTION VPLUS_D
! -----------------------------------------------------------------

END SUBROUTINE SECONDHH

!--------------------------------------------------------------------

!/ ------------------------------------------------------------------- /
!/
!>
!> @brief Determines skewness paramters in order to obtain
!> correction on altimeter wave height
!>
!> @details Evaluate deviations from gaussianity following the work
!> of Srokosz and Longuet-Higgins. For second order
!> corrections to surface elevation, the approach of
!> Zaharov has been used.
!>
!> @param[in] NKHF Extended number of frequencies.
!> @param[out] FAC0 2nd order coef correction.
!> @param[out] FAC1 2nd order coef correction.
!> @param[out] FAC2 2nd order coef correction.
!> @param[out] FAC3 2nd order coef correction.
!>
!> @author P. Janssen @date 29-Mar-2024
!>
SUBROUTINE SKEWNESS(A)

!--------------------------------------------------------------------
Expand Down

0 comments on commit 5635032

Please sign in to comment.