[3447] | 1 | !> @file src/inifor_control.f90 |
---|
[2696] | 2 | !------------------------------------------------------------------------------! |
---|
[2718] | 3 | ! This file is part of the PALM model system. |
---|
[2696] | 4 | ! |
---|
[2718] | 5 | ! PALM is free software: you can redistribute it and/or modify it under the |
---|
| 6 | ! terms of the GNU General Public License as published by the Free Software |
---|
| 7 | ! Foundation, either version 3 of the License, or (at your option) any later |
---|
[2696] | 8 | ! version. |
---|
| 9 | ! |
---|
[2718] | 10 | ! PALM is distributed in the hope that it will be useful, but WITHOUT ANY |
---|
| 11 | ! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR |
---|
| 12 | ! A PARTICULAR PURPOSE. See the GNU General Public License for more details. |
---|
[2696] | 13 | ! |
---|
| 14 | ! You should have received a copy of the GNU General Public License along with |
---|
| 15 | ! PALM. If not, see <http://www.gnu.org/licenses/>. |
---|
| 16 | ! |
---|
[3779] | 17 | ! Copyright 2017-2019 Leibniz Universitaet Hannover |
---|
| 18 | ! Copyright 2017-2019 Deutscher Wetterdienst Offenbach |
---|
[2696] | 19 | !------------------------------------------------------------------------------! |
---|
| 20 | ! |
---|
| 21 | ! Current revisions: |
---|
| 22 | ! ----------------- |
---|
| 23 | ! |
---|
| 24 | ! |
---|
| 25 | ! Former revisions: |
---|
| 26 | ! ----------------- |
---|
| 27 | ! $Id: inifor_control.f90 3866 2019-04-05 14:25:01Z schwenkel $ |
---|
[3866] | 28 | ! Use PALM's working precision |
---|
| 29 | ! Renamed run_control -> log_runtime |
---|
| 30 | ! Open log file only once |
---|
| 31 | ! Improved coding style |
---|
| 32 | ! |
---|
| 33 | ! |
---|
| 34 | ! 3785 2019-03-06 10:41:14Z eckhard |
---|
[3678] | 35 | ! Added message buffer for displaying tips to rectify encountered errors |
---|
| 36 | ! |
---|
| 37 | ! |
---|
| 38 | ! 3618 2018-12-10 13:25:22Z eckhard |
---|
[3618] | 39 | ! Prefixed all INIFOR modules with inifor_ |
---|
| 40 | ! |
---|
| 41 | ! |
---|
| 42 | ! 3614 2018-12-10 07:05:46Z raasch |
---|
[3614] | 43 | ! abort renamed inifor_abort to avoid intrinsic problem in Fortran |
---|
| 44 | ! |
---|
| 45 | ! 3557 2018-11-22 16:01:22Z eckhard |
---|
[3557] | 46 | ! Updated documentation |
---|
| 47 | ! |
---|
| 48 | ! |
---|
| 49 | ! 3447 2018-10-29 15:52:54Z eckhard |
---|
[3447] | 50 | ! Renamed source files for compatibilty with PALM build system |
---|
| 51 | ! |
---|
| 52 | ! |
---|
| 53 | ! 3395 2018-10-22 17:32:49Z eckhard |
---|
[3395] | 54 | ! Suppress debugging messages unless --debug option is given |
---|
| 55 | ! |
---|
| 56 | ! |
---|
| 57 | ! 3183 2018-07-27 14:25:55Z suehring |
---|
[3183] | 58 | ! Added version and copyright output |
---|
| 59 | ! |
---|
| 60 | ! |
---|
| 61 | ! 3182 2018-07-27 13:36:03Z suehring |
---|
[2696] | 62 | ! Initial revision |
---|
| 63 | ! |
---|
| 64 | ! |
---|
| 65 | ! |
---|
| 66 | ! Authors: |
---|
| 67 | ! -------- |
---|
[3557] | 68 | !> @author Eckhard Kadasch (Deutscher Wetterdienst, Offenbach) |
---|
[2696] | 69 | ! |
---|
| 70 | ! Description: |
---|
| 71 | ! ------------ |
---|
| 72 | !> The control module provides routines for timing INIFOR and writing runtime |
---|
| 73 | !> feedback to the terminal and a log file. |
---|
| 74 | !------------------------------------------------------------------------------! |
---|
[3618] | 75 | MODULE inifor_control |
---|
[2696] | 76 | |
---|
[3618] | 77 | USE inifor_defs, & |
---|
[3866] | 78 | ONLY: COPYRIGHT, LNAME, LOG_FILE_NAME, VERSION, wp |
---|
[3618] | 79 | USE inifor_util, & |
---|
[2696] | 80 | ONLY: real_to_str, real_to_str_f |
---|
| 81 | |
---|
| 82 | IMPLICIT NONE |
---|
| 83 | |
---|
[3557] | 84 | CHARACTER (LEN=5000) :: message = '' !< log message buffer |
---|
[3678] | 85 | CHARACTER (LEN=5000) :: tip = '' !< optional log message buffer for tips on how to rectify encountered errors |
---|
[3866] | 86 | INTEGER, SAVE :: u !< Fortran file unit for the log file |
---|
[2696] | 87 | |
---|
| 88 | CONTAINS |
---|
| 89 | |
---|
[3557] | 90 | !------------------------------------------------------------------------------! |
---|
| 91 | ! Description: |
---|
| 92 | ! ------------ |
---|
| 93 | !> |
---|
| 94 | !> report() is INIFOR's general logging routine. It prints the given 'message' |
---|
| 95 | !> to the terminal and writes it to the INIFOR log file. |
---|
| 96 | !> |
---|
| 97 | !> You can use this routine to log events across INIFOR's code to log. For |
---|
| 98 | !> warnings and abort messages, you may use the dedicated routines warn() and |
---|
[3614] | 99 | !> inifor_abort() in this module. Both use report() and add specific behaviour |
---|
| 100 | !> to it. |
---|
[3557] | 101 | !------------------------------------------------------------------------------! |
---|
[3866] | 102 | SUBROUTINE report(routine, message, debug) |
---|
[2696] | 103 | |
---|
[3866] | 104 | CHARACTER(LEN=*), INTENT(IN) :: routine !< name of calling subroutine of function |
---|
| 105 | CHARACTER(LEN=*), INTENT(IN) :: message !< log message |
---|
| 106 | LOGICAL, OPTIONAL, INTENT(IN) :: debug !< flag the current message as debugging message |
---|
[2696] | 107 | |
---|
[3866] | 108 | LOGICAL, SAVE :: is_first_run = .TRUE. !< control flag for file opening mode |
---|
| 109 | LOGICAL :: suppress_message !< control falg for additional debugging log |
---|
[2696] | 110 | |
---|
[3866] | 111 | IF ( is_first_run ) THEN |
---|
| 112 | OPEN( NEWUNIT=u, FILE=LOG_FILE_NAME, STATUS='replace' ) |
---|
| 113 | is_first_run = .FALSE. |
---|
| 114 | ENDIF |
---|
| 115 | |
---|
[3557] | 116 | |
---|
[3866] | 117 | suppress_message = .FALSE. |
---|
| 118 | IF ( PRESENT(debug) ) THEN |
---|
| 119 | IF ( .NOT. debug ) suppress_message = .TRUE. |
---|
| 120 | ENDIF |
---|
[2696] | 121 | |
---|
[3866] | 122 | IF ( .NOT. suppress_message ) THEN |
---|
| 123 | PRINT *, "inifor: " // TRIM(message) // " [ " // TRIM(routine) // " ]" |
---|
| 124 | WRITE(u, *) TRIM(message) // " [ " // TRIM(routine) // " ]" |
---|
| 125 | ENDIF |
---|
[3395] | 126 | |
---|
[3866] | 127 | END SUBROUTINE report |
---|
[3395] | 128 | |
---|
[2696] | 129 | |
---|
[3557] | 130 | !------------------------------------------------------------------------------! |
---|
| 131 | ! Description: |
---|
| 132 | ! ------------ |
---|
| 133 | !> |
---|
| 134 | !> warn() prepends "WARNING:" the given 'message' and prints the result to the |
---|
| 135 | !> terminal and writes it to the INIFOR logfile. |
---|
| 136 | !> |
---|
| 137 | !> You can use this routine for messaging issues, that still allow INIFOR to |
---|
| 138 | !> continue. |
---|
| 139 | !------------------------------------------------------------------------------! |
---|
[3866] | 140 | SUBROUTINE warn(routine, message) |
---|
[2696] | 141 | |
---|
[3866] | 142 | CHARACTER(LEN=*), INTENT(IN) :: routine !< name of calling subroutine or function |
---|
| 143 | CHARACTER(LEN=*), INTENT(IN) :: message !< log message |
---|
[2696] | 144 | |
---|
[3866] | 145 | CALL report(routine, "WARNING: " // TRIM(message)) |
---|
[2696] | 146 | |
---|
[3866] | 147 | END SUBROUTINE warn |
---|
[2696] | 148 | |
---|
| 149 | |
---|
[3557] | 150 | !------------------------------------------------------------------------------! |
---|
| 151 | ! Description: |
---|
| 152 | ! ------------ |
---|
| 153 | !> |
---|
[3614] | 154 | !> inifor_abort() prepends "ERROR:" the given 'message' and prints the result to |
---|
| 155 | !> stdout, writes it to the INIFOR logfile, and exits INIFOR. |
---|
[3557] | 156 | !> |
---|
| 157 | !> You can use this routine for messaging issues, that are critical and prevent |
---|
| 158 | !> INIFOR from continueing. |
---|
| 159 | !------------------------------------------------------------------------------! |
---|
[3866] | 160 | SUBROUTINE inifor_abort(routine, message) |
---|
[2696] | 161 | |
---|
[3866] | 162 | CHARACTER(LEN=*), INTENT(IN) :: routine !< name of calling subroutine or function |
---|
| 163 | CHARACTER(LEN=*), INTENT(IN) :: message !< log message |
---|
[2696] | 164 | |
---|
[3866] | 165 | CALL report(routine, "ERROR: " // TRIM(message) // " Stopping.") |
---|
| 166 | CALL close_log |
---|
| 167 | STOP |
---|
[2696] | 168 | |
---|
[3866] | 169 | END SUBROUTINE inifor_abort |
---|
[2696] | 170 | |
---|
| 171 | |
---|
[3866] | 172 | SUBROUTINE close_log() |
---|
| 173 | |
---|
| 174 | CLOSE(u) |
---|
| 175 | |
---|
| 176 | END SUBROUTINE close_log |
---|
| 177 | |
---|
| 178 | |
---|
[3557] | 179 | !------------------------------------------------------------------------------! |
---|
| 180 | ! Description: |
---|
| 181 | ! ------------ |
---|
| 182 | !> |
---|
| 183 | !> print_version() prints the INIFOR version number and copyright notice. |
---|
| 184 | !------------------------------------------------------------------------------! |
---|
[3866] | 185 | SUBROUTINE print_version() |
---|
| 186 | PRINT *, "INIFOR " // VERSION |
---|
| 187 | PRINT *, COPYRIGHT |
---|
| 188 | END SUBROUTINE print_version |
---|
[3182] | 189 | |
---|
| 190 | |
---|
[3557] | 191 | !------------------------------------------------------------------------------! |
---|
| 192 | ! Description: |
---|
| 193 | ! ------------ |
---|
| 194 | !> |
---|
[3866] | 195 | !> log_runtime() measures the run times of various parts of INIFOR and |
---|
[3557] | 196 | !> accumulates them in timing budgets. |
---|
| 197 | !------------------------------------------------------------------------------! |
---|
[3866] | 198 | SUBROUTINE log_runtime(mode, budget) |
---|
[2696] | 199 | |
---|
[3866] | 200 | CHARACTER(LEN=*), INTENT(IN) :: mode !< name of the calling mode |
---|
| 201 | CHARACTER(LEN=*), INTENT(IN) :: budget !< name of the timing budget |
---|
[2696] | 202 | |
---|
[3866] | 203 | REAL(wp), SAVE :: t0 !< begin of timing interval |
---|
| 204 | REAL(wp), SAVE :: t1 !< end of timing interval |
---|
| 205 | REAL(wp), SAVE :: t_comp = 0.0_wp !< computation timing budget |
---|
| 206 | REAL(wp), SAVE :: t_alloc = 0.0_wp !< allocation timing budget |
---|
| 207 | REAL(wp), SAVE :: t_init = 0.0_wp !< initialization timing budget |
---|
| 208 | REAL(wp), SAVE :: t_read = 0.0_wp !< reading timing budget |
---|
| 209 | REAL(wp), SAVE :: t_total = 0.0_wp !< total time |
---|
| 210 | REAL(wp), SAVE :: t_write = 0.0_wp !< writing timing budget |
---|
[2696] | 211 | |
---|
[3866] | 212 | CHARACTER(LEN=*), PARAMETER :: fmt='(F6.2)' !< floating-point output format |
---|
[3557] | 213 | |
---|
| 214 | |
---|
[3866] | 215 | SELECT CASE(TRIM(mode)) |
---|
[2696] | 216 | |
---|
[3866] | 217 | CASE('init') |
---|
| 218 | CALL CPU_TIME(t0) |
---|
[2696] | 219 | |
---|
[3866] | 220 | CASE('time') |
---|
[2696] | 221 | |
---|
[3866] | 222 | CALL CPU_TIME(t1) |
---|
[2696] | 223 | |
---|
[3866] | 224 | SELECT CASE(TRIM(budget)) |
---|
[2696] | 225 | |
---|
[3866] | 226 | CASE('alloc') |
---|
| 227 | t_alloc = t_alloc + t1 - t0 |
---|
[2696] | 228 | |
---|
[3866] | 229 | CASE('init') |
---|
| 230 | t_init = t_init + t1 - t0 |
---|
[2696] | 231 | |
---|
[3866] | 232 | CASE('read') |
---|
| 233 | t_read = t_read + t1 - t0 |
---|
[2696] | 234 | |
---|
[3866] | 235 | CASE('write') |
---|
| 236 | t_write = t_write + t1 - t0 |
---|
[2696] | 237 | |
---|
[3866] | 238 | CASE('comp') |
---|
| 239 | t_comp = t_comp + t1 - t0 |
---|
[2696] | 240 | |
---|
[3866] | 241 | CASE DEFAULT |
---|
| 242 | CALL inifor_abort('log_runtime', "Time Budget '" // TRIM(mode) // "' is not supported.") |
---|
[2696] | 243 | |
---|
[3866] | 244 | END SELECT |
---|
[2696] | 245 | |
---|
[3866] | 246 | t0 = t1 |
---|
[2696] | 247 | |
---|
[3866] | 248 | CASE('report') |
---|
| 249 | t_total = t_init + t_read + t_write + t_comp |
---|
[2696] | 250 | |
---|
[3866] | 251 | CALL report('log_runtime', " *** CPU time ***") |
---|
[2696] | 252 | |
---|
[3866] | 253 | CALL report('log_runtime', "Initialization: " // TRIM( real_to_str( t_init ) ) // & |
---|
| 254 | " s (" // TRIM( real_to_str( 100 * t_init / t_total, fmt ) ) // " %)" ) |
---|
[2696] | 255 | |
---|
[3866] | 256 | CALL report('log_runtime', "(De-)Allocation: " // TRIM( real_to_str( t_alloc ) ) // & |
---|
| 257 | " s (" // TRIM( real_to_str( 100 * t_alloc / t_total, fmt ) ) // " %)" ) |
---|
[2696] | 258 | |
---|
[3866] | 259 | CALL report('log_runtime', "Reading data: " // TRIM( real_to_str( t_read ) ) // & |
---|
| 260 | " s (" // TRIM( real_to_str( 100 * t_read / t_total, fmt ) ) // " %)" ) |
---|
[2696] | 261 | |
---|
[3866] | 262 | CALL report('log_runtime', "Writing data: " // TRIM( real_to_str( t_write ) ) // & |
---|
| 263 | " s (" // TRIM( real_to_str( 100 * t_write / t_total, fmt ) ) // " %)" ) |
---|
[2696] | 264 | |
---|
[3866] | 265 | CALL report('log_runtime', "Computation: " // TRIM( real_to_str( t_comp ) ) // & |
---|
| 266 | " s (" // TRIM( real_to_str( 100 * t_comp / t_total, fmt) ) // " %)" ) |
---|
[2696] | 267 | |
---|
[3866] | 268 | CALL report('log_runtime', "Total: " // TRIM( real_to_str( t_total ) ) // & |
---|
| 269 | " s (" // TRIM( real_to_str( 100 * t_total / t_total, fmt ) ) // " %)") |
---|
[2696] | 270 | |
---|
[3866] | 271 | CASE DEFAULT |
---|
| 272 | CALL inifor_abort('log_runtime', "Mode '" // TRIM(mode) // "' is not supported.") |
---|
[2696] | 273 | |
---|
[3866] | 274 | END SELECT |
---|
[2696] | 275 | |
---|
[3866] | 276 | END SUBROUTINE log_runtime |
---|
[2696] | 277 | |
---|
[3618] | 278 | END MODULE inifor_control |
---|