MODFLOW 6  version 6.7.0.dev0
USGS Modular Hydrologic Model
idmloggermodule::idm_log_var Interface Reference
Collaboration diagram for idmloggermodule::idm_log_var:
Collaboration graph

Private Member Functions

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

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 
)
private
Parameters
[in]p_memdbl scalar
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 218 of file IdmLogger.f90.

219  real(DP), intent(in) :: p_mem !< dbl scalar
220  character(len=*), intent(in) :: varname !< variable name
221  character(len=*), intent(in) :: mempath !< variable memory path
222  integer(I4B), intent(in) :: iout
223  character(len=LINELENGTH) :: description
224  if (iparamlog > 0 .and. iout > 0) then
225  description = 'Double detected'
226  write (iout, '(3x, a, ": ", a, " = ", G0)') &
227  trim(description), trim(varname), p_mem
228  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 
)
private
Parameters
[in]p_mem1d real array
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 233 of file IdmLogger.f90.

234  real(DP), dimension(:), contiguous, intent(in) :: p_mem !< 1d real array
235  character(len=*), intent(in) :: varname !< variable name
236  character(len=*), intent(in) :: mempath !< variable memory path
237  integer(I4B), intent(in) :: iout
238  real(DP) :: min_val, max_val
239  character(len=LINELENGTH) :: description
240  if (iparamlog > 0 .and. iout > 0) then
241  min_val = minval(p_mem)
242  max_val = maxval(p_mem)
243  if (min_val == max_val) then
244  description = 'Double precision 1D constant array detected'
245  write (iout, '(3x, a, ": ", a, " = ", G0)') &
246  trim(description), trim(varname), min_val
247  else
248  description = 'Double precision 1D array detected'
249  write (iout, '(3x, a, ": ", a, a, G0, a, G0)') &
250  trim(description), trim(varname), &
251  ' ranges from ', min_val, ' to ', max_val
252  end if
253  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 
)
private
Parameters
[in]p_mem2d dbl array
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 258 of file IdmLogger.f90.

259  real(DP), dimension(:, :), contiguous, intent(in) :: p_mem !< 2d dbl array
260  character(len=*), intent(in) :: varname !< variable name
261  character(len=*), intent(in) :: mempath !< variable memory path
262  integer(I4B), intent(in) :: iout
263  real(DP) :: min_val, max_val
264  character(len=LINELENGTH) :: description
265  if (iparamlog > 0 .and. iout > 0) then
266  min_val = minval(p_mem)
267  max_val = maxval(p_mem)
268  if (min_val == max_val) then
269  description = 'Double precision 2D constant array detected'
270  write (iout, '(3x, a, ": ", a, " = ", G0)') &
271  trim(description), trim(varname), min_val
272  else
273  description = 'Double precision 2D array detected'
274  write (iout, '(3x, a, ": ", a, a, G0, a, G0)') &
275  trim(description), trim(varname), &
276  ' ranges from ', min_val, ' to ', max_val
277  end if
278  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 
)
private
Parameters
[in]p_mem3d dbl array
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 283 of file IdmLogger.f90.

284  real(DP), dimension(:, :, :), contiguous, intent(in) :: p_mem !< 3d dbl array
285  character(len=*), intent(in) :: varname !< variable name
286  character(len=*), intent(in) :: mempath !< variable memory path
287  integer(I4B), intent(in) :: iout
288  real(DP) :: min_val, max_val
289  character(len=LINELENGTH) :: description
290  if (iparamlog > 0 .and. iout > 0) then
291  min_val = minval(p_mem)
292  max_val = maxval(p_mem)
293  if (min_val == max_val) then
294  description = 'Double precision 3D constant array detected'
295  write (iout, '(3x, a, ": ", a, " = ", G0)') &
296  trim(description), trim(varname), min_val
297  else
298  description = 'Double precision 3D array detected'
299  write (iout, '(3x, a, ": ", a, a, G0, a, G0)') &
300  trim(description), trim(varname), &
301  ' ranges from ', min_val, ' to ', max_val
302  end if
303  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 
)
private
Parameters
[in]p_memint scalar
[in]varnamevariable name
[in]mempathvariable memory path
[in]datatypevariable data type

Definition at line 122 of file IdmLogger.f90.

123  integer(I4B), intent(in) :: p_mem !< int scalar
124  character(len=*), intent(in) :: varname !< variable name
125  character(len=*), intent(in) :: mempath !< variable memory path
126  character(len=*), intent(in) :: datatype !< variable data type
127  integer(I4B), intent(in) :: iout
128  character(len=LINELENGTH) :: description
129  if (iparamlog > 0 .and. iout > 0) then
130  if (datatype == 'KEYWORD') then
131  description = 'Keyword detected'
132  write (iout, '(3x, a, ": ", a)') trim(description), trim(varname)
133  else
134  description = 'Integer detected'
135  write (iout, '(3x, a, ": ", a, " = ", i0)') &
136  trim(description), trim(varname), p_mem
137  end if
138  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 
)
private
Parameters
[in]p_mem1d int array
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 143 of file IdmLogger.f90.

