MODFLOW 6  version 6.5.0.dev2
MODFLOW 6 Code Documentation
Private Member Functions | List of all members
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 228 of file IdmLogger.f90.

229  real(DP), intent(in) :: p_mem !< dbl scalar
230  character(len=*), intent(in) :: varname !< variable name
231  character(len=*), intent(in) :: mempath !< variable memory path
232  integer(I4B), intent(in) :: iout
233  character(len=LINELENGTH) :: description
234 
235  if (iparamlog > 0 .and. iout > 0) then
236  description = 'Double detected'
237  write (iout, '(3x, a, ": ", a, " = ", G0)') &
238  trim(description), trim(varname), p_mem
239  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 244 of file IdmLogger.f90.

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

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

297  real(DP), dimension(:, :, :), contiguous, intent(in) :: p_mem !< 3d dbl array
298  character(len=*), intent(in) :: varname !< variable name
299  character(len=*), intent(in) :: mempath !< variable memory path
300  integer(I4B), intent(in) :: iout
301  real(DP) :: min_val, max_val
302  character(len=LINELENGTH) :: description
303 
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 
)
private
Parameters
[in]p_memint scalar
[in]varnamevariable name
[in]mempathvariable memory path
[in]datatypevariable data type

Definition at line 128 of file IdmLogger.f90.

129  integer(I4B), intent(in) :: p_mem !< int scalar
130  character(len=*), intent(in) :: varname !< variable name
131  character(len=*), intent(in) :: mempath !< variable memory path
132  character(len=*), intent(in) :: datatype !< variable data type
133  integer(I4B), intent(in) :: iout
134  character(len=LINELENGTH) :: description
135 
136  if (iparamlog > 0 .and. iout > 0) then
137  if (datatype == 'KEYWORD') then
138  description = 'Keyword detected'
139  write (iout, '(3x, a, ": ", a)') trim(description), trim(varname)
140  else
141  description = 'Integer detected'
142  write (iout, '(3x, a, ": ", a, " = ", i0)') &
143  trim(description), trim(varname), p_mem
144  end if
145  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 150 of file IdmLogger.f90.

151  integer(I4B), dimension(:), contiguous, intent(in) :: p_mem !< 1d int array
152  character(len=*), intent(in) :: varname !< variable name
153  character(len=*), intent(in) :: mempath !< variable memory path
154  integer(I4B), intent(in) :: iout
155  integer(I4B) :: min_val, max_val
156  character(len=LINELENGTH) :: description
157 
158  if (iparamlog > 0 .and. iout > 0) then
159  min_val = minval(p_mem)
160  max_val = maxval(p_mem)
161  if (min_val == max_val) then
162  description = 'Integer 1D constant array detected'
163  write (iout, '(3x, a, ": ", a, " = ", i0)') &
164  trim(description), trim(varname), min_val
165  else
166  description = 'Integer 1D array detected'
167  write (iout, '(3x, a, ": ", a, a, i0, a, i0)') &
168  trim(description), trim(varname), &
169  ' ranges from ', min_val, ' to ', max_val
170  end if
171  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 176 of file IdmLogger.f90.

177  integer(I4B), dimension(:, :), contiguous, intent(in) :: p_mem !< 2d int array
178  character(len=*), intent(in) :: varname !< variable name
179  character(len=*), intent(in) :: mempath !< variable memory path
180  integer(I4B), intent(in) :: iout
181  integer(I4B) :: min_val, max_val
182  character(len=LINELENGTH) :: description
183 
184  if (iparamlog > 0 .and. iout > 0) then
185  min_val = minval(p_mem)
186  max_val = maxval(p_mem)
187  if (min_val == max_val) then
188  description = 'Integer 2D constant array detected'
189  write (iout, '(3x, a, ": ", a, " = ", i0)') &
190  trim(description), trim(varname), min_val
191  else
192  description = 'Integer 2D array detected'
193  write (iout, '(3x, a, ": ", a, a, i0, a, i0)') &
194  trim(description), trim(varname), &
195  ' ranges from ', min_val, ' to ', max_val
196  end if
197  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 202 of file IdmLogger.f90.

203  integer(I4B), dimension(:, :, :), contiguous, intent(in) :: p_mem !< 3d int array
204  character(len=*), intent(in) :: varname !< variable name
205  character(len=*), intent(in) :: mempath !< variable memory path
206  integer(I4B), intent(in) :: iout
207  integer(I4B) :: min_val, max_val
208  character(len=LINELENGTH) :: description
209 
210  if (iparamlog > 0 .and. iout > 0) then
211  min_val = minval(p_mem)
212  max_val = maxval(p_mem)
213  if (min_val == max_val) then
214  description = 'Integer 3D constant array detected'
215  write (iout, '(3x, a, ": ", a, " = ", i0)') &
216  trim(description), trim(varname), min_val
217  else
218  description = 'Integer 3D array detected'
219  write (iout, '(3x, a, ": ", a, a, i0, a, i0)') &
220  trim(description), trim(varname), &
221  ' ranges from ', min_val, ' to ', max_val
222  end if
223  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 112 of file IdmLogger.f90.

113  logical(LGP), intent(in) :: p_mem !< logical scalar
114  character(len=*), intent(in) :: varname !< variable name
115  character(len=*), intent(in) :: mempath !< variable memory path
116  integer(I4B), intent(in) :: iout
117  character(len=LINELENGTH) :: description
118 
119  if (iparamlog > 0 .and. iout > 0) then
120  description = 'Logical detected'
121  write (iout, '(3x, a, ": ", a, " = ", l1)') &
122  trim(description), trim(varname), p_mem
123  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 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 
329  if (iparamlog > 0 .and. iout > 0) then
330  description = 'String detected'
331  write (iout, '(3x, a, ": ", a, " = ", a)') &
332  trim(description), trim(varname), trim(p_mem)
333  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 93 of file IdmLogger.f90.

94  character(len=*), intent(in) :: varname !< variable name
95  character(len=*), intent(in) :: mempath !< variable memory path
96  integer(I4B), intent(in) :: iout
97  logical(LGP), intent(in) :: is_tas
98 
99  if (iparamlog > 0 .and. iout > 0) then
100  if (is_tas) then
101  write (iout, '(3x, a, ": ", a)') &
102  'Time-array-series controlled dynamic variable detected', trim(varname)
103  else
104  write (iout, '(3x, a, ": ", a)') &
105  'Time-series controlled dynamic variable detected', trim(varname)
106  end if
107  end if
The documentation for this interface was generated from the following file: