Changeset 3989 for trunk/LMDZ.COMMON/libf/evolution/config_pem.F90

Timestamp:

Dec 11, 2025, 12:56:05 PM (3 months ago)

Author:

jbclement

Message:

PEM:
Massive structural refactor of the PEM codebase for improved readability, consistency and maintainability. The goal is to modernize, standardize and consolidate the code while removing legacy complexity. In detail, this change:

• Performs large-scale cleanup removing unused code, obsolete routines, duplicated functionality and deprecated initialization logic;
• Removes "*_mod" wrappers;
• Replaces mixed naming conventions with clearer variable names, domain-based file/module names and purpose-based routine names;
• Adds native reading/writing capabilities to the PEM removing the cumbersome dependency on Mars PCM subroutines;
• Centralizes soil/ice/orbital/PEM configuration logic into dedicated modules;
• Simplifies routines and updates calls/interfaces to match the new structure.

This refactor significantly clarifies the codebase and provides a cleaner foundation for forthcoming developments.
JBC

File:

• trunk/LMDZ.COMMON/libf/evolution/config_pem.F90 (moved) (moved from trunk/LMDZ.COMMON/libf/evolution/conf_pem.F90) (10 diffs)

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

@@ -1 @@
-MODULE conf_pem_mod
+MODULE config_pem
 
 !=======================================================================
@@ -14 +14 @@
 !=======================================================================
 
-SUBROUTINE conf_pem(i_myear,n_myears)
+SUBROUTINE read_rundef(i_myear,nyears_tots)
 
 #ifdef CPP_IOIPSL
@@ -23 +23 @@
 #endif
 
-use time_evol_mod,         only: year_bp_ini, dt, h2o_ice_crit, co2_ice_crit, ps_criterion, Max_iter_pem, &
-                                 evol_orbit_pem, var_obl, var_ecc, var_lsp, convert_years, ecritpem
-use comsoil_h_pem,         only: soil_pem, fluxgeo, ini_huge_h2oice, depth_breccia, depth_bedrock, reg_thprop_dependp
-use adsorption_mod,        only: adsorption_pem
-use glaciers_mod,          only: h2oice_flow, co2ice_flow, inf_h2oice_threshold
-use ice_table_mod,         only: icetable_equilibrium, icetable_dynamic
-use layering_mod,          only: layering_algo, d_dust, impose_dust_ratio, dust2ice_ratio
-use info_PEM_mod,          only: iPCM, iPEM, nPCM, nPCM_ini
+use evolution,        only: year_bp_ini, dt, nyears_max, evol_orbit, var_obl, var_ecc, var_lsp, convert_years
+use stopping_crit,    only: h2oice_crit, co2ice_crit, ps_crit
+use soil,             only: do_soil, fluxgeo, h2oice_huge_ini, depth_breccia, depth_bedrock, reg_thprop_dependp
+use sorption,         only: do_sorption
+use glaciers,         only: h2oice_flow, co2ice_flow
+use surf_ice,         only: h2oice_cap_threshold
+use ice_table,        only: icetable_equilibrium, icetable_dynamic
+use layered_deposits, only: layering_algo, d_dust, impose_dust_ratio, dust2ice_ratio
+use info_pem,         only: iPCM, iPEM, nPCM, nPCM_ini
+use outputs,          only: output_rate
 
 implicit none
 
-real, intent(out) :: i_myear, n_myears ! Current simulated Martian year and maximum number of Martian years to be simulated
+real, intent(out) :: i_myear, nyears_tots ! Current simulated Martian year and maximum number of Martian years to be simulated
 
-character(20), parameter :: modname ='conf_pem'
+character(20), parameter :: modname ='read_rundef'
 integer                  :: ierr
 integer                  :: year_earth_bp_ini ! Initial year (in Earth years) of the simulation of the PEM defined in run.def
@@ -49 +51 @@
     stop
 else
-    read(100,*) i_myear, n_myears, convert_years, iPCM, iPEM, nPCM, nPCM_ini
+    read(100,*) i_myear, nyears_tots, convert_years, iPCM, iPEM, nPCM, nPCM_ini
 endif
 close(100)
@@ -55 +57 @@
 !#---------- Output parameters ----------#
 ! Frequency of outputs for the PEM
-ecritpem = 1 ! Default value: every year
-call getin('ecritpem',ecritpem)
+output_rate = 1 ! Default value: every year
+call getin('output_rate',output_rate)
 
 !#---------- Orbital parameters ----------#
-evol_orbit_pem = .false.
-call getin('evol_orbit_pem',evol_orbit_pem)
+evol_orbit = .false.
+call getin('evol_orbit',evol_orbit)
 
 year_earth_bp_ini = 0.
@@ -79 +81 @@
 
 !#---------- Stopping criteria parameters ----------#
-Max_iter_pem = 100000000
-call getin('Max_iter_pem',Max_iter_pem)
-write(*,*) 'Max_iter_pem =',Max_iter_pem
+nyears_max = 100000000.
+call getin('nyears_max',nyears_max)
+write(*,*) 'nyears_max =',nyears_max
 
