Changes between Version 8 and Version 9 of 2019WP/ENHANCE-04_AndrewC-reporting

Timestamp:

2019-01-17T13:32:32+01:00 (5 years ago)

Author:

acc

Comment:

--

2019WP/ENHANCE-04_AndrewC-reporting

@@ -13 +13 @@
 
 == Preview 
-'''(version 2 following initial preview by Sebastien ( see his comments below))'''
+'''(version 3 following initial preview by Sebastien ( see his comments below) and tidying up of the existing nn_verbose_level settings to control the icebergs.stat files)'''
 {{{#!box help
 [[Include(wiki:Developers/DevProcess#preview_)]]
@@ -27 +27 @@
 mpp.top.output_XXX     <---- correct this to 4-digits for consistency
 EMPave.dat_XXXX        <---- These are all identical, suppress writing to write-master only
-icebergs.stat_XXXX
+icebergs.stat_XXXX     <---- These should already be controlled by the nn_verbose_level variable; tidy up 
+                             and ensure silent running with nn_verbose_level=0
 }}}
 and possibly others depending on runtime options. One of the 2019 NEMO workplan entries (ENHANCE-04_AndrewC-reporting) plans to introduce more control over the choice of output created but it may be best to introduce the basic structure prior to the v4.0 release. Below is a summary of the overall plans and what can be implemented immediately if there is consensus.
@@ -38 +39 @@
 4. TOP/prtctl_trc.F90 TOP/trcini.F90 TOP/trcstp.F90
 5. OCE/LBC/mppini.F90  OCE/SBC/sbcfwb.F90
-6. sette/sette.sh
+6. Tidy up icb modules so that the existing nn_verbose_level parameter can be used to turn off icebergs.stat files
+7. sette/sette.sh
 }}}
 
@@ -53 +55 @@
 * l_runstat, l_trcstat            Activates production of global stats files. Only a single file of each of these is ever produced.
 * l_oceout, l_layout              Normal operation is to produce a single version of each of these. If true then a version for each area is produced
-* l_mppout, l_mpptrc, l_icbstat   Suppressed if false, otherwise produce a version for each area.
+* l_mppout, l_mpptrc              Suppressed if false, otherwise produce a version for each area.
 * procmin, procmax, procincr      Allow subsetting of areas when producing output in the previous two categories. Default values will ensure all areas report.
 * ptimincr                        Timestep increment for outputting of time step status information less frequently (affects run.stat, tracer.stat and time.step only)
@@ -61 +63 @@
 Index: OCE/IOM/in_out_manager.F90
 ===================================================================
---- OCE/IOM/in_out_manager.F90  (revision 10530)
+--- OCE/IOM/in_out_manager.F90  (revision 10539)
 +++ OCE/IOM/in_out_manager.F90  (working copy)
-@@ -99,6 +99,27 @@
+@@ -99,6 +99,26 @@
     !!                    output monitoring
     !!----------------------------------------------------------------------
@@ -78 +80 @@
 +      LOGICAL :: l_mppout  = .FALSE.  !: Produce/do not produce mpp.output_XXXX files (T/F)
 +      LOGICAL :: l_mpptop  = .FALSE.  !: Produce/do not produce mpp.top.output_XXXX files (T/F)
-+      LOGICAL :: l_icbstat = .FALSE.  !: Produce/do not produce icebergs.stat_XXXX files (T/F)
 +                                      !  Optional subsetting of processor report files
 +                                      !  Default settings of 0/1000000/1 should ensure all areas report.
@@ -92 +93 @@
     INTEGER ::   nn_print         !: level of print (0 no print)
 
-Index: cfgs/SHARED/namelist_ref
-===================================================================
---- cfgs/SHARED/namelist_ref    (revision 10530)
-+++ cfgs/SHARED/namelist_ref    (working copy)
-@@ -1303,7 +1303,19 @@
+Index: ../cfgs/SHARED/namelist_ref
+===================================================================
+--- ../cfgs/SHARED/namelist_ref (revision 10537)
++++ ../cfgs/SHARED/namelist_ref (working copy)
+@@ -1303,7 +1303,18 @@
  !-----------------------------------------------------------------------
  &namctl        !   Control prints                                       (default: OFF)
