Changeset 5183 for LMDZ6/trunk/libf/dyn3dmem

Timestamp:

Sep 10, 2024, 5:14:23 PM (3 months ago)

Author:

dcugnet

Message:

• Remove INCA retro-compatibility with "traceur.def" (containing only water tracers but getting chemical species from an internal INCA routine).
• The "trac_type" derived type internal to "readTracFiles_mod" is removed because a generic "keys_type" is enough: no explicit key ("%" operator) is needed, even %name.
• The "trac_type" and "isot_type" derived types are now defined locally in "infotrac" and "infotrac_phy" (and more generally in each context: dynamic, lmdz dynamics, lmdz physics, etc.). The "readTracFiles_mod" module is now only used in these two routines:
  • few internal routines/variables (addPhase, delPhase, new2oldH2O, newHNO3, oldHNO3) are made available through "infotrac" and "infotrac_phy".
  • the "getKey" routine is only used in these two routines to define the explicit keys ("%" operator) of the local derived types "trac_type" and "isot_type". It could be in principle used outside this scope to get tracers parameters (read from "tracer.def") or isotopic parameters (read from "isotopes_params.def" - disabled for now).
• The fortran parameters file "iso_params_mod.F90" is introduced so that "tnat" and "alpha_ideal" are defined in a single place but used in several. "ltnat1" is no longer hardcoded but defined with the *.def files parameter "tnat1"
• Few minor changes:
  • use "infotrac_phy" instead of "infotrac" in calfis* because "tracers(:)%isAdvected" is defined in physics only.
  • "isotopes_mod" now ready for several isotopes classes (currently: only H2O)
  • isotopes class name (the name of the parent of the isotopes) is now %name and no longer %parent.
  • improvement of "getKey"

Location:

LMDZ6/trunk/libf/dyn3dmem

Files:

• check_isotopes_loc.F90 (modified) (3 diffs)
• dynetat0_loc.F90 (modified) (7 diffs)
• iniacademic_loc.F90 (modified) (5 diffs)
• qminimum_loc.F (modified) (1 diff)

LMDZ6/trunk/libf/dyn3dmem/check_isotopes_loc.F90

@@ -3 +3 @@
    USE strings_mod, ONLY: maxlen, msg, strIdx, strStack, int2str, real2str
    USE infotrac,    ONLY: nqtot, niso, nphas, isotope, isoCheck, iqIsoPha, isoSelect, &
-                          ntiso, iH2O, nzone, tracers, isoName,  itZonIso, getKey
+                          ntiso, iH2O, nzone, tracers, isoName,  itZonIso
+   USE iso_params_mod, ONLY: tnat_H216O, tnat_H217O, tnat_H218O, tnat_HDO, tnat_HTO
+#ifdef CPP_IOIPSL
+   USE ioipsl,          ONLY: getin
+#else
+   USE ioipsl_getincom, ONLY: getin
+#endif
    IMPLICIT NONE
    include "dimensions.h"
@@ -21 +27 @@
                       deltaDmin =-999.0, &
                       ridicule  = 1e-12
-   INTEGER, SAVE :: iso_eau, iso_HDO, iso_O18, & !--- OpenMP shared variables
-                             iso_O17, iso_HTO
+   INTEGER, SAVE :: iso_eau, iso_HDO, iso_O18, iso_O17, iso_HTO
+!$OMP THREADPRIVATE(iso_eau, iso_HDO, iso_O18, iso_O17, iso_HTO)
+   LOGICAL       :: ltnat1
    LOGICAL, SAVE :: first=.TRUE.
-   LOGICAL, PARAMETER :: tnat1=.TRUE.
 !$OMP THREADPRIVATE(first)
 
@@ -32 +38 @@
    IF(niso == 0)        RETURN                   !--- No isotopes => finished
    IF(first) THEN
