Changeset 4065 for trunk/LMDZ.COMMON/libf/evolution/subsurface_ice.F90

Timestamp:

Feb 12, 2026, 9:09:12 AM (2 weeks ago)

Author:

jbclement

Message:

PEM:
Major refactor following the previous ones (r3989 and r3991) completing the large structural reorganization and cleanup of the PEM codebase. This revision introduces newly designed modules, standardizes interfaces with explicit ini/end APIs and adds native NetCDF I/O together with explicit PCM/PEM adapters. In detail:

• Some PEM models were corrected or improved:
  • Frost/perennial ice semantics are clarified via renaming;
  • Soil temperature remapping clarified, notably by removing the rescaling of temperature deviation;
  • Geothermal flux for the PCM is computed based on the PEM state;
• New explicit PEM/PCM adapters ("set_*"/"build4PCM_*") to decouple PEM internal representation from PCM file layouts and reconstruct consistent fields returned to the PCM;
• New explicit build/teardown routines that centralize allocation and initialization ordering, reducing accidental use of uninitialized data and making the model lifecycle explicit;
• Add native read/write helpers for NetCDF that centralize all low-level NetCDF interactions with major improvements (and more simplicity) compared to legacy PEM/PCM I/O (see the modules "io_netcdf" and "output"). They support reading, creation and writing of "diagevol.nc" (renamed from "diagpem.nc") and start/restart files;
• Provide well-focused modules ("numerics"/"maths"/"utility"/"display") to host commonly-used primitives:
  • "numerics" defines numerical types and constants for reproducibility, portability across compilers and future transitions (e.g. quadruple precision experiments);
  • "display" provides a single controlled interface for runtime messages, status output and diagnostics, avoiding direct 'print'/'write' to enable silent mode, log redirection, and MPI-safe output in the future.
  • "utility" (new module) hosts generic helpers used throughout the code (e.g. "int2str" or "real2str");
• Add modules "clim_state_init"/"clim_state_rec" which provide robust read/write logic for "start/startfi/startpem", including 1D fallbacks, mesh conversions and dimension checks. NetCDF file creation is centralized and explicit. Restart files are now self-consistent and future-proof, requiring changes only to affected variables;
• Add module "atmosphere" which computes pressure fields, reconstructs potential temperature and air mass. It also holds the whole logic to define sigma or hybrid coordinates for altitudes;
• Add module "geometry" to centrilize dimensions logic and grid conversions routines (including 2 new ones "dyngrd2vect"/"vect2dyngrd");
• Add module "slopes" to isolate slopes handling;
• Add module "surface" to isolate surface management. Notably, albedo and emissivity are now fully reconstructed following the PCM settings;
• Add module "allocation" to check the dimension initialization and centrilize allocation/deallocation;
• Finalize module decomposition and renaming to consolidate domain-based modules, purpose-based routines and physics/process-based variables;
• The main program now drives a clearer sequence of conceptual steps (initialization / reading / evolution / update / build / writing) and fails explicitly instead of silently defaulting;
• Ice table logic is made restart-safe;
• 'Open'/'read' intrinsic logic is made safe and automatic;
• Improve discoverability and standardize the data handling (private vs protected vs public);
• Apply consistent documentation/header style already introduced;
• Update deftank scripts to reflect new names and launch wrappers;

This revision is a structural milestone aiming to be behavior-preserving where possible. It has been tested via compilation and short integration runs. However, due to extensive renames, moves, and API changes, full validation is still ongoing.
Note: the revision includes one (possibly two) easter egg hidden in the code for future archaeologists of the PEM. No physics were harmed.
JBC

File:

• trunk/LMDZ.COMMON/libf/evolution/subsurface_ice.F90 (modified) (14 diffs)

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

@@ -17 +17 @@
 !-----------------------------------------------------------------------
 
+! DEPENDENCIES
+! ------------
+use numerics, only: dp, di
+
 ! DECLARATION
 ! -----------
 implicit none
 
-! MODULE PARAMETERS
-! -----------------
+! PARAMETERS
+! ----------
 real(8), parameter :: dt = 0.02  ! in units of Mars solar days
 !real(8), parameter :: Fgeotherm = 0.
@@ -47 +51 @@
 ! orbital elements remain constant
 !***********************************************************************
-  use constants_marspem_mod, only: sec_per_sol
-  use phys_constants,        only: pi
+  use orbit, only: sol_len_s
+  use maths, only: pi
   ! DECLARATION
 ! -----------
@@ -139 +143 @@
  !    print *,'  latitude (deg)',latitude(k),' rho*c (J/m^3/K)',rhoc(k),' thIn=',thIn(k)
  !    print *,'  total pressure=',p0(k),'partial pressure=',pfrost(k)
-     delta = thIn(k)/rhoc(k)*sqrt(sec_per_sol/pi)
+     delta = thIn(k)/rhoc(k)*sqrt(sol_len_s/pi)
  !    print *,'  skin depths (m)',delta,delta*sqrt(solsperyear)
      call soilthprop(porosity,1.d0,rhoc(k),thIn(k),1,newrhoc,newti,icefrac)
