suews_ctrl_error.f95 File Reference

Go to the source code of this file.

Functions/Subroutines
subroutine	errorhint (errh, problemfile, value, value2, valuei)

Function/Subroutine Documentation

errorhint()

subroutine errorhint	(	integer	errh,
		character(len=*)	problemfile,
		real(kind(1d0))	value,
		real(kind(1d0))	value2,
		integer	valuei )

Definition at line 1 of file suews_ctrl_error.f95.

   !errh        -- Create a numbered code for the situation so get a unique message to help solve the problem
   !ProblemFile -- Filename where the problem occurs/error message
   !value       -- Error value (real number with correct type)
   !value2      -- Second error value (real number with correct type)
   !valueI      -- Error value (integer)
   ! Last modified -----------------------------------------------------
   ! MH  12 Apr 2017: Error code for stability added
   ! HCW 17 Feb 2017: Write (serious) errors to problems.txt; write warnings to warnings.txt (program continues)
   ! HCW 13 Dec 2016: Tidied up and improved error hints
   ! HCW 25 May 2016: Added warning/error labels to distinguish serious errors (that stop program)
   ! LJ  02 Oct 2014: addition of comments
   ! sg  29 Jul 2014: close (500)
   ! LJ  08 Feb 2013
   !--------------------------------------------------------------------
 
   USE data_in
   USE defaultnotused
   ! USE WhereWhen
 
   IMPLICIT NONE
 
   REAL(KIND(1D0)) :: VALUE, value2
 
   CHARACTER(len=*) :: ProblemFile ! Name of the problem file
   CHARACTER(len=150) :: text1 ! Initialization of text
   ! CHARACTER(len=20)::filename                  !file name for writting out error info
   INTEGER :: errh, ValueI, ValueI2, ValueI3 ! v7,v8 initialised as false, HCW 28/10/2014
   INTEGER, DIMENSION(80) :: ErrhCount = 0 ! Counts each time a error hint is called. Initialise to zero
   ! INTEGER:: WhichFile                            ! Used to switch between 500 for error file, 501 for warnings file
#ifdef wrf
   CHARACTER(len=1024) :: message ! Used to pass through function wrf_debug() by Zhenkun Li, 10/08/2018
