Back to home page

MITgcm

 
 

    


File indexing completed on 2026-10-14 05:13:16 UTC

view on githubraw file Latest commit 38a53897 on 2026-10-13 21:35:23 UTC
108a00eab9 Ryan*0001 #include "LAYERS_OPTIONS.h"
                0002 
                0003 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
                0004 
                0005       SUBROUTINE LAYERS_READPARMS( myThid )
                0006 
                0007 C     Read LAYERS parameters from data file.
                0008 
                0009       IMPLICIT NONE
                0010 #include "SIZE.h"
                0011 #include "EEPARAMS.h"
                0012 #include "PARAMS.h"
                0013 #include "LAYERS_SIZE.h"
9b89fcf692 antn*0014 #include "LAYERS_P2SHARE.h"
108a00eab9 Ryan*0015 #include "LAYERS.h"
                0016 
                0017 C     INPUT PARAMETERS:
                0018       INTEGER myThid
                0019 
                0020 #ifdef ALLOW_LAYERS
ae4c29e0db Jean*0021 C     === Local variables ===
                0022 C     msgBuf     :: Informational/error message buffer
                0023 C     iUnit      :: Work variable for IO unit number
                0024 C     k          :: index
                0025       CHARACTER*(MAX_LEN_MBUF) msgBuf
                0026       INTEGER iUnit, k, iLa
2c2df907b2 Jean*0027       INTEGER errCount
                0028 
                0029 C--   old pkg/layers parameter setting (only single tracer layers diagnostics):
                0030 C      layers_G :: boundaries of tracer layers
                0031       INTEGER LAYER_nb, layers_kref
                0032       LOGICAL useBOLUS
                0033       _RL layers_G(Nlayers+1)
                0034 
b7411f1a84 Jean*0035 C-    retired parameters:
                0036       _RL layers_taveFreq
                0037 
2c2df907b2 Jean*0038 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
108a00eab9 Ryan*0039 
                0040       NAMELIST /LAYERS_PARM01/
a60f4dd950 Davi*0041      &       layers_G, layers_taveFreq, layers_diagFreq,
406891c1a3 Gael*0042      &       LAYER_nb, layers_kref, useBOLUS, layers_bolus,
38a5389750 Mart*0043      &       layers_useThermo,
406891c1a3 Gael*0044      &       layers_name, layers_bounds, layers_krho
108a00eab9 Ryan*0045 
38a5389750 Mart*0046       _BEGIN_MASTER(myThid)
                0047 C     layers_useThermo (in LAYERS_P2SHARE.h) is also used outside pkg/layers
                0048 C     so needs to be set even if useLayers=F (therefore before the next block)
                0049       layers_useThermo = .FALSE.
                0050       _END_MASTER(myThid)
9b89fcf692 antn*0051 
ae4c29e0db Jean*0052       IF ( .NOT.useLayers ) THEN
                0053 C-    pkg LAYERS is not used
                0054         _BEGIN_MASTER(myThid)
                0055 C-    Track pkg activation status:
                0056 C     print a (weak) warning if data.layers is found
                0057          CALL PACKAGES_UNUSED_MSG( 'useLayers', ' ', ' ' )
                0058         _END_MASTER(myThid)
                0059         RETURN
                0060       ENDIF
108a00eab9 Ryan*0061 
                0062       _BEGIN_MASTER(myThid)
2c2df907b2 Jean*0063       errCount = 0
b7411f1a84 Jean*0064       layers_taveFreq = UNSET_RL
108a00eab9 Ryan*0065 
                0066 C--   Default values for LAYERS
38a5389750 Mart*0067 c     layers_useThermo = .FALSE.
2c2df907b2 Jean*0068       layers_diagFreq = dumpFreq
108a00eab9 Ryan*0069 C     The MNC stuff is not working yet
                0070       layers_MNC = .FALSE.
                0071       layers_MDSIO = .TRUE.
                0072 
406891c1a3 Gael*0073       DO iLa=1,layers_maxNum
                0074         layers_name(iLa) = ' '
                0075         layers_krho(iLa)= 1
20c24d88bc Jean*0076         layers_bolus(iLa) = useGMRedi
406891c1a3 Gael*0077         DO k=1,Nlayers+1
                0078           layers_bounds(k,iLa) = UNSET_RL
                0079         ENDDO
                0080       ENDDO
20c24d88bc Jean*0081 
2c2df907b2 Jean*0082 C--   old params default:
406891c1a3 Gael*0083       LAYER_nb = 0
17ce8d85dd Davi*0084       layers_kref = 1
20c24d88bc Jean*0085       useBOLUS = useGMRedi
2c2df907b2 Jean*0086       DO k=1,Nlayers+1
                0087         layers_G(k) = UNSET_RL
                0088       ENDDO