-h2o_ice_crit = 0.2
-call getin('h2o_ice_crit',h2o_ice_crit)
-write(*,*) 'h2o_ice_crit =',h2o_ice_crit
+h2oice_crit = 0.2
+call getin('h2oice_crit',h2oice_crit)
+write(*,*) 'h2oice_crit =',h2oice_crit
 
-co2_ice_crit = 0.2
-call getin('co2_ice_crit',co2_ice_crit)
-write(*,*) 'co2_ice_crit =',co2_ice_crit
+co2ice_crit = 0.2
+call getin('co2ice_crit',co2ice_crit)
+write(*,*) 'co2ice_crit =',co2ice_crit
 
-ps_criterion = 0.15
-call getin('ps_criterion',ps_criterion)
-write(*,*) 'ps_criterion =',ps_criterion
+ps_crit = 0.15
+call getin('ps_crit',ps_crit)
+write(*,*) 'ps_crit =',ps_crit
 
 dt = 1.
@@ -99 +101 @@
 
 !#---------- Subsurface parameters ----------#
-soil_pem = .true.
-call getin('soil_pem',soil_pem)
+do_soil = .true.
+call getin('do_soil',do_soil)
 
-adsorption_pem = .false.
-call getin('adsorption_pem',adsorption_pem)
+do_sorption = .false.
+call getin('do_sorption',do_sorption)
 
 reg_thprop_dependp = .false.
@@ -128 +130 @@
 call getin('icetable_dynamic',icetable_dynamic)
 write(*,*) 'Is the ice table computed with the dynamic method?', icetable_dynamic
-if ((.not. soil_pem) .and. (icetable_equilibrium .or. icetable_dynamic)) then
-    write(*,*) 'Ice table (equilibrium or dynamic method) must be used when soil_pem = T'
-    call abort_physic(modname,"Ice table must be used when soil_pem = T",1)
+if ((.not. do_soil) .and. (icetable_equilibrium .or. icetable_dynamic)) then
+    write(*,*) 'Ice table (equilibrium or dynamic method) must be used when do_soil = T'
+    call abort_physic(modname,"Ice table must be used when do_soil = T",1)
 endif
 if (icetable_equilibrium .and. icetable_dynamic) then
@@ -138 +140 @@
 endif
 
-if ((.not. soil_pem) .and. adsorption_pem) then
-    write(*,*) 'Adsorption must be used when soil_pem = T'
-    call abort_physic(modname,"Adsorption must be used when soil_pem = T",1)
+if ((.not. do_soil) .and. do_sorption) then
+    write(*,*) 'Adsorption must be used when do_soil = T'
+    call abort_physic(modname,"Adsorption must be used when do_soil = T",1)
 endif
 
-if ((.not. soil_pem) .and. (fluxgeo > 0.)) then
+if ((.not. do_soil) .and. (fluxgeo > 0.)) then
     write(*,*) 'Soil is not activated but Flux Geo > 0.'
     call abort_physic(modname,"Soil is not activated but Flux Geo > 0.",1)
 endif
 
-if ((.not. soil_pem) .and. reg_thprop_dependp) then
+if ((.not. do_soil) .and. reg_thprop_dependp) then
     write(*,*) 'Regolith properties vary with Ps only when soil is set to true'
     call abort_physic(modname,'Regolith properties vary with Ps only when soil is set to true',1)
 endif
 
-if (evol_orbit_pem .and. abs(year_bp_ini) < 1.e-10) then
+if (evol_orbit .and. abs(year_bp_ini) < 1.e-10) then
     write(*,*) 'You want to follow the file "obl_ecc_lsp.asc" for changing orbital parameters,'
     write(*,*) 'but you did not specify from which year to start.'
-    call abort_physic(modname,"evol_orbit_pem=.true. but year_bp_ini = 0",1)
+    call abort_physic(modname,"evol_orbit=.true. but year_bp_ini = 0",1)
 endif
 
 !#---------- Ice management parameters ----------#
-ini_huge_h2oice = 9200. ! kg.m-2 (= 10 m)
-call getin('ini_huge_h2oice',ini_huge_h2oice)
+h2oice_huge_ini = 9200. ! kg.m-2 (= 10 m)
+call getin('h2oice_huge_ini',h2oice_huge_ini)
 
-inf_h2oice_threshold = 460. ! kg.m-2 (= 0.5 m)
-call getin('inf_h2oice_threshold',inf_h2oice_threshold)
+h2oice_cap_threshold = 460. ! kg.m-2 (= 0.5 m)
+call getin('h2oice_cap_threshold',h2oice_cap_threshold)
 
 h2oice_flow = .true.
@@ -185 +187 @@
 call getin('dust2ice_ratio',dust2ice_ratio)
 
-END SUBROUTINE conf_pem
+END SUBROUTINE read_rundef
 
-END MODULE conf_pem_mod
+END MODULE config_pem