-!$OMP MASTER
-      iso_eau = strIdx(isoName,'H216O')
-      iso_HDO = strIdx(isoName,'HDO')
-      iso_O18 = strIdx(isoName,'H218O')
-      iso_O17 = strIdx(isoName,'H217O')
-      iso_HTO = strIdx(isoName,'HTO')
-      if (tnat1) then
-              tnat(:)=1.0
-      else
-         IF(getKey('tnat', tnat)) CALL abort_gcm(modname, 'missing isotopic parameter', 1)
-      endif
-!$OMP END MASTER
-!$OMP BARRIER
+      ltnat1 = .TRUE.; CALL getin('tnateq1', ltnat1)
+      iso_eau = strIdx(isoName,'H216O'); IF(iso_eau /= 0) tnat(iso_eau) = tnat_H216O
+      iso_O17 = strIdx(isoName,'H217O'); IF(iso_O17 /= 0) tnat(iso_O17) = tnat_H217O
+      iso_O18 = strIdx(isoName,'H218O'); IF(iso_O18 /= 0) tnat(iso_O18) = tnat_H218O
+      iso_HDO = strIdx(isoName,'HDO');   IF(iso_HDO /= 0) tnat(iso_HDO) = tnat_HDO
+      iso_HTO = strIdx(isoName,'HTO');   IF(iso_HTO /= 0) tnat(iso_HTO) = tnat_HTO
+      IF(ltnat1) tnat(:) = 1.0
       first = .FALSE.
    END IF

LMDZ6/trunk/libf/dyn3dmem/dynetat0_loc.F90

@@ -7 +7 @@
 !-------------------------------------------------------------------------------
   USE parallel_lmdz
-  USE infotrac,    ONLY: nqtot, tracers, niso, iqIsoPha, iH2O, isoName
+  USE infotrac,    ONLY: nqtot, tracers, niso, iqIsoPha, iH2O, isoName, &
+                         new2oldH2O, newHNO3, oldHNO3
   USE strings_mod, ONLY: maxlen, msg, strStack, real2str, int2str, strIdx
   USE netcdf,      ONLY: NF90_OPEN,  NF90_NOWRITE, NF90_INQUIRE_DIMENSION, NF90_INQ_VARID, &
                          NF90_CLOSE, NF90_GET_VAR, NF90_INQUIRE_VARIABLE,  NF90_NoErr
-  USE readTracFiles_mod, ONLY: new2oldH2O, newHNO3, oldHNO3, getKey
   USE control_mod, ONLY: planet_type
   USE assert_eq_m, ONLY: assert_eq
@@ -20 +20 @@
   USE temps_mod, ONLY: annee_ref, day_ini, day_ref, itau_dyn, start_time
   USE ener_mod, ONLY: etot0,ptot0,ztot0,stot0,ang0
+#ifdef CPP_IOIPSL
+  USE IOIPSL,   ONLY: getin
+#else
+  USE ioipsl_getincom, ONLY: getin
+#endif
+  USE iso_params_mod   ! tnat_* and alpha_ideal_*
 
   IMPLICIT NONE
@@ -47 +53 @@
   REAL,             ALLOCATABLE :: ucov_glo(:,:),    q_glo(:,:), phis_glo(:)
   REAL,             ALLOCATABLE :: teta_glo(:,:)
-  LOGICAL :: lSkip, ll
-  LOGICAL,PARAMETER :: tnat1=.TRUE.
+  LOGICAL :: lSkip, ll, ltnat1
 !-------------------------------------------------------------------------------
   modname="dynetat0_loc"
@@ -158 +163 @@
   ll = NF90_INQ_VARID(fID, 'HNO3tot', vID) /= NF90_NoErr                                 !--- DETECT OLD REPRO start.nc FILE
 #endif
+  ltnat1 = .TRUE.; CALL getin('tnateq1', ltnat1)
   DO iq=1,nqtot
     var = tracers(iq)%name