@@ -222 +226 @@
 !     output are newti and newrhoc
 !***********************************************************************
-  ! DECLARATION
+
+! DEPENDENCIES
+! ------------
+use stoppage, only: stop_clean
+
+! DECLARATION
 ! -----------
 implicit none
@@ -281 +290 @@
 
   case default
-     error stop 'invalid layer type'
+     call stop_clean(__FILE__,__LINE__,'invalid layer type',1)
 
   end select
@@ -338 +347 @@
 ! latitude  [degree]
 !*************************************************************************
-  use ice_table,      only: rho_ice
+  !use ice_table,      only: rho_ice
   !use omp_lib
   ! DECLARATION
@@ -457 +466 @@
 !  Tb>0 initializes temperatures with Tb
 !***********************************************************************
-  use constants_marspem_mod, only: sols_per_my, sec_per_sol
+  use orbit, only: yr_len_sol, sol_len_s
   ! DECLARATION
 ! -----------
@@ -485 +494 @@
   real(8) rhosatav0, rhosatav(nz), rlow
 
-  tmax = EQUILTIME*sols_per_my
+  tmax = EQUILTIME*yr_len_sol
   nsteps = int(tmax/dt)     ! calculate total number of timesteps
 
@@ -523 +532 @@
   do n=0,nsteps-1
      time = (n+1)*dt         !   time at n+1
-   !  tdays = time*(sec_per_sol/earthDay) ! parenthesis may improve roundoff
+   !  tdays = time*(sol_len_s/earthDay) ! parenthesis may improve roundoff
    !  call generalorbit(tdays,a,ecc,omega,eps,marsLs,marsDec,marsR)
    !  HA = 2.*pi*mod(time,1.d0)  ! hour angle
@@ -533 +542 @@
      Told(1:nz) = T(1:nz)
      if (m<=0. .or. Tsurf>Tco2frost) then
-       ! call conductionQ(nz,z,dt*sec_per_sol,Qn,Qnp1,T,ti,rhocv,emiss, &
+       ! call conductionQ(nz,z,dt*sol_len_s,Qn,Qnp1,T,ti,rhocv,emiss, &
        !      &           Tsurf,Fgeotherm,Fsurf)
      endif
      if (Tsurf<Tco2frost .or. m>0.) then ! CO2 condensation
         T(1:nz) = Told(1:nz)
-        !call conductionT(nz,z,dt*sec_per_sol,T,Tsurfold,Tco2frost,ti, &
+        !call conductionT(nz,z,dt*sol_len_s,T,Tsurfold,Tco2frost,ti, &
              !&              rhocv,Fgeotherm,Fsurf)
         Tsurf = Tco2frost
     !    dE = (- Qn - Qnp1 + Fsurfold + Fsurf + &
     !         &      emiss*sigSB*(Tsurfold**4+Tsurf**4)/2.
-        m = m + dt*sec_per_sol*dE/Lco2frost
+        m = m + dt*sol_len_s*dE/Lco2frost
      endif
      if (Tsurf>Tco2frost .or. m<=0.) then
@@ -554 +563 @@
      !Qn=Qnp1
 
-     if (time>=tmax-sols_per_my) then
+     if (time>=tmax-yr_len_sol) then
         Tmean1 = Tmean1 + Tsurf
         Tmean3 = Tmean3 + T(nz)
@@ -715 +724 @@
 !  B = Diff*bigstep/(porosity*icedensity)  [SI units]
 !***********************************************************************
-  use math_toolkit, only: deriv2_simple, deriv1_onesided, deriv1, colint
-  use ice_table,    only: constriction
+  use maths,     only: deriv2_simple, deriv1_onesided, deriv1, colint
   ! DECLARATION
 ! -----------
@@ -848 +856 @@
 ! a crucial subroutine
 !***********************************************************
-  use math_toolkit, only: colint
-  use ice_table,    only: rho_ice
+  use maths,     only: colint
+  !use ice_table, only: rho_ice
   ! DECLARATION
 ! -----------
@@ -933 +941 @@
 end subroutine icechanges
 
+!=======================================================================
+FUNCTION constriction(porefill) RESULT(eta)
+!-----------------------------------------------------------------------
+! NAME
+!     constriction
+!
+! DESCRIPTION
+!     Compute the constriction of vapor flux by pore ice.
+!
+! AUTHORS & DATE
+!     L. Lange
+!     JB Clement, 2023-2025
+!
+! NOTES
+!
+!-----------------------------------------------------------------------
+
+! DECLARATION
+! -----------
+implicit none
+
+! ARGUMENTS
+! ---------
+real, intent(in) :: porefill ! pore filling fraction
+
+! LOCAL VARIABLES
+! ---------------
+real :: eta ! constriction
+
+! CODE
+! ----
+if (porefill <= 0.) then
+    eta = 1.
+else if (0 < porefill .and. porefill < 1.) then
+    eta = (1-porefill)**2 ! Hudson et al., JGR, 2009
+else
+    eta = 0.
+endif
+
+END FUNCTION constriction
+!=======================================================================
+
 END MODULE subsurface_ice