@@ -109 +110 @@
 +       sn_cfctl%l_mppout  = .FALSE. !
 +       sn_cfctl%l_mpptop  = .FALSE. !
-+       sn_cfctl%l_icbstat = .FALSE. !
 +       sn_cfctl%procmin   = 0       ! Minimum area number for reporting [default:0]
 +       sn_cfctl%procmax   = 1000000 ! Maximum area number for reporting [default:1000000]
@@ -127 +127 @@
 Index: OCE/nemogcm.F90
 ===================================================================
---- OCE/nemogcm.F90     (revision 10530)
+--- OCE/nemogcm.F90     (revision 10539)
 +++ OCE/nemogcm.F90     (working copy)
 @@ -256,8 +256,8 @@
@@ -159 +159 @@
        lwp = (narea == 1) .OR. ln_ctl                        ! control of all listing output print
  
-@@ -503,6 +515,18 @@
+@@ -503,6 +515,17 @@
           WRITE(numout,*) '~~~~~~~~'
           WRITE(numout,*) '   Namelist namctl'
@@ -170 +170 @@
 +         WRITE(numout,*) '                              sn_cfctl%l_mppout  = ', sn_cfctl%l_mppout
 +         WRITE(numout,*) '                              sn_cfctl%l_mpptop  = ', sn_cfctl%l_mpptop
-+         WRITE(numout,*) '                              sn_cfctl%l_icbstat = ', sn_cfctl%l_icbstat
 +         WRITE(numout,*) '                              sn_cfctl%procmin   = ', sn_cfctl%procmin  
 +         WRITE(numout,*) '                              sn_cfctl%procmax   = ', sn_cfctl%procmax  
@@ -178 +177 @@
           WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
           WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
-@@ -649,6 +673,34 @@
+@@ -649,6 +672,33 @@
        !
     END SUBROUTINE nemo_alloc
@@ -207 +206 @@
 +      sn_cfctl%l_mppout  = setto
 +      sn_cfctl%l_mpptop  = setto
-+      sn_cfctl%l_icbstat = setto
 +   END SUBROUTINE nemo_set_cfctl
 +
@@ -428 +426 @@
              CLOSE( inum )
 }}}
