MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
idmloggermodule::idm_log_var Interface Reference
Collaboration diagram for idmloggermodule::idm_log_var:
Collaboration graph

Public Member Functions

subroutine idm_log_var_logical (p_mem, varname, mempath, iout)
 Log type specific information logical.
subroutine idm_log_var_int (p_mem, varname, mempath, datatype, iout)
 Log type specific information integer.
subroutine idm_log_var_int1d (p_mem, varname, mempath, iout)
 Log type specific information int1d.
subroutine idm_log_var_int2d (p_mem, varname, mempath, iout)
 Log type specific information int2d.
subroutine idm_log_var_int3d (p_mem, varname, mempath, iout)
 Log type specific information int3d.
subroutine idm_log_var_dbl (p_mem, varname, mempath, iout)
 Log type specific information double.
subroutine idm_log_var_dbl1d (p_mem, varname, mempath, iout)
 Log type specific information dbl1d.
subroutine idm_log_var_dbl2d (p_mem, varname, mempath, iout)
 Log type specific information dbl2d.
subroutine idm_log_var_dbl3d (p_mem, varname, mempath, iout)
 Log type specific information dbl3d.
subroutine idm_log_var_str (p_mem, varname, mempath, iout)
 Log type specific information str.
subroutine idm_log_var_ts (varname, mempath, iout, is_tas, detail)
 log the period closing message

Detailed Description

Definition at line 24 of file IdmLogger.f90.

Member Function/Subroutine Documentation

◆ idm_log_var_dbl()

subroutine idmloggermodule::idm_log_var::idm_log_var_dbl ( real(dp), intent(in) p_mem,
character(len=*), intent(in) varname,
character(len=*), intent(in) mempath,
integer(i4b), intent(in) iout )
Parameters
[in]p_memdbl scalar
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 232 of file IdmLogger.f90.

233 real(DP), intent(in) :: p_mem !< dbl scalar
234 character(len=*), intent(in) :: varname !< variable name
235 character(len=*), intent(in) :: mempath !< variable memory path
236 integer(I4B), intent(in) :: iout
237 character(len=LINELENGTH) :: description
238 if (iparamlog > 0 .and. iout > 0) then
239 description = 'Double detected'
240 write (iout, '(3x, a, ": ", a, " = ", G0)') &
241 trim(description), trim(varname), p_mem
242 end if

◆ idm_log_var_dbl1d()

subroutine idmloggermodule::idm_log_var::idm_log_var_dbl1d ( real(dp), dimension(:), intent(in), contiguous p_mem,
character(len=*), intent(in) varname,
character(len=*), intent(in) mempath,
integer(i4b), intent(in) iout )
Parameters
[in]p_mem1d real array
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 247 of file IdmLogger.f90.

248 real(DP), dimension(:), contiguous, intent(in) :: p_mem !< 1d real array
249 character(len=*), intent(in) :: varname !< variable name
250 character(len=*), intent(in) :: mempath !< variable memory path
251 integer(I4B), intent(in) :: iout
252 real(DP) :: min_val, max_val
253 character(len=LINELENGTH) :: description
254 if (iparamlog > 0 .and. iout > 0) then
255 min_val = minval(p_mem)
256 max_val = maxval(p_mem)
257 if (min_val == max_val) then
258 description = 'Double precision 1D constant array detected'
259 write (iout, '(3x, a, ": ", a, " = ", G0)') &
260 trim(description), trim(varname), min_val
261 else
262 description = 'Double precision 1D array detected'
263 write (iout, '(3x, a, ": ", a, a, G0, a, G0)') &
264 trim(description), trim(varname), &
265 ' ranges from ', min_val, ' to ', max_val
266 end if
267 end if

◆ idm_log_var_dbl2d()

subroutine idmloggermodule::idm_log_var::idm_log_var_dbl2d ( real(dp), dimension(:, :), intent(in), contiguous p_mem,
character(len=*), intent(in) varname,
character(len=*), intent(in) mempath,
integer(i4b), intent(in) iout )
Parameters
[in]p_mem2d dbl array
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 272 of file IdmLogger.f90.

273 real(DP), dimension(:, :), contiguous, intent(in) :: p_mem !< 2d dbl array
274 character(len=*), intent(in) :: varname !< variable name
275 character(len=*), intent(in) :: mempath !< variable memory path
276 integer(I4B), intent(in) :: iout
277 real(DP) :: min_val, max_val
278 character(len=LINELENGTH) :: description
279 if (iparamlog > 0 .and. iout > 0) then
280 min_val = minval(p_mem)
281 max_val = maxval(p_mem)
282 if (min_val == max_val) then
283 description = 'Double precision 2D constant array detected'
284 write (iout, '(3x, a, ": ", a, " = ", G0)') &
285 trim(description), trim(varname), min_val
286 else
287 description = 'Double precision 2D array detected'
288 write (iout, '(3x, a, ": ", a, a, G0, a, G0)') &
289 trim(description), trim(varname), &
290 ' ranges from ', min_val, ' to ', max_val
291 end if
292 end if

