Changeset 3981 for LMDZ6/trunk/libf/phy_common

Timestamp:

Sep 9, 2021, 3:50:44 PM (3 years ago)

Author:

Laurent Fairhead

Message:

Adds a routine 'prt_alerte' to enable developpers to print out informative messages on the first pass through physics
and from the master process only. This can be used to remind oneself of potential problems or further enhancements.
Messages can be differentiated by a 'priority' code 0/1/2 (corresponding to GREEN/ORANGE/RED alerts)
By default, the messages are output in a file called ALERTES.txt but changing the unit number to 6 in the
print_control_mod.F90 file allows you to print out your messages to the screen.

To use you simply need to:

• have this USE statement at the start of your routine:

USE print_control_mod, ONLY: prt_level, lunout, call_alert, prt_alerte

• ensure that the modname variable is defined and contains the name of your routine
• then you just need to add the following lines in your routine wherever you want to ouput your message (preferably not in a do loop)

message='your informative message'
IF (call_alert) CALL prt_alerte(message,modname,CODE)

where

• message is the message to print out
• modname is the routine name
• CODE is an integer representing your priority code (0/1/2)

and you should get messages of the form

ALERTE ROUGE cva_driver! ym missing init, need to have a look by developpers
ALERTE VERTE orosetup_strato! ym correction en attendant mieux

in your output file.

File:

• LMDZ6/trunk/libf/phy_common/print_control_mod.F90 (modified) (3 diffs)

LMDZ6/trunk/libf/phy_common/print_control_mod.F90

@@ -5 +5 @@
   INTEGER,SAVE :: prt_level ! debug output level
   LOGICAL,SAVE :: debug ! flag to specify if in "debug mode"
-!$OMP THREADPRIVATE(lunout,prt_level,debug)
+  LOGICAL,SAVE :: alert_first_call = .TRUE. ! for printing alerts on first call to routine only           
+  LOGICAL,SAVE :: call_alert ! (combination of is_master and alert_first_call for easier use     
+!$OMP THREADPRIVATE(lunout,prt_level,debug, alert_first_call, call_alert)
 
   ! NB: Module variable Initializations done by set_print_control
@@ -15 +17 @@
   SUBROUTINE set_print_control(lunout_,prt_level_,debug_)
   IMPLICIT NONE
-    INTEGER :: lunout_
-    INTEGER :: prt_level_
-    LOGICAL :: debug_
+    INTEGER, INTENT(IN) :: lunout_
+    INTEGER, INTENT(IN) :: prt_level_
+    LOGICAL, INTENT(IN) :: debug_
       
     lunout = lunout_
@@ -25 +27 @@
   END SUBROUTINE set_print_control
 
+  SUBROUTINE prt_alerte(message, modname, niv_alerte)
+    ! Function to print different values of alarms when first encountered
+    ! Meant for informative purposee
+    IMPLICIT NONE
+    ! Arguments:
+    ! message: message to print out
+    ! modname: module/routine name
+    ! niv_alerte: alert level (0/1/2)
+    CHARACTER(LEN=*), INTENT(IN) :: modname
+    CHARACTER(LEN=*) :: message
+    INTEGER :: niv_alerte
+    ! local variables
+    CHARACTER(LEN=7), DIMENSION(0:2) :: alarm_color = (/ 'VERTE  ','ORANGE ','ROUGE  ' /)
+    CHARACTER(LEN=7) :: alarm_couleur
+    INTEGER :: alarm_file=15 ! in case we want/need to print out the special alarms in a separate file     
+
+    IF ( alert_first_call) then
+       IF ( alarm_file .ne. lunout ) THEN
+          OPEN(unit = alarm_file, file = "ALERTES.txt")
+       ENDIF
+    ENDIF
+
+    alarm_couleur = alarm_color(niv_alerte)
+    IF (niv_alerte < 0 .OR. niv_alerte > 3) then
+       message = 'NIVEAU ALERTE INVALIDE  '//message
+       alarm_couleur='NOIRE  '
+    ENDIF
+
+    WRITE(alarm_file, *)' ALERTE ',alarm_couleur, trim(modname),  trim(message)
+    
+  END SUBROUTINE prt_alerte
+
+  
 END MODULE print_control_mod