#endif
   CHARACTER(len=1024) :: Errmessage
   CHARACTER(len=1024) :: StopMessage ! used to pass error message to  statement; useful to supy_driver, TS 19 Feb 2019
 
   ! TS 16 Jul 2018:
   ! these LOGICAL values should NOT be initialised as  is implied
   ! which will cause cross-assignment in parallel mode and thus subsequent unintentional STOP
   LOGICAL :: v1, v2, v3, v4, v5, v6, v7, v8, v9
   LOGICAL :: flag_continue_on_error
 
   text1 = 'unknown problem' ! Initialization of text
   ! WhichFile = 0 ! Initialization of file code
 
   ! Initialise returnTrue as false (HCW 29/10/2014)
   ! - need to do this in Fortran as values assigned in declarations are not applied
   ! on subsequent calling of the subroutine
   flag_continue_on_error = .false.
   ! Initialise v1-v8 as false
   v1 = .false.
   v2 = .false.
   v3 = .false.
   v4 = .false.
   v5 = .false.
   v6 = .false.
   v7 = .false.
   v8 = .false.
   v9 = .false.
 
   !CALL gen_ProblemsText(ProblemFile)   !Call the subroutine that opens the problem.txt file !Moved below, HCW 17 Feb 2017
 
   !The list of knows possible problems of the code:
   !  text1 is the error message written to the ProblemFile.
   !  v1 -v7 are different possibilities for what numbers will be written out
   !  flag_continue_on_error is true if the model run can continue. (Comment modified by HCW 17/10/2014)
   IF (errh == 1) THEN
      text1 = 'Check value in SUEWS_SiteSelect.txt.'
      v5 = .true.
   ELSEIF (errh == 2) THEN
      text1 = 'Cannot perform disaggregation.'
      v6 = .true.
   ELSEIF (errh == 3) THEN
      text1 = 'Met forcing file should contain only 1 year of data.'
      v1 = .true.
   ELSEIF (errh == 4) THEN
      text1 = 'Rainfall in original met forcing file exceeds intensity threshold.'
      v2 = .true.
      flag_continue_on_error = .true.
      !5
   ELSEIF (errh == 6) THEN
      text1 = 'Value obtained exceeds permitted range, setting to +/-9999 in output file.'
      v1 = .true.
      flag_continue_on_error = .true.
   ELSEIF (errh == 7) THEN
      text1 = 'RA value obtained exceeds permitted range.'
      v1 = .true.
      flag_continue_on_error = .true.
   ELSEIF (errh == 8) THEN
      text1 = 'Check values in SUEWS_WithinGridWaterDist.txt.'
      v1 = .true.
   ELSEIF (errh == 9) THEN
      text1 = 'Check ToRunoff and ToSoilStore values in SUEWS_WithinGridWaterDist.txt.'
      v2 = .true.
   ELSEIF (errh == 10) THEN
      text1 = 'Check values in SUEWS_SiteSelect.txt.'
      v1 = .true.
   ELSEIF (errh == 11) THEN
      text1 = 'File not found.'
      v3 = .true.
      ! 12
   ELSEIF (errh == 13) THEN
      text1 = 'Check met forcing file.'
      v8 = .true.
   ELSEIF (errh == 14) THEN
      text1 = 'Inappropriate value calculated.'
      v1 = .true.
   ELSEIF (errh == 15) THEN
      text1 = 'Check H_Bldgs, H_EveTr and H_DecTr in SUEWS_SiteSelect.txt'
      v2 = .true.
      flag_continue_on_error = .true.
      ! 16
   ELSEIF (errh == 17) THEN
      text1 = 'Problem with (z-zd) and/or z0.'
      v2 = .true.
   ELSEIF (errh == 18) THEN
      text1 = 'Check soil depth relative to soil moisture and capacity.'
      v4 = .true.
   ELSEIF (errh == 19) THEN
      text1 = 'Caution - check range.'
      v4 = .true.
      flag_continue_on_error = .true.
   ELSEIF (errh == 20) THEN
      text1 = ' skip lines, ios_out.'
      v5 = .true.
   ELSEIF (errh == 21) THEN
      text1 = 'Bad input for OHM/AnOHM storage heat flux calculation. Check qn, qn_Sn, qf for issues.'
      v1 = .true.
   ELSEIF (errh == 22) THEN
      text1 = ' QH_observed, QE_observed, QH_choice: '
      v4 = .true.
      flag_continue_on_error = .true.
   ELSEIF (errh == 23) THEN
      text1 = 'CBL-sonde -need to increase size of izm:zmax,izm'
      v5 = .true.
   ELSEIF (errh == 24) THEN
      text1 = 'CBL file problem - opening'
      v8 = .true.
   ELSEIF (errh == 25) THEN
      text1 = 'CBL file problem -- reading sonde data, line:'
      v3 = .true.
   ELSEIF (errh == 26) THEN
      text1 = 'Check that FileCode, FileInputPath and FileOutputPath are specified correctly in RunControl.nml.'
      v8 = .true.
   ELSEIF (errh == 27) THEN
      text1 = 'Problems with Met data -forcing data: variable value, dectime'
      v2 = .true. ! 2 real
   ELSEIF (errh == 28) THEN
      text1 = 'Processing in subroutine indicated has a problem, variables'
      flag_continue_on_error = .true.
      v3 = .true. ! 1 integer
   ELSEIF (errh == 29) THEN
      text1 = 'Processing in subroutine indicated has a problem, time, variables'
      flag_continue_on_error = .true.
      v7 = .true. ! 1 real, 2 integers
   ELSEIF (errh == 30) THEN
      text1 = 'Processing in subroutine indicated has a problem, time, variables'
      ! returntrue=.TRUE.
      v2 = .true. ! 2 real
   ELSEIF (errh == 31) THEN
      text1 = 'Processing in subroutine indicated has a problem, time, variables'
      flag_continue_on_error = .true.
      v1 = .true. ! 1 real
   ELSEIF (errh == 32) THEN
      text1 = 'Model applicable to local scale, z<z0d'
      v2 = .true. ! 2 real
   ELSEIF (errh == 33) THEN
      text1 = 'Number of snow layers too large.'
      v1 = .true. ! 1 real
   ELSEIF (errh == 34) THEN
      text1 = 'Air temperature > 55 C -- will keep running'
      v1 = .true. ! 1 real
      flag_continue_on_error = .true.
   ELSEIF (errh == 35) THEN
      text1 = 'Problems with Met data -forcing data: doy, dectime'
      v2 = .true. ! 2 real
   ELSEIF (errh == 36) THEN
      text1 = 'Problem found in InitialConditions file!'
      v8 = .true.
   ELSEIF (errh == 37) THEN
      text1 = 'Check inputs in InitialConditions file!'
      flag_continue_on_error = .true.
      v2 = .true. !2 real
   ELSEIF (errh == 38) THEN
      text1 = 'H=(qn*0.2)/(avdens*avcp)'
      flag_continue_on_error = .true.
      v1 = .true. !2 real
   ELSEIF (errh == 39) THEN
      text1 = 'Different value of TSTEP needed (300 s recommended). Resolution of forcing data must match TSTEP set in RunControl.'
      v4 = .true. !2 real, 1 int
   ELSEIF (errh == 40) THEN
      text1 = 'SOLWEIG file problem - opening'
      v8 = .true.
   ELSEIF (errh == 41) THEN
      text1 = ' addwaterbody= Error1-- but watersurf=  Error 2'
      v2 = .true. !2 real
   ELSEIF (errh == 42) THEN
      text1 = .OR..OR.'abs(rho_d)<0.001000abs(rho_v)<0.001000abs(rho_d+rho_v)<0.001000) rho_v,rho_d, T'
      flag_continue_on_error = .true.
      v4 = .true. !2 real, temperature as an integer
   ELSEIF (errh == 43) THEN
      text1 = 'Switching Years - will keep running'
      flag_continue_on_error = .true.
      v8 = .true.
   ELSEIF (errh == 44) THEN
      text1 = 'Initial File Name - will keep going'
      flag_continue_on_error = .true.
      v8 = .true.
   ELSEIF (errh == 45) THEN
      text1 = 'Pressure < 900 hPa, Loop Number'
      flag_continue_on_error = .true.
      v5 = .true.
   ELSEIF (errh == 46) THEN
      text1 = 'Pressure < 900 hPa'
      flag_continue_on_error = .true.
      v1 = .true.
   ELSEIF (errh == 47) THEN
      text1 = 'File missing'
      !returntrue = .TRUE.
   ELSEIF (errh == 48) THEN
      text1 = 'Something wrong in the rows of the file'
      !returntrue = .TRUE.
   ELSEIF (errh == 49) THEN
      text1 = 'Problems in saving to InitialConditionsYYYY.nml'
   ELSEIF (errh == 50) THEN
      text1 = 'Wrong number of lines read: nsurf, [-1 EOF; -2 EOR]'
      v1 = .true.
   ELSEIF (errh == 51) THEN
      text1 = 'Problems in opening the file'
      WRITE (*, *) problemfile
   ELSEIF (errh == 52) THEN
      text1 = 'Problems opening the output file.'
   ELSEIF (errh == 53) THEN
      text1 = .and..and.'AH_min=0Ah_slope=0T_Critic=0, AnthropHeatMethod='
      flag_continue_on_error = .true.
      v3 = .true.
   ELSEIF (errh == 54) THEN
      text1 = .and..and.'QF_A=0QF_B=0QF_C=0, AnthropHeatMethod='
      flag_continue_on_error = .true.
      v3 = .true.
   ELSEIF (errh == 55) THEN
      text1 = 'InputmetFormat='
      flag_continue_on_error = .true.
      v3 = .true.
   ELSEIF (errh == 56) THEN
      text1 = 'Check input files against manual (N.B. Case sensitive).'
      v8 = .true.
   ELSEIF (errh == 57) THEN
      text1 = 'not found. Check input files.'
      v1 = .true.
   ELSEIF (errh == 58) THEN
      text1 = 'File header not specified in model code.'
      v8 = .true.
   ELSEIF (errh == 59) THEN
      text1 = 'not found. Check SUEWS_SiteSelect.txt.'
      v6 = .true.
   ELSEIF (errh == 60) THEN
      text1 = 'non-unique code.'
      v1 = .true.
   ELSEIF (errh == 61) THEN
      text1 = 'Check coefficients and drainage equation specified in input files.'
      v4 = .true.
      flag_continue_on_error = .true.
   ELSEIF (errh == 62) THEN
      text1 = 'Problem with soil moisture calculation.'
      v5 = .true.
   ELSEIF (errh == 63) THEN
      text1 = 'Problem with calculation.'
      v1 = .true.
   ELSEIF (errh == 64) THEN
      text1 = 'SUEWS cannot currently handle this many grids.'
      v6 = .true.
   ELSEIF (errh == 65) THEN
      text1 = 'Negative gs calculated! Check suitability of parameters in SUEWS_Conductance.txt.'
      flag_continue_on_error = .true.
      v7 = .true. ! 1 real, 2 integers
   ELSEIF (errh == 66) THEN
      text1 = 'Different number of lines in ESTM forcing and Met forcing files.'
      v6 = .true.
   ELSEIF (errh == 67) THEN
      text1 = 'ESTMClass1 automatically set to 100%.'
      flag_continue_on_error = .true.
      v1 = .true.
   ELSEIF (errh == 68) THEN
      text1 = 'Initial Bowen ratio automatically set to 1.'
      flag_continue_on_error = .true.
      v1 = .true.
   ELSEIF (errh == 69) THEN
      text1 = 'Setting QF_traff to zero. Check input data.'
      flag_continue_on_error = .true.
      v2 = .true.
   ELSEIF (errh == 70) THEN
      text1 = 'Specify profile values between 1 (night) and 2 (day).'
      v8 = .true.
   ELSEIF (errh == 71) THEN
      text1 = 'Check input file SUEWS_Conductance.txt.'
      v3 = .true.
   ELSEIF (errh == 72) THEN
      text1 = 'RunControl.nml: ResolutionFilesOut must be an integer multiple of TSTEP'
      v6 = .true.
   ELSEIF (errh == 73) THEN
      text1 = 'Iteration loop stopped for too stable conditions.'
      ! returnTrue=.TRUE.
      v2 = .true.
   ELSEIF (errh == 74) THEN
      text1 = 'Iteration loop stopped for too unstable conditions.'
      ! returnTrue=.TRUE.
      v2 = .true.
   ELSEIF (errh == 75) THEN
      text1 = 'Invalid value for !'
      ! returnTrue=.TRUE.
      v2 = .true.
   ELSEIF (errh == 76) THEN
      text1 = 'erroneous T2 by RSL!'
      flag_continue_on_error = .false.
      v4 = .true.
   ELSEIF (errh == 77) THEN
      text1 = 'CFL failure in ESTM_ext!' &
              //' dz/k should be < 0.1; ' &
              //'current value dz/k for facet i of surf j in group k is '
 
      flag_continue_on_error = .false.
      v7 = .true.
   END IF
 
   errhcount(errh) = errhcount(errh) + 1 ! Increase error count by 1
   ! PRINT*, 'returnTrue',returnTrue
 
   !---------------------------------------------------------------------
   !This part of the code determines how the error/warning message is written out
   IF (v1) THEN ! 1 real
      WRITE (errmessage, '(a,f9.4)') ' Value: ', VALUE
   ELSEIF (v2) THEN ! 2 real
      WRITE (errmessage, '(a,2f9.4)') ' Values: ', VALUE, value2
   ELSEIF (v3) THEN ! 1 integer
      WRITE (errmessage, '(a,i10)') ' Value: ', valuei
   ELSEIF (v4) THEN ! 2 real, 1 integer
      WRITE (errmessage, '(a,2f12.4,i10)') ' Values: ', VALUE, value2, valuei
   ELSEIF (v5) THEN ! 1 real 1 integer
      WRITE (errmessage, '(a,f9.4,i10)') ' Values: ', VALUE, valuei
   ELSEIF (v6) THEN ! 2 integer
      valuei2 = int(VALUE)
      WRITE (errmessage, '(a,2i10)') ' Values: ', valuei, valuei2
   ELSEIF (v7) THEN ! 1 real, 2 integer
      valuei2 = int(value2)
      WRITE (errmessage, '(a,f9.4,2i10)') ' Values: ', VALUE, valuei2, valuei
   ELSEIF (v8) THEN
      ! no error values
   END IF
 
   ! Write errors (that stop the program) to problems.txt; warnings to warnings.txt
   IF (flag_continue_on_error) THEN
      IF (suppresswarnings == 0) THEN