◆ idm_log_var_dbl3d()

subroutine idmloggermodule::idm_log_var::idm_log_var_dbl3d ( real(dp), dimension(:, :, :), intent(in), contiguous p_mem,
character(len=*), intent(in) varname,
character(len=*), intent(in) mempath,
integer(i4b), intent(in) iout )
Parameters
[in]p_mem3d dbl array
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 297 of file IdmLogger.f90.

298 real(DP), dimension(:, :, :), contiguous, intent(in) :: p_mem !< 3d dbl array
299 character(len=*), intent(in) :: varname !< variable name
300 character(len=*), intent(in) :: mempath !< variable memory path
301 integer(I4B), intent(in) :: iout
302 real(DP) :: min_val, max_val
303 character(len=LINELENGTH) :: description
304 if (iparamlog > 0 .and. iout > 0) then
305 min_val = minval(p_mem)
306 max_val = maxval(p_mem)
307 if (min_val == max_val) then
308 description = 'Double precision 3D constant array detected'
309 write (iout, '(3x, a, ": ", a, " = ", G0)') &
310 trim(description), trim(varname), min_val
311 else
312 description = 'Double precision 3D array detected'
313 write (iout, '(3x, a, ": ", a, a, G0, a, G0)') &
314 trim(description), trim(varname), &
315 ' ranges from ', min_val, ' to ', max_val
316 end if
317 end if

◆ idm_log_var_int()

subroutine idmloggermodule::idm_log_var::idm_log_var_int ( integer(i4b), intent(in) p_mem,
character(len=*), intent(in) varname,
character(len=*), intent(in) mempath,
character(len=*), intent(in) datatype,
integer(i4b), intent(in) iout )
Parameters
[in]p_memint scalar
[in]varnamevariable name
[in]mempathvariable memory path
[in]datatypevariable data type

Definition at line 136 of file IdmLogger.f90.

137 integer(I4B), intent(in) :: p_mem !< int scalar
138 character(len=*), intent(in) :: varname !< variable name
139 character(len=*), intent(in) :: mempath !< variable memory path
140 character(len=*), intent(in) :: datatype !< variable data type
141 integer(I4B), intent(in) :: iout
142 character(len=LINELENGTH) :: description
143 if (iparamlog > 0 .and. iout > 0) then
144 if (datatype == 'KEYWORD') then
145 description = 'Keyword detected'
146 write (iout, '(3x, a, ": ", a)') trim(description), trim(varname)
147 else
148 description = 'Integer detected'
149 write (iout, '(3x, a, ": ", a, " = ", i0)') &
150 trim(description), trim(varname), p_mem
151 end if
152 end if

◆ idm_log_var_int1d()

subroutine idmloggermodule::idm_log_var::idm_log_var_int1d ( integer(i4b), dimension(:), intent(in), contiguous p_mem,
character(len=*), intent(in) varname,
character(len=*), intent(in) mempath,
integer(i4b), intent(in) iout )
Parameters
[in]p_mem1d int array
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 157 of file IdmLogger.f90.

158 integer(I4B), dimension(:), contiguous, intent(in) :: p_mem !< 1d int array
159 character(len=*), intent(in) :: varname !< variable name
160 character(len=*), intent(in) :: mempath !< variable memory path
161 integer(I4B), intent(in) :: iout
162 integer(I4B) :: min_val, max_val
163 character(len=LINELENGTH) :: description
164 if (iparamlog > 0 .and. iout > 0) then
165 min_val = minval(p_mem)
166 max_val = maxval(p_mem)
167 if (min_val == max_val) then
168 description = 'Integer 1D constant array detected'
169 write (iout, '(3x, a, ": ", a, " = ", i0)') &
170 trim(description), trim(varname), min_val
171 else
172 description = 'Integer 1D array detected'
173 write (iout, '(3x, a, ": ", a, a, i0, a, i0)') &
174 trim(description), trim(varname), &
175 ' ranges from ', min_val, ' to ', max_val
176 end if
177 end if

◆ idm_log_var_int2d()

subroutine idmloggermodule::idm_log_var::idm_log_var_int2d ( integer(i4b), dimension(:, :), intent(in), contiguous p_mem,
character(len=*), intent(in) varname,
character(len=*), intent(in) mempath,
integer(i4b), intent(in) iout )
Parameters
[in]p_mem2d int array
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 182 of file IdmLogger.f90.

183 integer(I4B), dimension(:, :), contiguous, intent(in) :: p_mem !< 2d int array
184 character(len=*), intent(in) :: varname !< variable name
185 character(len=*), intent(in) :: mempath !< variable memory path
186 integer(I4B), intent(in) :: iout
187 integer(I4B) :: min_val, max_val
188 character(len=LINELENGTH) :: description
189 if (iparamlog > 0 .and. iout > 0) then
190 min_val = minval(p_mem)
191 max_val = maxval(p_mem)
192 if (min_val == max_val) then
193 description = 'Integer 2D constant array detected'
194 write (iout, '(3x, a, ": ", a, " = ", i0)') &
195 trim(description), trim(varname), min_val
196 else
197 description = 'Integer 2D array detected'
198 write (iout, '(3x, a, ": ", a, a, i0, a, i0)') &
199 trim(description), trim(varname), &
200 ' ranges from ', min_val, ' to ', max_val
201 end if
202 end if