144  integer(I4B), dimension(:), contiguous, intent(in) :: p_mem !< 1d int array
145  character(len=*), intent(in) :: varname !< variable name
146  character(len=*), intent(in) :: mempath !< variable memory path
147  integer(I4B), intent(in) :: iout
148  integer(I4B) :: min_val, max_val
149  character(len=LINELENGTH) :: description
150  if (iparamlog > 0 .and. iout > 0) then
151  min_val = minval(p_mem)
152  max_val = maxval(p_mem)
153  if (min_val == max_val) then
154  description = 'Integer 1D constant array detected'
155  write (iout, '(3x, a, ": ", a, " = ", i0)') &
156  trim(description), trim(varname), min_val
157  else
158  description = 'Integer 1D array detected'
159  write (iout, '(3x, a, ": ", a, a, i0, a, i0)') &
160  trim(description), trim(varname), &
161  ' ranges from ', min_val, ' to ', max_val
162  end if
163  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 
)
private
Parameters
[in]p_mem2d int array
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 168 of file IdmLogger.f90.

169  integer(I4B), dimension(:, :), contiguous, intent(in) :: p_mem !< 2d int array
170  character(len=*), intent(in) :: varname !< variable name
171  character(len=*), intent(in) :: mempath !< variable memory path
172  integer(I4B), intent(in) :: iout
173  integer(I4B) :: min_val, max_val
174  character(len=LINELENGTH) :: description
175  if (iparamlog > 0 .and. iout > 0) then
176  min_val = minval(p_mem)
177  max_val = maxval(p_mem)
178  if (min_val == max_val) then
179  description = 'Integer 2D constant array detected'
180  write (iout, '(3x, a, ": ", a, " = ", i0)') &
181  trim(description), trim(varname), min_val
182  else
183  description = 'Integer 2D array detected'
184  write (iout, '(3x, a, ": ", a, a, i0, a, i0)') &
185  trim(description), trim(varname), &
186  ' ranges from ', min_val, ' to ', max_val
187  end if
188  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 
)
private
Parameters
[in]p_mem3d int array
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 193 of file IdmLogger.f90.

194  integer(I4B), dimension(:, :, :), contiguous, intent(in) :: p_mem !< 3d int array
195  character(len=*), intent(in) :: varname !< variable name
196  character(len=*), intent(in) :: mempath !< variable memory path
197  integer(I4B), intent(in) :: iout
198  integer(I4B) :: min_val, max_val
199  character(len=LINELENGTH) :: description
200  if (iparamlog > 0 .and. iout > 0) then
201  min_val = minval(p_mem)
202  max_val = maxval(p_mem)
203  if (min_val == max_val) then
204  description = 'Integer 3D constant array detected'
205  write (iout, '(3x, a, ": ", a, " = ", i0)') &
206  trim(description), trim(varname), min_val
207  else
208  description = 'Integer 3D array detected'
209  write (iout, '(3x, a, ": ", a, a, i0, a, i0)') &
210  trim(description), trim(varname), &
211  ' ranges from ', min_val, ' to ', max_val
212  end if
213  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 
)
private
Parameters
[in]p_memlogical scalar
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 107 of file IdmLogger.f90.

108  logical(LGP), intent(in) :: p_mem !< logical scalar
109  character(len=*), intent(in) :: varname !< variable name
110  character(len=*), intent(in) :: mempath !< variable memory path
111  integer(I4B), intent(in) :: iout
112  character(len=LINELENGTH) :: description
113  if (iparamlog > 0 .and. iout > 0) then
114  description = 'Logical detected'
115  write (iout, '(3x, a, ": ", a, " = ", l1)') &
116  trim(description), trim(varname), p_mem
117  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 
)
private
Parameters
[in]p_mempointer to str scalar
[in]varnamevariable name
[in]mempathvariable memory path

Definition at line 308 of file IdmLogger.f90.

309  character(len=*), intent(in) :: p_mem !< pointer to str scalar
310  character(len=*), intent(in) :: varname !< variable name
311  character(len=*), intent(in) :: mempath !< variable memory path
312  integer(I4B), intent(in) :: iout
313  character(len=LINELENGTH) :: description
314  if (iparamlog > 0 .and. iout > 0) then
315  description = 'String detected'
316  write (iout, '(3x, a, ": ", a, " = ", a)') &
317  trim(description), trim(varname), trim(p_mem)
318  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 
)
private
Parameters
[in]varnamevariable name
[in]mempathvariable memory path

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  if (iparamlog > 0 .and. iout > 0) then
95  if (is_tas) then
96  write (iout, '(3x, a, ": ", a)') &
97  'Time-array-series controlled dynamic variable detected', trim(varname)
98  else
99  write (iout, '(3x, a, ": ", a)') &
100  'Time-series controlled dynamic variable detected', trim(varname)
101  end if
102  end if

The documentation for this interface was generated from the following file: