From 865590988b7b23d2ae614f32c2eee91299a395c1 Mon Sep 17 00:00:00 2001 From: Edward Hartnett <38856240+edwardhartnett@users.noreply.github.com> Date: Tue, 20 Apr 2021 11:21:23 -0600 Subject: [PATCH] Minor documentation update in sorc/grid_tools.fd/regional_esg_grid.fd (#444) * added slideshow and reference in README * removed stray question marks * added authors to filter_topo.f90 * added authors to filter_topo.f90 * last edits from Jim Purser --- .../filter_topo.fd/filter_topo.F90 | 3 ++- .../regional_esg_grid.fd/pietc.f90 | 2 +- .../regional_esg_grid.fd/psym2.f90 | 20 ++++++++++--------- 3 files changed, 14 insertions(+), 11 deletions(-) diff --git a/sorc/grid_tools.fd/filter_topo.fd/filter_topo.F90 b/sorc/grid_tools.fd/filter_topo.fd/filter_topo.F90 index 5bf81b92f..a56d4acb6 100644 --- a/sorc/grid_tools.fd/filter_topo.fd/filter_topo.F90 +++ b/sorc/grid_tools.fd/filter_topo.fd/filter_topo.F90 @@ -5,7 +5,8 @@ !> This program does ??? !! !! @return 0 for success, error code otherwise. -!! @author GFDL Programmer +!! @author S-J Lin (GFDL) for filtering algorithm(s) +!! @author Zhi Liang (GFDL) who packaged it into a standalone application. program filter_topo diff --git a/sorc/grid_tools.fd/regional_esg_grid.fd/pietc.f90 b/sorc/grid_tools.fd/regional_esg_grid.fd/pietc.f90 index 0bd6c7130..0dceea898 100644 --- a/sorc/grid_tools.fd/regional_esg_grid.fd/pietc.f90 +++ b/sorc/grid_tools.fd/regional_esg_grid.fd/pietc.f90 @@ -53,7 +53,7 @@ module pietc real(dp),parameter:: euler=0.57721566490153286060651209008240243104215933593992359880e0_dp !< Euler-Mascheroni constant. real(dp),parameter:: dtor=pi/180 !< Degrees to radians real(dp),parameter:: rtod=180/pi !< radians to degrees -! Sines of all main fractions of 90 degrees (down to ninths): !< ??? +! Sines of all main fractions of 90 degrees (down to ninths): real(dp),parameter:: s10=.173648177666930348851716626769314796000375677184069387236241e0_dp !< sine(10 deg) real(dp),parameter:: s11=.195090322016128267848284868477022240927691617751954807754502e0_dp !< sine(90/8 deg) real(dp),parameter:: s13=.222520933956314404288902564496794759466355568764544955311987e0_dp !< sine(90/7 deg) diff --git a/sorc/grid_tools.fd/regional_esg_grid.fd/psym2.f90 b/sorc/grid_tools.fd/regional_esg_grid.fd/psym2.f90 index f8ed4293a..e57c4163c 100644 --- a/sorc/grid_tools.fd/regional_esg_grid.fd/psym2.f90 +++ b/sorc/grid_tools.fd/regional_esg_grid.fd/psym2.f90 @@ -26,7 +26,7 @@ module psym2 interface expsym2; module procedure expsym2,expsym2d; end interface interface expsym2d_e; module procedure expsym2d_e; end interface interface expsym2d_t; module procedure expsym2d_t; end interface -interface logsym2; module procedure logsym2,logsym2d; end interface +interface logsym2; module procedure logsym2,logsym2d; end interface interface id2222; module procedure id2222; end interface interface chol2; module procedure chol2; end interface @@ -284,11 +284,11 @@ subroutine expsym2(em,expem)! [expsym2] expem=matmul(vv,matmul(oo,transpose(vv))) end subroutine expsym2 -!> Sub Process for process symmetric 2*2 matrix. +!> Get the exp of a symmetric 2*2 matrix, and its symmetric derivative. !! !! @param[in] x symmetric 2*2 positive-definite matrix -!! @param[out] z ??? -!! @param[out] zd symmetric derivative +!! @param[out] z exp of symmetric 2*2 matrix x +!! @param[out] zd symmetric derivative wrt x of exp of x !! @author R. J. Purser subroutine expsym2d(x,z,zd)! [expsym2] implicit none @@ -306,11 +306,12 @@ subroutine expsym2d(x,z,zd)! [expsym2] z=z*exp(trxh) end subroutine expsym2d -!> Sub Process for process symmetric 2*2 matrix. +!> Get the exponential and its symmetric derivative for a symmetric 2*2 matrix +!! using eigen-decomposition. !! !! @param[in] x symmetric 2*2 positive-definite matrix -!! @param[out] z ??? -!! @param[out] zd symmetric derivative +!! @param[out] z exp of symmetrix matrix x +!! @param[out] zd symmetric derivative of z wrt x !! @author R. J. Purser subroutine expsym2d_e(x,z,zd)! [expsym2d_e] implicit none @@ -429,9 +430,10 @@ subroutine logsym2d(x,z,zd)! [logsym2] zd(:,:,2,1)=zd(:,:,1,2) end subroutine logsym2d -!> General routine for Effective identity. +!> General routine for a symmetrized 4th-rank tensor that acts as +!! an effective identity for operations on symmetric matrices. !! -!! @param[out] em ??? +!! @param[out] em symmetrized effective identity in space of symmetrix matrices. !! @author R. J. Purser subroutine id2222(em)! [id2222] implicit none