108a00eab9 Ryan*0089 
                0090       WRITE(msgBuf,'(A)') 'LAYERS_READPARMS: opening data.layers'
                0091       CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
                0092      &                    SQUEEZE_RIGHT , 1)
                0093       CALL OPEN_COPY_DATA_FILE(
                0094      I                     'data.layers', 'LAYERS_READPARMS',
                0095      O                     iUnit,
                0096      I                     myThid )
                0097 
                0098 C     Read parameters from open data file
                0099       READ(UNIT=iUnit,NML=LAYERS_PARM01)
                0100       WRITE(msgBuf,'(A)')
                0101      &    'LAYERS_READPARMS: finished reading data.layers'
                0102       CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
                0103      &    SQUEEZE_RIGHT , 1)
                0104 C     Close the open data file
7a77863887 Mart*0105 #ifdef SINGLE_DISK_IO
108a00eab9 Ryan*0106       CLOSE(iUnit)
7a77863887 Mart*0107 #else
                0108       CLOSE(iUnit,STATUS='DELETE')
                0109 #endif /* SINGLE_DISK_IO */
108a00eab9 Ryan*0110 
2c2df907b2 Jean*0111 C--   Process old params setting (single averaging tracer)
                0112       IF ( LAYER_nb.LT.0 .OR. LAYER_nb.GT.3 ) THEN
                0113         WRITE(msgBuf,'(2A,I2,A,I9)') 'LAYERS_READPARMS: ',
                0114      &    'Invalid LAYER_nb=', LAYER_nb
                0115         CALL PRINT_ERROR( msgBuf, myThid )
                0116         errCount = errCount + 1
                0117       ENDIF
                0118       IF ( LAYER_nb.EQ.0 ) THEN
                0119         IF ( layers_kref.NE.1 )         errCount = errCount + 1
                0120         DO k=1,Nlayers+1
                0121          IF ( layers_G(k).NE.UNSET_RL ) errCount = errCount + 1
                0122         ENDDO
                0123       ELSE
                0124         DO iLa=1,layers_maxNum
                0125          IF ( layers_name(iLa).NE.' ' ) errCount = errCount + 1
                0126          IF ( layers_krho(iLa).NE.1 )   errCount = errCount + 1
                0127          DO k=1,Nlayers+1
                0128           IF ( layers_bounds(k,iLa).NE.UNSET_RL ) errCount = errCount+1
                0129          ENDDO
                0130         ENDDO
                0131 C-    Transfert to new params setting:
                0132         IF ( LAYER_nb.EQ.1 ) layers_name(1) = 'TH '
                0133         IF ( LAYER_nb.EQ.2 ) layers_name(1) = 'SLT'
                0134         IF ( LAYER_nb.EQ.3 ) layers_name(1) = 'RHO'
406891c1a3 Gael*0135         layers_krho(1) = layers_kref
d30f939fae Davi*0136         layers_bolus(1) = useBOLUS
406891c1a3 Gael*0137         DO k=1,Nlayers+1
                0138           layers_bounds(k,1) = layers_G(k)
                0139         ENDDO
2c2df907b2 Jean*0140       ENDIF
                0141       IF ( errCount.GE.1 ) THEN
                0142         WRITE(msgBuf,'(2A)') 'LAYERS_READPARMS: ',
                0143      &    'Cannot mix old params setting (LAYER_nb > 0)'
                0144         CALL PRINT_ERROR( msgBuf, myThid )
                0145         WRITE(msgBuf,'(2A)') 'LAYERS_READPARMS: ',
                0146      &    ' with new params setting (layer_name(#)= ...)'
                0147         CALL PRINT_ERROR( msgBuf, myThid )
                0148         WRITE(msgBuf,'(2A,I4,A)') 'LAYERS_READPARMS: ',
                0149      &    'Detected', errCount,' fatal error/conflict(s)'
                0150         CALL PRINT_ERROR( msgBuf, myThid )
                0151         CALL ALL_PROC_DIE( 0 )
                0152         STOP 'ABNORMAL END: S/R LAYERS_READPARMS'
406891c1a3 Gael*0153       ENDIF
                0154 
b7411f1a84 Jean*0155 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
                0156 
                0157 C--   Check for retired parameters:
                0158       IF ( layers_taveFreq .NE. UNSET_RL ) THEN
                0159         WRITE(msgBuf,'(2A)') 'LAYERS_READPARMS: "layers_taveFreq"',
                0160      &    ' is no longer allowed in file "data.layers"'
                0161         CALL PRINT_ERROR( msgBuf, myThid )
                0162         WRITE(msgBuf,'(2A)') 'LAYERS_READPARMS: ',
                0163      &    ' since "pkg/timeave" has been removed.'
                0164         CALL PRINT_ERROR( msgBuf, myThid )
                0165         errCount = errCount + 1
                0166       ENDIF
                0167 
2c2df907b2 Jean*0168 C--   Set layers_num according to layers_name:
406891c1a3 Gael*0169       DO iLa=1,layers_maxNum
2c2df907b2 Jean*0170         layers_num(iLa) = 0
                0171         IF ( layers_name(iLa).EQ.'TH ' ) layers_num(iLa) = 1
                0172         IF ( layers_name(iLa).EQ.'SLT' ) layers_num(iLa) = 2
                0173         IF ( layers_name(iLa).EQ.'RHO' ) layers_num(iLa) = 3