#ifdef wrf
         WRITE (message, *) 'Warning: ', trim(problemfile)
         CALL wrf_debug(100, message)
         WRITE (message, *) trim(text1)
         CALL wrf_debug(100, message)
         CALL wrf_debug(100, errmessage)
         WRITE (message, '(a,i14)') ' Count: ', errhcount(errh)
         CALL wrf_debug(100, message)
#else
         IF (warningchoice == 0) THEN
            OPEN (501, file='warnings.txt')
            WRITE (*, *) '>>> See warnings.txt for possible issues in the run <<<'
            warningchoice = 1
         ELSE
            OPEN (501, file='warnings.txt', position="append")
         END IF
 
         !Writing of the warnings file
         WRITE (501, *) 'Warning: ', trim(problemfile)
 
         ! write warning info
         WRITE (501, *) trim(text1)
 
         ! write warning codes
         WRITE (501, *) trim(errmessage)
 
         WRITE (501, '(a,i14)') ' Count: ', errhcount(errh)
         CLOSE (501)
#endif
      END IF
 
   ELSE
 
#ifdef wrf
      WRITE (message, *) 'Problem: ', trim(problemfile)
      CALL wrf_debug(100, message)
      WRITE (message, *) 'ERROR! Program stopped: ', trim(text1)
      CALL wrf_debug(100, message)
      CALL wrf_debug(100, errmessage)
      WRITE (message, '(i3)') errh
      CALL wrf_debug(100, message)
      WRITE (message, *) 'ERROR! SUEWS run stopped.'
      CALL wrf_debug(100, message)
      WRITE (message, *) 'fatal error in SUEWS:', trim(text1)
      CALL wrf_error_fatal(message)
