pkg/monitor/MONITOR.h

1389d71047 Chri*0001 C
7633b97660 Ed H*0002
                0003 CBOP
                0004 C     !ROUTINE: MONITOR.h
                0005
                0006 C     !INTERFACE:
                0007 C     #include "MONITOR.h"
                0008
                0009 C     !DESCRIPTION:
9c41af81f6 Timo*0010 C     Contains the state (parameters) for the "monitor" package.
7633b97660 Ed H*0011 C
                0012 C     Monitor routines (prefixed MON\_) provide a simple set of
                0013 C     utilities for outputting useful runtime diagnostic
                0014 C     information. They use a standard format so that the monitor output
                0015 C     can be parsed offline to help in trouble shooting.
                0016 C
                0017 C     Monitor setup params should be set through appropriate MON\_
                0018 C     routines to ensure that changes are made in a thread-safe fashion.
                0019
                0020 CEOP
1389d71047 Chri*0021
                0022 C--   Monitor head and tail strings
                0023       CHARACTER*(*) mon_head
ba41d6c98e Jean*0024       PARAMETER (   mon_head         = '%MON'     )
1389d71047 Chri*0025       CHARACTER*(*) mon_foot_min
ba41d6c98e Jean*0026       PARAMETER (   mon_foot_min     = '_min'     )
1389d71047 Chri*0027       CHARACTER*(*) mon_foot_max
ba41d6c98e Jean*0028       PARAMETER (   mon_foot_max     = '_max'     )
                0029       CHARACTER*(*) mon_foot_sd
                0030       PARAMETER (   mon_foot_sd      = '_sd'      )
1389d71047 Chri*0031       CHARACTER*(*) mon_foot_mean
ba41d6c98e Jean*0032       PARAMETER (   mon_foot_mean    = '_mean'    )
3eb69c3147 Jean*0033       CHARACTER*(*) mon_foot_volint
ba41d6c98e Jean*0034       PARAMETER (   mon_foot_volint  = '_volint'  )
3eb69c3147 Jean*0035       CHARACTER*(*) mon_foot_volmean
ba41d6c98e Jean*0036       PARAMETER (   mon_foot_volmean = '_volmean' )
3eb69c3147 Jean*0037       CHARACTER*(*) mon_foot_del2
ba41d6c98e Jean*0038       PARAMETER (   mon_foot_del2    = '_del2'    )
ec5f8c35c4 Jean*0039       CHARACTER*(*) mon_foot_vol
ba41d6c98e Jean*0040       PARAMETER (   mon_foot_vol     = '_vol'     )
1389d71047 Chri*0041       CHARACTER*(*) mon_string_none
ba41d6c98e Jean*0042       PARAMETER (   mon_string_none  = 'NONE'     )
1389d71047 Chri*0043
                0044 C--   COMMON /MON_I/ Monitor integer variables
ba41d6c98e Jean*0045 C     mon_ioUnit :: Used to specify the output unit for monitor IO.
                0046 C     mon_prefL  :: Prefix length of current mon_ prefix
1389d71047 Chri*0047       COMMON /MON_I/ mon_ioUnit, mon_prefL
ba41d6c98e Jean*0048       INTEGER mon_ioUnit
1389d71047 Chri*0049       INTEGER mon_prefL
                0050
                0051 C--   COMMON /MON_C/ Monitor character variables
ba41d6c98e Jean*0052 C     mon_pref   :: Prefix used for monitor output
1389d71047 Chri*0053       COMMON /MON_C/ mon_pref
                0054       CHARACTER*(MAX_LEN_MBUF) mon_pref
91672e10e3 Alis*0055
eeca444c33 Jean*0056 C--   COMMON /MON_R/ Monitor real variables
ba41d6c98e Jean*0057 C     monSolutionMaxRange :: Maximum allowed Range for solution
dd92b9a824 Jean*0058 C     mon_trAdvCFL :: Max CFL value (in 3 directions) for tracer advection
                0059       COMMON /MON_R/ monSolutionMaxRange, mon_trAdvCFL
ba41d6c98e Jean*0060       _RL  monSolutionMaxRange
dd92b9a824 Jean*0061       _RL  mon_trAdvCFL(3)
ba41d6c98e Jean*0062
91672e10e3 Alis*0063 C--   COMMON /MON_L/ Monitor logical variables
ba41d6c98e Jean*0064 C     mon_overrideStop :: Allow code to continue even if model state is
                0065 C                         heading out of bounds
eeca444c33 Jean*0066 C     mon_output_AM    :: output Angular momentum
ba41d6c98e Jean*0067 C     mon_write_stdout :: hold True when writing monitor to standard output
                0068 C     mon_write_mnc    :: hold True when writing monitor to MNC file
                0069       COMMON /MON_L/
eeca444c33 Jean*0070      &               mon_output_AM,
8c72169036 Jean*0071      &               mon_write_stdout, mon_write_mnc
ba41d6c98e Jean*0072 c     LOGICAL mon_overrideStop
eeca444c33 Jean*0073       LOGICAL mon_output_AM
8c72169036 Jean*0074       LOGICAL mon_write_stdout, mon_write_mnc
7633b97660 Ed H*0075
357126def9 Ed H*0076 C     File names and time steps
c815342335 Ed H*0077 C     mon_fname    ::  monitor file group name
ba41d6c98e Jean*0078       COMMON /MON_F/
8c72169036 Jean*0079      &     mon_fname
ba41d6c98e Jean*0080       CHARACTER*(MAX_LEN_FNAM) mon_fname
357126def9 Ed H*0081
7633b97660 Ed H*0082 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
                0083
                0084 CEH3 ;;; Local Variables: ***
                0085 CEH3 ;;; mode:fortran ***
                0086 CEH3 ;;; End: ***