84f265d4b3 dfer*0174         IF ( layers_name(iLa).EQ.'MSE' ) layers_num(iLa) = 4
2c2df907b2 Jean*0175         IF ( layers_name(iLa).NE.' ' .AND.
                0176      &       layers_num(iLa).EQ.0 ) THEN
                0177           WRITE(msgBuf,'(2A,I2,3A)') 'LAYERS_READPARMS: ',
                0178      &    'invalid layers_name(',iLa,')= "',layers_name(iLa),'"'
                0179           CALL PRINT_ERROR( msgBuf, myThid )
                0180           errCount = errCount + 1
20c24d88bc Jean*0181         ENDIF
                0182 C--   bolus contribution only available if using GMRedi
                0183         layers_bolus(iLa) = layers_bolus(iLa) .AND. useGMRedi
406891c1a3 Gael*0184       ENDDO
20c24d88bc Jean*0185 
406891c1a3 Gael*0186 C--   Make sure the layers_bounds we just read is big enough
                0187       DO iLa=1,layers_maxNum
20c24d88bc Jean*0188        IF ( layers_num(iLa).NE.0 ) THEN
                0189         DO k=1,Nlayers+1
2c2df907b2 Jean*0190          IF ( layers_bounds(k,iLa).EQ.UNSET_RL ) THEN
                0191           WRITE(msgBuf,'(2A,I4,A,I3,A)') 'LAYERS_READPARMS: ',
                0192      &        'No value for layers_bounds(k=',k,', iLa=', iLa, ')'
108a00eab9 Ryan*0193           CALL PRINT_ERROR( msgBuf, myThid )
2c2df907b2 Jean*0194           errCount = errCount + 1
20c24d88bc Jean*0195          ENDIF
                0196         ENDDO
                0197        ENDIF
84f265d4b3 dfer*0198 #ifndef LAYERS_PRHO_REF
                0199        IF ( layers_num(iLa).EQ.3 ) THEN
                0200         WRITE(msgBuf,'(2A,I4)')
                0201      &      'S/R LAYERS_READPARMS: ',
                0202      &      'Layering in density requires to define LAYERS_PRHO_REF'
                0203           CALL PRINT_ERROR( msgBuf, myThid )
                0204           errCount = errCount + 1
                0205        ENDIF
                0206 #endif
                0207 #ifndef LAYERS_MSE
                0208        IF ( layers_num(iLa).EQ.4 ) THEN
                0209         WRITE(msgBuf,'(2A,I4)')
                0210      &      'S/R LAYERS_READPARMS: ',
                0211      &      'Layering in MSE requires to define LAYERS_MSE'
                0212           CALL PRINT_ERROR( msgBuf, myThid )
                0213           errCount = errCount + 1
                0214        ENDIF
                0215 #endif
                0216 C- Check MSE is not used with grey atmosphere nor with fizhi
                0217        IF ( layers_num(iLa).EQ.4 ) THEN
                0218         IF ( useAtm_Phys .OR. useFizhi ) THEN
                0219          WRITE(msgBuf,'(2A,I4)')
                0220      &       'S/R LAYERS_READPARMS: ',
                0221      &       'Layering in MSE only work with Aim_v23'
                0222           CALL PRINT_ERROR( msgBuf, myThid )
                0223           errCount = errCount + 1
                0224         ENDIF
                0225        ENDIF
406891c1a3 Gael*0226       ENDDO
108a00eab9 Ryan*0227 
                0228 C--   Make sure that we locally honor the global MNC on/off flag
                0229       layers_MNC = layers_MNC .AND. useMNC
                0230 #ifndef ALLOW_MNC
                0231 C     Fix to avoid running without getting any output:
                0232       layers_MNC = .FALSE.
                0233 #endif
                0234       layers_MDSIO = (.NOT. layers_MNC) .OR. outputTypesInclusive
                0235 
2c2df907b2 Jean*0236       IF ( errCount.GE.1 ) THEN
                0237         WRITE(msgBuf,'(A,I3,A)')
                0238      &    'LAYERS_READPARMS: detected', errCount,' fatal error(s)'
                0239         CALL PRINT_ERROR( msgBuf, myThid )
                0240         CALL ALL_PROC_DIE( 0 )
                0241         STOP 'ABNORMAL END: S/R LAYERS_READPARMS'
                0242       ENDIF
                0243 
108a00eab9 Ryan*0244       _END_MASTER(myThid)
                0245 
                0246 C--   Everyone else must wait for the parameters to be loaded
                0247       _BARRIER
                0248 
9b89fcf692 antn*0249 #endif /* ALLOW_LAYERS */
108a00eab9 Ryan*0250 
                0251       RETURN
                0252       END