@@ -173 +179 @@
     !--------------------------------------------------------------------------------------------------------------------------
     ELSE IF(NF90_INQ_VARID(fID, oldVar, vID) == NF90_NoErr) THEN                         !=== TRY WITH ALTERNATE NAME
-      CALL msg('Tracer <'//TRIM(var)//'> is missing => initialized to <'//TRIM(oldVar)//'>', modname)
+      CALL msg('Missing tracer <'//TRIM(var)//'> => initialized to <'//TRIM(oldVar)//'>', modname)
       CALL get_var2(oldVar, q_glo); q(ijb_u:ije_u,:,iq)=q_glo(ijb_u:ije_u,:)
     !--------------------------------------------------------------------------------------------------------------------------
@@ -181 +187 @@
       iqParent = tracers(iq)%iqParent
       IF(tracers(iq)%iso_iZone == 0) THEN
-         if (tnat1) then
-                 tnat=1.0
-                 alpha_ideal=1.0
-                 write(*,*) 'attention dans dynetat0: les alpha_ideal sont a 1'
-         else
-          IF(getKey('tnat', tnat, isoName(iName)) .OR. getKey('alpha', alpha_ideal, isoName(iName))) &
-            CALL abort_gcm(TRIM(modname), 'missing isotopic parameters', 1)
-         endif
-         CALL msg('Tracer <'//TRIM(var)//'> is missing => initialized with a simplified Rayleigh distillation law.', modname)
+         IF(ltnat1) THEN
+            tnat = 1.0
+            alpha_ideal = 1.0
+            CALL msg(' !!!  Beware: alpha_ideal put to 1  !!!', modname)
+         ELSE
+            SELECT CASE(isoName(iName))
+              CASE('H216O'); tnat = tnat_H216O; alpha_ideal = alpha_ideal_H216O
+              CASE('H217O'); tnat = tnat_H217O; alpha_ideal = alpha_ideal_H217O
+              CASE('H218O'); tnat = tnat_H218O; alpha_ideal = alpha_ideal_H218O
+              CASE('HDO');   tnat = tnat_HDO;   alpha_ideal = alpha_ideal_HDO
+              CASE('HTO');   tnat = tnat_HTO;   alpha_ideal = alpha_ideal_HTO
+              CASE DEFAULT; CALL abort_gcm(TRIM(modname),'unknown isotope "'//TRIM(isoName(iName))//'" ; check tracer.def file',1)
+            END SELECT
+         END IF
+         CALL msg('Missing tracer <'//TRIM(var)//'> => initialized with a simplified Rayleigh distillation law.', modname)
          q(ijb_u:ije_u,:,iq) = q(ijb_u:ije_u,:,iqParent)*tnat*(q(ijb_u:ije_u,:,iqParent)/30.e-3)**(alpha_ideal-1.)
          ! Camille 9 mars 2023: point de vigilence: initialisation incohérente
          ! avec celle de xt_ancien dans la physiq.
       ELSE
-         CALL msg('Tracer <'//TRIM(var)//'> is missing => initialized to its parent isotope concentration.', modname)
+         CALL msg('Missing tracer <'//TRIM(var)//'> => initialized to its parent isotope concentration.', modname)
          ! Camille 9 mars 2023: attention!! seuls les tags qui correspondent à
          ! izone=izone_init (définie dans isotrac_mod) sont initialisés comme
@@ -208 +220 @@
     !--------------------------------------------------------------------------------------------------------------------------
     ELSE                                                                                 !=== MISSING: SET TO 0
-      CALL msg('Tracer <'//TRIM(var)//'> is missing => initialized to zero', modname)
+      CALL msg('missing tracer <'//TRIM(var)//'> => initialized to zero', modname)
       q(ijb_u:ije_u,:,iq)=0.
     !--------------------------------------------------------------------------------------------------------------------------

LMDZ6/trunk/libf/dyn3dmem/iniacademic_loc.F90

@@ -5 +5 @@
 
   USE filtreg_mod, ONLY: inifilr
-  USE infotrac,    ONLY: nqtot, niso, iqIsoPha, tracers, getKey, isoName
+  USE infotrac,    ONLY: nqtot, niso, iqIsoPha, tracers, addPhase, isoName
   USE control_mod, ONLY: day_step,planet_type
   use exner_hyb_m, only: exner_hyb
@@ -22 +22 @@
   USE temps_mod, ONLY: annee_ref, day_ini, day_ref
   USE ener_mod, ONLY: etot0,ptot0,ztot0,stot0,ang0
-  USE readTracFiles_mod, ONLY: addPhase
   use netcdf, only : NF90_NOWRITE,NF90_OPEN,NF90_NOERR,NF90_INQ_VARID
   use netcdf, only : NF90_CLOSE, NF90_GET_VAR
+  USE iso_params_mod   ! tnat_* and alpha_ideal_*
 
 
@@ -85 +85 @@
 
   REAL zdtvr, tnat, alpha_ideal
-  LOGICAL,PARAMETER :: tnat1=.true.
+  LOGICAL :: ltnat1
   
   character(len=*),parameter :: modname="iniacademic"
@@ -311 +311 @@
         ! bulk initialization of tracers
         if (planet_type=="earth") then
+           ltnat1 = .TRUE.; CALL getin('tnateq1', ltnat1)
            ! Earth: first two tracers will be water
            do iq=1,nqtot
@@ -324 +325 @@
               iqParent = tracers(iq)%iqParent
               IF(tracers(iq)%iso_iZone == 0) THEN
-                 if (tnat1) then
-                         tnat=1.0
-                         alpha_ideal=1.0
-                         write(*,*) 'Attention dans iniacademic: alpha_ideal=1'
-                 else
-                    IF(getKey('tnat', tnat, isoName(iName)) .OR. getKey('alpha', alpha_ideal, isoName(iName))) &
-                    CALL abort_gcm(TRIM(modname), 'missing isotopic parameters', 1)
-                 endif
+                 IF(ltnat1) THEN
+                    tnat = 1.0
+                    alpha_ideal = 1.0
+                    WRITE(lunout, *) 'In '//TRIM(modname)//': !!!  Beware: alpha_ideal put to 1  !!!'
+                 ELSE
+                    SELECT CASE(isoName(iName))
+                      CASE('H216O'); tnat = tnat_H216O; alpha_ideal = alpha_ideal_H216O
+                      CASE('H217O'); tnat = tnat_H217O; alpha_ideal = alpha_ideal_H217O
+                      CASE('H218O'); tnat = tnat_H218O; alpha_ideal = alpha_ideal_H218O
+                      CASE('HDO');   tnat = tnat_HDO;   alpha_ideal = alpha_ideal_HDO
+                      CASE('HTO');   tnat = tnat_HTO;   alpha_ideal = alpha_ideal_HTO
+                      CASE DEFAULT
+                         CALL abort_gcm(TRIM(modname),'unknown isotope "'//TRIM(isoName(iName))//'" ; check tracer.def file',1)
+                    END SELECT
+                 END IF
                  q(ijb_u:ije_u,:,iq) = q(ijb_u:ije_u,:,iqParent)*tnat*(q(ijb_u:ije_u,:,iqParent)/30.e-3)**(alpha_ideal-1.)
               ELSE !IF(tracers(iq)%iso_iZone == 0) THEN

LMDZ6/trunk/libf/dyn3dmem/qminimum_loc.F

@@ -4 +4 @@
       SUBROUTINE qminimum_loc( q,nqtot,deltap )
       USE parallel_lmdz
-      USE infotrac, ONLY: niso, ntiso, iqIsoPha, tracers, 
+      USE infotrac, ONLY: niso, ntiso, iqIsoPha, tracers, addPhase,
      &                    isoCheck, min_qParent
       USE strings_mod, ONLY: strIdx
-      USE readTracFiles_mod, ONLY: addPhase
       IMPLICIT none
 c