Changeset 4110 for trunk/LMDZ.COMMON/libf/evolution/config.F90

Timestamp:

Mar 9, 2026, 10:29:53 AM (8 days ago)

Author:

jbclement

Message:

PEM:

• Introduction of a configurable display/logging system with options 'out2term', 'out2log', 'verbosity_lvl'. All messages now use verbosity levels ('LVL_NFO', 'LVL_WRN', 'LVL_ERR' and 'LVL_DBG').
• Code encapsulation improvements with systematic privacy/protection of module variables.
• Addition of workflow safety checks for required executables, dependencies (e.g. 'ncdump'), input files and callphys keys.
• Renaming of PEM starting and diagnostic files ("startevol.nc" into "startevo.nc", "diagevol.nc" into "diagevo.nc").

JBC

File:

• trunk/LMDZ.COMMON/libf/evolution/config.F90 (modified) (19 diffs)

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

@@ -23 +23 @@
 implicit none
 
-character(7),  parameter :: rundef_name = 'run.def'
-character(11), parameter :: run_pcmdef_name = 'run_pcm.def'
-character(12), parameter :: callphys_name = 'callphys.def'
+character(7),  parameter, private :: rundef_name = 'run.def'
+character(11), parameter, private :: runPCMdef_name = 'run_pcm.def'
+character(12), parameter          :: callphys_name = 'callphys.def'
 
 contains
@@ -68 +68 @@
 use atmosphere,       only: set_atmosphere_config
 use stoppage,         only: stop_clean
-use display,          only: print_msg
+use display,          only: print_msg, LVL_NFO
 
 ! DECLARATION
@@ -76 +76 @@
 ! LOCAL VARIABLES
 ! ---------------
-logical(k4) :: here, evol_orbit_l, evol_obl_l, evol_ecc_l, evol_lsp_l, do_soil_l, reg_thprop_dependp_l, do_sorption_l, hybrid
+logical(k4) :: here, evo_orbit_l, evo_obl_l, evo_ecc_l, evo_lsp_l, do_soil_l, reg_thprop_dependp_l, do_sorption_l, hybrid
 logical(k4) :: icetable_equilibrium_l, icetable_dynamic_l, h2oice_flow_l, co2ice_flow_l, do_layering_l, impose_dust_ratio_l
 integer(di) :: output_rate_l