◆ idm_log_var_int3d()

subroutine idmloggermodule::idm_log_var::idm_log_var_int3d ( integer(i4b), dimension(:, :, :), intent(in), contiguous p_mem,
character(len=*), intent(in) varname,
character(len=*), intent(in) mempath,
integer(i4b), intent(in) iout )
Parameters
[in]p_mem3d int array
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 207 of file IdmLogger.f90.

208 integer(I4B), dimension(:, :, :), contiguous, intent(in) :: p_mem !< 3d int array
209 character(len=*), intent(in) :: varname !< variable name
210 character(len=*), intent(in) :: mempath !< variable memory path
211 integer(I4B), intent(in) :: iout
212 integer(I4B) :: min_val, max_val
213 character(len=LINELENGTH) :: description
214 if (iparamlog > 0 .and. iout > 0) then
215 min_val = minval(p_mem)
216 max_val = maxval(p_mem)
217 if (min_val == max_val) then
218 description = 'Integer 3D constant array detected'
219 write (iout, '(3x, a, ": ", a, " = ", i0)') &
220 trim(description), trim(varname), min_val
221 else
222 description = 'Integer 3D array detected'
223 write (iout, '(3x, a, ": ", a, a, i0, a, i0)') &
224 trim(description), trim(varname), &
225 ' ranges from ', min_val, ' to ', max_val
226 end if
227 end if

◆ idm_log_var_logical()

subroutine idmloggermodule::idm_log_var::idm_log_var_logical ( logical(lgp), intent(in) p_mem,
character(len=*), intent(in) varname,
character(len=*), intent(in) mempath,
integer(i4b), intent(in) iout )
Parameters
[in]p_memlogical scalar
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 121 of file IdmLogger.f90.

122 logical(LGP), intent(in) :: p_mem !< logical scalar
123 character(len=*), intent(in) :: varname !< variable name
124 character(len=*), intent(in) :: mempath !< variable memory path
125 integer(I4B), intent(in) :: iout
126 character(len=LINELENGTH) :: description
127 if (iparamlog > 0 .and. iout > 0) then
128 description = 'Logical detected'
129 write (iout, '(3x, a, ": ", a, " = ", l1)') &
130 trim(description), trim(varname), p_mem
131 end if

◆ idm_log_var_str()

subroutine idmloggermodule::idm_log_var::idm_log_var_str ( character(len=*), intent(in) p_mem,
character(len=*), intent(in) varname,
character(len=*), intent(in) mempath,
integer(i4b), intent(in) iout )
Parameters
[in]p_mempointer to str scalar
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 322 of file IdmLogger.f90.

323 character(len=*), intent(in) :: p_mem !< pointer to str scalar
324 character(len=*), intent(in) :: varname !< variable name
325 character(len=*), intent(in) :: mempath !< variable memory path
326 integer(I4B), intent(in) :: iout
327 character(len=LINELENGTH) :: description
328 if (iparamlog > 0 .and. iout > 0) then
329 description = 'String detected'
330 write (iout, '(3x, a, ": ", a, " = ", a)') &
331 trim(description), trim(varname), trim(p_mem)
332 end if

◆ idm_log_var_ts()

subroutine idmloggermodule::idm_log_var::idm_log_var_ts ( character(len=*), intent(in) varname,
character(len=*), intent(in) mempath,
integer(i4b), intent(in) iout,
logical(lgp), intent(in) is_tas,
character(len=*), intent(in), optional detail )
Parameters
[in]varnamevariable name
[in]mempathvariable memory path
[in]detailadditional info (ts name or count)

Definition at line 89 of file IdmLogger.f90.

90 character(len=*), intent(in) :: varname !< variable name
91 character(len=*), intent(in) :: mempath !< variable memory path
92 integer(I4B), intent(in) :: iout
93 logical(LGP), intent(in) :: is_tas
94 character(len=*), intent(in), optional :: detail !< additional info (ts name or count)
95 if (iparamlog > 0 .and. iout > 0) then
96 if (is_tas) then
97 if (present(detail)) then
98 write (iout, '(3x, a, ": ", a, " (", a, ")")') &
99 'Time-array-series controlled dynamic variable detected', &
100 trim(varname), trim(detail)
101 else
102 write (iout, '(3x, a, ": ", a)') &
103 'Time-array-series controlled dynamic variable detected', &
104 trim(varname)
105 end if
106 else
107 if (present(detail)) then
108 write (iout, '(3x, a, ": ", a, " (", a, ")")') &
109 'Time-series controlled dynamic variable detected', &
110 trim(varname), trim(detail)
111 else
112 write (iout, '(3x, a, ": ", a)') &
113 'Time-series controlled dynamic variable detected', trim(varname)
114 end if
115 end if
116 end if

The documentation for this interface was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Utilities/Idm/IdmLogger.f90