-
-''' 6. sette/sette.sh '''
+''' 6. Tidy up icb modules so that the existing nn_verbose_level parameter can be used to turn off icebergs.stat files '''
+
+The icb modules already contain their own mechanism for controlling the verbosity of the icebergs.stat file reporting. This is done via the nn_verbose_level name list parameter which is set to a default value of 1. Output is minimal for nn_verbose_level=0 but is not switched off completely. Thus the icebergs.stat files are always created even when not required. This is particularly annoying at larger processor counts. Only a little work is required to ensure that nn_verbose_level=0 runs silently and does not create the unwanted files:
+
+{{{
+Changes required in:
+OCE/ICB/icbdia.F90
+OCE/ICB/icbdyn.F90
+OCE/ICB/icbini.F90
+OCE/ICB/icblbc.F90
+OCE/ICB/icbstp.F90
+OCE/ICB/icbutl.F90
+}}}
+{{{#!diff
+Index: OCE/ICB/icbdia.F90
+===================================================================
+--- OCE/ICB/icbdia.F90  (revision 10539)
++++ OCE/ICB/icbdia.F90  (working copy)
+@@ -326,8 +326,10 @@
+             CALL report_consistant( 'bot interface','kg','sent',calving_out_net, &
+                &                    'returned',calving_ret_net)
+          ENDIF
+-         WRITE( numicb, '("calved by class = ",i6,20(",",i6))') (nbergs_calved_by_class(ik),ik=1,nclasses)
+-         IF( nspeeding_tickets > 0 )   WRITE( numicb, '("speeding tickets issued = ",i6)') nspeeding_tickets
++         IF (nn_verbose_level > 0) THEN
++            WRITE( numicb, '("calved by class = ",i6,20(",",i6))') (nbergs_calved_by_class(ik),ik=1,nclasses)
++            IF( nspeeding_tickets > 0 )   WRITE( numicb, '("speeding tickets issued = ",i6)') nspeeding_tickets
++         ENDIF
+          !
+          nbergs_start              = nbergs_end
+          stored_start              = stored_end
+@@ -436,11 +438,13 @@
+       IF( kt == nit000 ) THEN
+          stored_start = SUM( berg_grid%stored_ice(:,:,:) )
+          CALL mpp_sum( 'icbdia', stored_start )
+-         WRITE(numicb,'(a,es13.6,a)')   'icb_dia_income: initial stored mass=',stored_start,' kg'
+          !
+          stored_heat_start = SUM( berg_grid%stored_heat(:,:) )
+          CALL mpp_sum( 'icbdia', stored_heat_start )
+-         WRITE(numicb,'(a,es13.6,a)')    'icb_dia_income: initial stored heat=',stored_heat_start,' J'
++         IF (nn_verbose_level > 0) THEN
++            WRITE(numicb,'(a,es13.6,a)')   'icb_dia_income: initial stored mass=',stored_start,' kg'
++            WRITE(numicb,'(a,es13.6,a)')   'icb_dia_income: initial stored heat=',stored_heat_start,' J'
++         ENDIF
+       ENDIF
+       !
+       calving_rcv_net = calving_rcv_net + SUM( berg_grid%calving(:,:) ) * berg_dt
+@@ -514,6 +518,7 @@
+       INTEGER,       INTENT(in), OPTIONAL :: kbergs
+       !!----------------------------------------------------------------------
+       !
++      IF (nn_verbose_level == 0) RETURN
+       IF( PRESENT(kbergs) ) THEN
+          WRITE(numicb,100) cd_budgetstr // ' state:',                                    &
+             &              cd_startstr  // ' start',  pstartval,         cd_budgetunits, &
+@@ -538,6 +543,7 @@
+       REAL(wp),      INTENT(in) :: pstartval, pendval
+       !!----------------------------------------------------------------------
+       !
++      IF (nn_verbose_level == 0) RETURN
+       WRITE(numicb,200) cd_budgetstr // ' check:',                 &
+          &              cd_startstr,    pstartval, cd_budgetunits, &
+          &              cd_endstr,      pendval,   cd_budgetunits, &
+@@ -557,6 +563,7 @@
+       REAL(wp) ::   zval
+       !!----------------------------------------------------------------------
+       !
++      IF (nn_verbose_level == 0) RETURN
+       zval = ( ( pendval - pstartval ) - ( pinval - poutval ) ) /   &
+          &   MAX( 1.e-30, MAX( ABS( pendval - pstartval ) , ABS( pinval - poutval ) ) )
+          !
+@@ -577,6 +584,7 @@
+       INTEGER      , INTENT(in) ::   pstartval, pendval
+       !!----------------------------------------------------------------------
+       !
++      IF (nn_verbose_level == 0) RETURN
+       WRITE(numicb,100) cd_budgetstr // ' state:',           &
+          &              cd_startstr  // ' start', pstartval, &
+          &              cd_endstr    // ' end',   pendval,   &
+@@ -594,6 +602,7 @@
+       INTEGER,       INTENT(in) :: pinval, poutval, pstartval, pendval
+       !!----------------------------------------------------------------------
+       !
++      IF (nn_verbose_level == 0) RETURN
+       WRITE(numicb,200) cd_budgetstr // ' budget:', &
+          &              cd_instr     // ' in',      pinval, &
+          &              cd_outstr    // ' out',     poutval, &
+Index: OCE/ICB/icbdyn.F90
+===================================================================
+--- OCE/ICB/icbdyn.F90  (revision 10539)
++++ OCE/ICB/icbdyn.F90  (working copy)
+@@ -370,10 +370,12 @@
+          ENDIF
+       ENDIF
+       !                                      ! check the speed and acceleration limits
+-      IF( ABS( zuveln ) > pp_vel_lim   .OR. ABS( zvveln ) > pp_vel_lim   )   &
+-         WRITE(numicb,'("pe=",i3,x,a)') narea,'Dump triggered by excessive velocity'
+-      IF( ABS( pax    ) > pp_accel_lim .OR. ABS( pay    ) > pp_accel_lim )   &
+-         WRITE(numicb,'("pe=",i3,x,a)') narea,'Dump triggered by excessive acceleration'
++      IF (nn_verbose_level > 0) THEN
++         IF( ABS( zuveln ) > pp_vel_lim   .OR. ABS( zvveln ) > pp_vel_lim   )   &
++            WRITE(numicb,'("pe=",i3,x,a)') narea,'Dump triggered by excessive velocity'
++         IF( ABS( pax    ) > pp_accel_lim .OR. ABS( pay    ) > pp_accel_lim )   &
++            WRITE(numicb,'("pe=",i3,x,a)') narea,'Dump triggered by excessive acceleration'
++      ENDIF
+       !
+    END SUBROUTINE icb_accel
+ 
+Index: OCE/ICB/icbini.F90
+===================================================================
+--- OCE/ICB/icbini.F90  (revision 10539)
++++ OCE/ICB/icbini.F90  (working copy)
+@@ -77,7 +77,9 @@
+       !                          ! open ascii output file or files for iceberg status information
+       !                          ! note that we choose to do this on all processors since we cannot
+       !                          ! predict where icebergs will be ahead of time
+-      CALL ctl_opn( numicb, 'icebergs.stat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp, narea )
++      IF( nn_verbose_level > 0) THEN
++         CALL ctl_opn( numicb, 'icebergs.stat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp, narea )
++      ENDIF
+ 
+       ! set parameters (mostly from namelist)
+       !
+@@ -240,8 +242,10 @@
+          ENDIF
+          CALL iom_close( inum )                                     ! close file
+          !
+-         WRITE(numicb,*)
+-         WRITE(numicb,*) '          calving read in a file'
++         IF( nn_verbose_level > 0) THEN
++            WRITE(numicb,*)
++            WRITE(numicb,*) '          calving read in a file'
++         ENDIF
+          ALLOCATE( sf_icb(1), STAT=istat1 )         ! Create sf_icb structure (calving)
+          ALLOCATE( sf_icb(1)%fnow(jpi,jpj,1), STAT=istat2 )
+          ALLOCATE( sf_icb(1)%fdta(jpi,jpj,1,2), STAT=istat3 )
+@@ -335,7 +339,9 @@
+       !
+       ibergs = icb_utl_count()
+       CALL mpp_sum('icbini', ibergs)
+-      WRITE(numicb,'(a,i6,a)') 'diamonds, icb_ini_gen: ',ibergs,' were generated'
++      IF( nn_verbose_level > 0) THEN
++         WRITE(numicb,'(a,i6,a)') 'diamonds, icb_ini_gen: ',ibergs,' were generated'
++      ENDIF
+       !
+    END SUBROUTINE icb_ini_gen
+ 
+Index: OCE/ICB/icblbc.F90
+===================================================================
+--- OCE/ICB/icblbc.F90  (revision 10539)
++++ OCE/ICB/icblbc.F90  (working copy)
+@@ -639,7 +639,7 @@
+    
+             zsbergs(0) = narea
+             zsbergs(1) = nicbfldnsend(jn)
+-            !IF ( nicbfldnsend(jn) .GT. 0) write(numicb,*) 'ICB sending ',nicbfldnsend(jn),' to ', ifldproc
++            !IF ( nicbfldnsend(jn) .GT. 0 .AND. nn_verbose_level > 0 ) write(numicb,*) 'ICB sending ',nicbfldnsend(jn),' to ', ifldproc
+             CALL mppsend( 21, zsbergs(0:1), 2, ifldproc-1, nicbfldreq(jn))
+          ENDIF
+          !
+@@ -655,10 +655,10 @@
+             DO jjn = 1,jpni
+              IF( nicbfldproc(jjn) .eq. INT(znbergs(1)) ) EXIT
+             END DO
+-            IF( jjn .GT. jpni ) write(numicb,*) 'ICB ERROR'
++            IF( jjn .GT. jpni .AND. nn_verbose_level > 0 ) write(numicb,*) 'ICB ERROR'
+             nicbfldexpect(jjn) = INT( znbergs(2) )
+-            !IF ( nicbfldexpect(jjn) .GT. 0) write(numicb,*) 'ICB expecting ',nicbfldexpect(jjn),' from ', nicbfldproc(jjn)
+-            !CALL FLUSH(numicb)
++            !IF ( nicbfldexpect(jjn) .GT. 0 .AND. nn_verbose_level > 0 ) write(numicb,*) 'ICB expecting ',nicbfldexpect(jjn),' from ', nicbfldproc(jjn)
++            !IF (nn_verbose_level > 0) CALL FLUSH(numicb)
+          ENDIF
+          !
+       END DO
+@@ -910,7 +910,7 @@
+             DEALLOCATE(old)
+          ENDIF
+          old => new
+-        !WRITE( numicb,*) 'icb_increase_ibuffer',narea,' increased to',inew_size
++         !IF (nn_verbose_level > 0) WRITE( numicb,*) 'icb_increase_ibuffer',narea,' increased to',inew_size
+       ENDIF
+       !
+    END SUBROUTINE icb_increase_ibuffer
+Index: OCE/ICB/icbstp.F90
+===================================================================
+--- OCE/ICB/icbstp.F90  (revision 10539)
++++ OCE/ICB/icbstp.F90  (working copy)
+@@ -162,8 +162,10 @@
+ 
+       IF(lwp) WRITE(numout,'(a,i6)') 'icebergs: icb_end complete', narea
+       !
+-      CALL flush( numicb )
+-      CLOSE( numicb )
++      IF( nn_verbose_level > 0 ) THEN
++         CALL flush( numicb )
++         CLOSE( numicb )
++      ENDIF
+       !
+    END SUBROUTINE icb_end
+ 
+Index: OCE/ICB/icbutl.F90
+===================================================================
+--- OCE/ICB/icbutl.F90  (revision 10539)
++++ OCE/ICB/icbutl.F90  (working copy)
+@@ -624,6 +624,7 @@
+       INTEGER                :: kt      ! timestep number
+       !!----------------------------------------------------------------------
+       !
++      IF (nn_verbose_level == 0) RETURN
+       pt => berg%current_point
+       WRITE(numicb, 9200) kt, berg%number(1), &
+                    pt%xi, pt%yj, pt%lon, pt%lat, pt%uvel, pt%vvel,  &
+@@ -648,6 +649,7 @@
+       TYPE(iceberg), POINTER :: this
+       !!----------------------------------------------------------------------
+       !
++      IF (nn_verbose_level == 0) RETURN
+       this => first_berg
+       IF( ASSOCIATED(this) ) THEN
+          WRITE(numicb,'(a," pe=(",i3,")")' ) cd_label, narea
+}}}
+
+''' 7. sette/sette.sh '''
 
 Finally, once implemented, these changes allow SETTE tests to be run without creating the full set of multiple output files. It is simply a case of replacing all ln_ctl settings like so:
@@ -447 +666 @@
 +    set_namelist namelist_cfg sn_cfctl%l_runstat .true.
 +    set_namelist namelist_cfg sn_cfctl%l_trcstat .true.
++    set_namelist namelist_cfg nn_verbose_level 0
      set_namelist namelist_cfg ln_use_calving .true.
      set_namelist namelist_cfg ln_wave .true.