@@ -87 +87 @@
 inquire(file = rundef_name,exist = here)
 if (.not. here) call stop_clean(__FILE__,__LINE__,'cannot find required file "'//rundef_name//'" (PEM)!',1)
-call print_msg('> Reading "'//rundef_name//'"')
-
-! Output
-! ~~~~~~
+call print_msg('> Reading "'//rundef_name//'"',LVL_NFO)
+
+! Outputs
+! ~~~~~~~
 output_rate_l = 1_di ! Default value: every year
 call getin('output_rate',output_rate_l)
@@ -96 +96 @@
 ! Orbital parameters
 ! ~~~~~~~~~~~~~~~~~~
-evol_orbit_l = .false.
-call getin('evol_orbit',evol_orbit_l)
+evo_orbit_l = .false.
+call getin('evo_orbit',evo_orbit_l)
 
 pem_ini_earth_date = 0_di
 call getin('pem_ini_earth_date',pem_ini_earth_date)
 
-evol_obl_l = .true.
-call getin('evol_obl',evol_obl_l)
-
-evol_ecc_l = .true.
-call getin('evol_ecc',evol_ecc_l)
-
-evol_lsp_l = .true.
-call getin('evol_lsp',evol_lsp_l)
+evo_obl_l = .true.
+call getin('evo_obl',evo_obl_l)
+
+evo_ecc_l = .true.
+call getin('evo_ecc',evo_ecc_l)
+
+evo_lsp_l = .true.
+call getin('evo_lsp',evo_lsp_l)
 
 dt_l = 1._dp
@@ -193 +193 @@
 ! Setters
 call set_output_config(output_rate_l)
-call set_orbit_config(evol_orbit_l,evol_obl_l,evol_ecc_l,evol_lsp_l,max_change_obl_l,max_change_ecc_l,max_change_lsp_l)
+call set_orbit_config(evo_orbit_l,evo_obl_l,evo_ecc_l,evo_lsp_l,max_change_obl_l,max_change_ecc_l,max_change_lsp_l)
 call set_evolution_config(pem_ini_earth_date,dt_l,nmax_yr_run_l)
 call set_stopping_crit_config(h2oice_crit_l,co2ice_crit_l,ps_crit_l)
@@ -235 +235 @@
 use soil,      only: do_soil, reg_thprop_dependp, flux_geo
 use sorption,  only: do_sorption
-use orbit,     only: evol_orbit
+use orbit,     only: evo_orbit
 use evolution, only: pem_ini_date
 use ice_table, only: icetable_equilibrium, icetable_dynamic
-use display,   only: print_msg
+use display,   only: print_msg, LVL_WRN
 
 ! DECLARATION
@@ -247 +247 @@
 ! ----
 ! Warnings (possible incompatibilities)
-if (evol_orbit .and. abs(pem_ini_date) < minieps) call print_msg('Warning: evol_orbit = .true. but the initial date of the PEM is set to 0!')
+if (evo_orbit .and. abs(pem_ini_date) < minieps) call print_msg('''evo_orbit = .true.'' but the initial date of the PEM is set to 0!',LVL_WRN)
 
 ! Errors (true incompatibilities)
@@ -286 +286 @@
 use ioipsl_getincom, only: getin
 #endif
-use atmosphere,      only: CO2cond_ps_PCM
 use stoppage,        only: stop_clean
-use display,         only: print_msg
+use display,         only: print_msg, LVL_NFO
+use atmosphere,      only: set_CO2cond_ps_PCM
 
 ! DECLARATION
@@ -297 +297 @@
 ! ---------------
 logical(k4) :: here
+real(dp)    :: CO2cond_ps_PCM_l
 
 ! CODE
@@ -302 +303 @@
 inquire(file = callphys_name,exist = here)
 if (.not. here) call stop_clean(__FILE__,__LINE__,'cannot find required file "'//callphys_name//'"!',1)
-call print_msg('> Reading "'//callphys_name//'"')
-
-CO2cond_ps_PCM = 1._dp ! Default value
-call getin("CO2cond_ps",CO2cond_ps_PCM)
-if (CO2cond_ps_PCM < 0._dp .or. CO2cond_ps_PCM > 1._dp) call stop_clean(__FILE__,__LINE__,'Value for ''CO2cond_ps'' is not between 0 and 1. Please, specify a correct value in "'//callphys_name//'"!',1)
+call print_msg('> Reading "'//callphys_name//'"',LVL_NFO)
+
+CO2cond_ps_PCM_l = 1._dp
+call getin("CO2cond_ps",CO2cond_ps_PCM_l)
+call set_CO2cond_ps_PCM(CO2cond_ps_PCM_l)
 
 END SUBROUTINE read_callphys
@@ -330 +331 @@
 ! ------------
 use stoppage, only: stop_clean
-use display,  only: print_msg
+use display,  only: print_msg, LVL_NFO, LVL_WRN
 use utility,  only: bool2str
 
@@ -350 +351 @@
 ! CODE
 ! ----
-inquire(file = run_pcmdef_name,exist = here)
-if (.not. here) call stop_clean(__FILE__,__LINE__,'cannot find required file "'//run_pcmdef_name//'"!',1)
-call print_msg('> Reading "'//run_pcmdef_name//'"')
-open(newunit = funit,file = run_pcmdef_name,status = 'old',form = 'formatted',action = 'read',iostat = ierr)
-if (ierr /= 0) call stop_clean(__FILE__,__LINE__,'error opening file "'//run_pcmdef_name//'"!',ierr)
+inquire(file = runPCMdef_name,exist = here)
+if (.not. here) call stop_clean(__FILE__,__LINE__,'cannot find required file "'//runPCMdef_name//'"!',1)
+call print_msg('> Reading "'//runPCMdef_name//'"',LVL_NFO)
+open(newunit = funit,file = runPCMdef_name,status = 'old',form = 'formatted',action = 'read',iostat = ierr)
+if (ierr /= 0) call stop_clean(__FILE__,__LINE__,'error opening file "'//runPCMdef_name//'"!',ierr)
 
 found = .false.
@@ -385 +386 @@
 close(funit)
 
-if (.not. found) call print_msg('Warning: key ''hybrid'' not found in the file "'//run_pcmdef_name//'"!')
-if (hybrid .eqv. hybrid_in) call print_msg('USING DEFAULTS : hybrid = '//bool2str(hybrid_in))
+if (.not. found) call print_msg('Key ''hybrid'' not found in the file "'//runPCMdef_name//'"!',LVL_WRN)
+if (hybrid .eqv. hybrid_in) call print_msg('USING DEFAULTS : hybrid = '//bool2str(hybrid_in),LVL_NFO)
 
 END SUBROUTINE get_hybrid
@@ -392 +393 @@
 
 !=======================================================================
-SUBROUTINE read_controldata()
-!-----------------------------------------------------------------------
-! NAME
-!     read_controldata
+SUBROUTINE read_control_data()
+!-----------------------------------------------------------------------
+! NAME
+!     read_control_data
 !
 ! DESCRIPTION
@@ -414 +415 @@
 use soil,      only: volcapa
 use stoppage,  only: stop_clean
-use display,   only: print_msg
+use display,   only: print_msg, LVL_NFO
 
 ! DECLARATION
@@ -427 +428 @@
 ! CODE
 ! ----
-call print_msg('> Reading control data ("'//startfi_name//'")')
+call print_msg('> Reading control data ("'//startfi_name//'")',LVL_NFO)
 ! Open the "startfi.nc" file
 call open_nc(startfi_name,'read')
@@ -443 +444 @@
 ! Initialize physical data
 !     Arguments order: rad, g, mugaz, rcp
-call print_msg('    > Initializing physical constants')
+call print_msg('    > Initializing physical constants',LVL_NFO)
 call init_physics(controle(5),controle(7),controle(8),controle(9))
 
 ! Initialize soil data
-call print_msg('    > Initializing soil parameters')
+call print_msg('    > Initializing soil parameters',LVL_NFO)
 volcapa = controle(35)
 if (abs(volcapa) < minieps) call stop_clean(__FILE__,__LINE__,'volcapa is 0 in "'//startfi_name//'"!',1)
@@ -453 +454 @@
 ! Initialize orbital data
 !     Arguments order: Obliquity, Perihelion, Aphelion, Date of perihelion, Year length, Sol length
-call print_msg('    > Initializing orbital characteristics of the planet')
+call print_msg('    > Initializing orbital characteristics of the planet',LVL_NFO)
 call init_orbit(controle(18),controle(15),controle(16),controle(17),controle(14),controle(10))
 
 deallocate(controle)
 
-END SUBROUTINE read_controldata
+END SUBROUTINE read_control_data
+!=======================================================================
+
+!=======================================================================
+SUBROUTINE read_display_config()
+!-----------------------------------------------------------------------
+! NAME
+!     read_display_config
+!
+! DESCRIPTION
+!     Read PEM runtime configuration for display from getin keys, then
+!     set module-scoped parameters accordingly.
+!
+! AUTHORS & DATE
+!     JB Clement, 03/2026
+!
+! NOTES
+!
+!-----------------------------------------------------------------------
+
+! DEPENDENCIES
+! ------------
+#ifdef CPP_IOIPSL
+use IOIPSL,           only: getin
+#else
+! If not using IOIPSL, we still need to use (a local version of) getin
+use ioipsl_getincom,  only: getin
+#endif
+use stoppage,         only: stop_clean
+use display,          only: set_display_config, LVL_NFO
+
+! DECLARATION
+! -----------
+implicit none
+
+! LOCAL VARIABLES
+! ---------------
+logical(k4) :: here, out2term_l, out2log_l
+integer(di) :: verbosity_lvl_l
+
+! CODE
+! ----
+inquire(file = rundef_name,exist = here)
+if (.not. here) call stop_clean(__FILE__,__LINE__,'cannot find required file "'//rundef_name//'" (PEM)!',1)
+
+! Display
+! ~~~~~~~
+out2term_l = .true.
+call getin('out2term',out2term_l)
+
+out2log_l = .false.
+call getin('out2log',out2log_l)
+
+verbosity_lvl_l = LVL_NFO
+call getin('verbosity_lvl',verbosity_lvl_l)
+
+! Setter
+call set_display_config(out2term_l,out2log_l,verbosity_lvl_l)
+
+END SUBROUTINE read_display_config
 !=======================================================================