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

Timestamp:

Dec 16, 2025, 4:39:24 PM (5 weeks 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/outputs.F90 (modified) (11 diffs)

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

@@ -1 +1 @@
 MODULE outputs
-
+!-----------------------------------------------------------------------
+! NAME
+!     outputs
+!
+! DESCRIPTION
+!     Tools to write PEM diagnostic outputs.
+!
+! AUTHORS & DATE
+!     LMDZ team
+!     E. Leconte, 2010
+!     F. Forget, 2011
+!     JB Clement, 2023–2025
+!
+! NOTES
+!     Uses NetCDF low-level API and supports parallel runs.
+!-----------------------------------------------------------------------
+
+! DECLARATION
+! -----------
 implicit none
 
+! MODULE VARIABLES
+! ----------------
 integer :: output_rate ! Output rate
 
-!=======================================================================
 contains
-!=======================================================================
+!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 SUBROUTINE write_diagpem(ngrid,nom,titre,unite,dim,px)
@@ -48 +67 @@
 !      dim : dimension de px : 0, 1, 2, ou 3 dimensions
 !
-!=================================================================
+!-----------------------------------------------------------------------
+! NAME
+!     write_diagpem
+!
+! DESCRIPTION
+!     Write selected diagnostic variables to NetCDF file 'diagpem.nc'.
+!     Supports 3D, 2D, 1D (column), and 0D (scalar) variables.
+!
+! AUTHORS & DATE
+!     E. Leconte, 2010
+!     F. Forget, 2011
+!     JB Clement, 2023–2025
+!
+! NOTES
+!     Output cadence is controlled by 'output_rate' from run.def. Parallel-safe
+!     with master task handling NetCDF I/O. Can use 'diagpem.def' to select vars.
+!-----------------------------------------------------------------------
+
+! DEPENDENCIES
+! ------------
 use surfdat_h,          only: phisfi
 use geometry_mod,       only: cell_area
@@ -54 +92 @@
 use mod_grid_phy_lmdz,  only: klon_glo, Grid1Dto2D_glo, nbp_lon, nbp_lat, nbp_lev, grid_type, unstructured
 
+! DECLARATION
+! -----------
 implicit none
 
@@ -59 +99 @@
 include "netcdf.inc"
 
-! Arguments on input:
+! ARGUMENTS
+! ---------
 integer,                        intent(in) :: ngrid
 character(len=*),               intent(in) :: nom, titre, unite
@@ -65 +106 @@
 real, dimension(ngrid,nbp_lev), intent(in) :: px
 
-! Local variables:
+! LOCAL VARIABLES
+! ---------------
 real*4, dimension(nbp_lon + 1,nbp_lat,nbp_lev) :: dx3    ! to store a 3D data set
 real*4, dimension(nbp_lon + 1,nbp_lat)         :: dx2    ! to store a 2D (surface) data set
@@ -117 +159 @@
 #endif
 
+! CODE
+! ----
 if (grid_type == unstructured) return
 
@@ -580 +624 @@
 
 END SUBROUTINE write_diagpem
-
 !=================================================================
 
+!=================================================================
 SUBROUTINE write_diagsoilpem(ngrid,name,title,units,dimpx,px)
+!-----------------------------------------------------------------------
+! NAME
+!     write_diagsoilpem
+!
+! DESCRIPTION
+!     Write soil-related diagnostic variables to 'diagsoilpem.nc'.
+!     Supports 3D (lon,lat,depth), 2D (lon,lat), and 0D scalars.
+!
+! AUTHORS & DATE
+!     E. Leconte, 2010
+!     JB Clement, 2023–2025
+!
+! NOTES
+!     Output cadence uses 'output_rate'. Only lon-lat (or 1D) grids supported.
+!-----------------------------------------------------------------------
 
 ! Write variable 'name' to NetCDF file 'diagsoilpem.nc'.
@@ -596 +655 @@
 ! Modifs: Aug.2010 Ehouarn: enforce outputs to be real*4
 
+! DEPENDENCIES
+! ------------
 use soil,               only: mlayer_PEM, nsoilmx_PEM, inertiedat_PEM
 use geometry_mod,       only: cell_area
@@ -603 +664 @@
 use iniwritesoil_mod,   only: iniwritesoil
 
+! DECLARATION
+! -----------
 implicit none
 
 include"netcdf.inc"
 
-! Arguments:
-integer,intent(in) :: ngrid ! number of (horizontal) points of physics grid
+! ARGUMENTS
+! ---------
+integer,                            intent(in) :: ngrid ! number of (horizontal) points of physics grid
 ! i.e. ngrid = 2+(jjm-1)*iim - 1/jjm
-character(len=*),intent(in) :: name ! 'name' of the variable
-character(len=*),intent(in) :: title ! 'long_name' attribute of the variable
-character(len=*),intent(in) :: units ! 'units' attribute of the variable
-integer,intent(in) :: dimpx ! dimension of the variable (3,2 or 0)
-real,dimension(ngrid,nsoilmx_PEM),intent(in) :: px ! variable
-
-! Local variables:
+character(len=*),                   intent(in) :: name  ! 'name' of the variable
+character(len=*),                   intent(in) :: title ! 'long_name' attribute of the variable
+character(len=*),                   intent(in) :: units ! 'units' attribute of the variable
+integer,                            intent(in) :: dimpx ! dimension of the variable (3,2 or 0)
+real, dimension(ngrid,nsoilmx_PEM), intent(in) :: px    ! variable
+
+! LOCAL VARIABLES
+! ---------------
 real*4,dimension(nbp_lon+1,nbp_lat,nsoilmx_PEM) :: data3 ! to store 3D data
 real*4,dimension(nbp_lon+1,nbp_lat) :: data2 ! to store 2D data
@@ -657 +722 @@
 #endif
 
+! CODE
+! ----
 ! 0. Do we ouput a diagsoilpem.nc file? If not just bail out now.
 
@@ -989 +1056 @@
 
 END SUBROUTINE write_diagsoilpem
+!=================================================================
 
 END MODULE outputs