Changeset 3991 for trunk/LMDZ.COMMON/libf/evolution/surf_temp.F90

Timestamp:

Dec 16, 2025, 4:39:24 PM (7 days ago)

Author:

jbclement

Message:

PEM:
Apply documentation template everywhere: standardized headers format with short description, separators between functions/subroutines, normalized code sections, aligned dependencies/arguments/variables declaration.
JBC

File:

• trunk/LMDZ.COMMON/libf/evolution/surf_temp.F90 (modified) (2 diffs)

trunk/LMDZ.COMMON/libf/evolution/surf_temp.F90

@@ -1 +1 @@
 MODULE surf_temp
-
+!-----------------------------------------------------------------------
+! NAME
+!     surf_temp
+!
+! DESCRIPTION
+!     Surface temperature management.
+!
+! AUTHORS & DATE
+!     JB Clement, 2025
+!
+! NOTES
+!
+!-----------------------------------------------------------------------
+
+! DECLARATION
+! -----------
 implicit none
 
-!=======================================================================
 contains
-!=======================================================================
+!++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 !=======================================================================
 SUBROUTINE update_tsurf_nearest_baresoil(ngrid,nslope,nlon,nlat,latitude,tsurf_avg,co2_ice,is_co2ice_ini,co2ice_disappeared)
-
+!-----------------------------------------------------------------------
+! NAME
+!     update_tsurf_nearest_baresoil
+!
+! DESCRIPTION
+!     Update surface temperature where CO2 ice disappeared using nearby
+!     bare soil temperature.
+!
+! AUTHORS & DATE
+!     JB Clement, 2025
+!
+! NOTES
+!
+!-----------------------------------------------------------------------
+
+! DEPENDENCIES
+! ------------
 use grid_conversion, only: vect2lonlat, lonlat2vect
 
+! DECLARATION
+! -----------
 implicit none
 
-! Inputs:
-integer,                          intent(in) :: nlon, nlat, nslope, ngrid
-real,    dimension(ngrid,nslope), intent(in) :: co2_ice
-real,    dimension(ngrid),        intent(in) :: latitude
-logical, dimension(ngrid,nslope), intent(in) :: is_co2ice_ini
-! Outputs:
-real,    dimension(ngrid,nslope), intent(inout) :: tsurf_avg
-logical, dimension(ngrid,nslope), intent(inout) :: co2ice_disappeared
-! Local variables:
-real, parameter                   :: eps = 1.e-10
-integer                           :: islope, i, j, k, radius, rmax, di, dj, ii, jj
-logical                           :: found
-real, dimension(nlon,nlat,nslope) :: tsurf_ll, co2ice_ll, mask_co2ice_ini, co2ice_disappeared_ll
-real, dimension(nlon,nlat)        :: latitude_ll
-real, dimension(ngrid)            :: tmp
-integer, dimension(nslope - 1)    :: priority
-
+! ARGUMENTS
+! ---------
+integer,                          intent(in)    :: nlon, nlat, nslope, ngrid ! Grid dimensions
+real,    dimension(ngrid,nslope), intent(in)    :: co2_ice                   ! CO2 ice density
+real,    dimension(ngrid),        intent(in)    :: latitude                  ! Latitude
+logical, dimension(ngrid,nslope), intent(in)    :: is_co2ice_ini             ! Initial CO2 ice flag
+real,    dimension(ngrid,nslope), intent(inout) :: tsurf_avg                 ! Average surface temperature
+logical, dimension(ngrid,nslope), intent(inout) :: co2ice_disappeared        ! Ice disappeared flag
+
+! LOCAL VARIABLES
+! ---------------
+real, parameter                      :: eps = 1.e-10
+integer                              :: islope, i, j, k, radius, rmax, di, dj, ii, jj
+logical                              :: found
+real,    dimension(nlon,nlat,nslope) :: tsurf_ll, co2ice_ll, mask_co2ice_ini, co2ice_disappeared_ll
+real,    dimension(nlon,nlat)        :: latitude_ll
+real,    dimension(ngrid)            :: tmp
+integer, dimension(nslope - 1)       :: priority
+
+! CODE
+! ----
 ! Check to escape the subroutine (not relevant in 1D)
 if (ngrid == 1) return
@@ -110 +146 @@
 !=======================================================================
 SUBROUTINE get_slope_priority(lat,nslope,islope,priority)
-! Priority given to equator-ward slope which are most likely to hold no ice
-
+!-----------------------------------------------------------------------
+! NAME
+!     get_slope_priority
+!
+! DESCRIPTION
+!     Determine slope priority based on latitude (equator-ward favored).
+!
+! AUTHORS & DATE
+!     JB Clement, 2025
+!
+! NOTES
+!     Equator-ward slopes are most likely to hold no ice.
+!-----------------------------------------------------------------------
+
+! DECLARATION
+! -----------
 implicit none
 
-! Inputs:
-real,    intent(in) :: lat
-integer, intent(in) :: nslope, islope
-! Outputs:
-integer, dimension(nslope - 1), intent(out) :: priority
-! Locals:
+! ARGUMENTS
+! ---------
+real,                           intent(in)  :: lat      ! Latitude [degrees]
+integer,                        intent(in)  :: nslope, islope
+integer, dimension(nslope - 1), intent(out) :: priority ! Priority ordering of slopes
+
+! LOCAL VARIABLES
+! ---------------
 integer :: i, k
 
-! Code
-!-----
+! CODE
+! ----
 k = 1