#else
      IF (errorchoice == 0) THEN
         OPEN (500, file='problems.txt')
         WRITE (*, *) '>>> See problems.txt for serious issues in the run <<<'
         errorchoice = 1
      ELSE
         OPEN (500, file='problems.txt', position="append")
      END IF
 
      !Writing of the problem file
      WRITE (500, *) 'Problem: ', trim(problemfile)
 
      WRITE (500, *) 'ERROR! Program stopped: ', trim(text1)
 
      ! write error codes
      WRITE (500, *) trim(errmessage)
 
      WRITE (500, '(i3)') errh !Add error code to problems.txt
      WRITE (*, *) 'ERROR! SUEWS run stopped.' !Print message to screen if program stopped
      CLOSE (500)
 
      WRITE (*, *) 'problem: ', trim(problemfile)
      WRITE (*, *) 'See problems.txt for more info.'
      WRITE (stopmessage, *) 'fatal error in SUEWS:'//new_line('A')//trim(text1)
      stop 'Fatal error in SUEWS!'
 
#endif
   END IF
 

References defaultnotused::errorchoice, data_in::suppresswarnings, and defaultnotused::warningchoice.

Referenced by resist_module::aerodynamicresistance(), anohm_module::anohm(), anemsn_module::anthropogenicemissions(), atmmoiststab_module::cal_atmmoist(), atmmoiststab_module::cal_stab(), waterdist_module::cal_water_storage(), bluews_module::cbl(), bluews_module::cbl_initial(), bluews_module::cbl_readinputdata(), codematchanthropogenic(), codematchbiogen(), codematchconductance(), codematchdist(), codematchestm(), codematchestm_class(), codematchirrigation(), codematchnonveg(), codematchohm(), codematchprof(), codematchsnow(), codematchsoil(), codematchveg(), codematchwater(), bluews_module::diff(), metdisagg::disagg_lin(), metdisagg::disaggp_amongn(), metdisagg::disaggp_amongnmult(), metdisagg::disaggregateestm(), metdisagg::disaggregatemet(), waterdist_module::drainage(), inputheadercheck(), meteo::lat_vap(), metread(), bluews_module::nbl(), ohm(), meteo::psyc_const(), meteo::qsatf(), meteo::sat_vap_press_x(), meteo::sat_vap_pressice(), skipheader(), narp_module::smithlambda(), bluews_module::sonde(), meteo::spec_heat_beer(), suews_driver::suews_cal_anthropogenicemission(), suews_driver::suews_cal_anthropogenicemission_dts(), resist_module::suews_cal_roughnessparameters(), resist_module::suews_cal_roughnessparameters_dts(), waterdist_module::suews_cal_soilstate(), waterdist_module::suews_cal_soilstate_dts(), estm_module::suews_getestmdata(), suews_driver::suews_init_qh(), resist_module::surfaceresistance(), and dailystate_module::update_dailystate_day().