idmloggermodule Module Reference

This module contains the Input Data Model Logger Module. More...

Data Types
interface	idm_log_var
interface	idm_export

Functions/Subroutines
subroutine, public	idm_log_header (component, subcomponent, iout)
	@ brief log a header message More...
subroutine, public	idm_log_close (component, subcomponent, iout)
	@ brief log the closing message More...
subroutine, public	idm_log_period_header (component, iout)
	@ brief log a dynamic header message More...
subroutine, public	idm_log_period_close (iout)
	@ brief log the period closing message More...
subroutine	idm_log_var_ts (varname, mempath, iout, is_tas, detail)
	@ brief log the period closing message More...
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_export_int1d (p_mem, varname, mempath, shapestr, iout)
	Create export file int1d. More...
subroutine	idm_export_int2d (p_mem, varname, mempath, shapestr, iout)
	Create export file int2d. More...
subroutine	idm_export_int3d (p_mem, varname, mempath, shapestr, iout)
	Create export file int3d. More...
subroutine	idm_export_dbl1d (p_mem, varname, mempath, shapestr, iout)
	Create export file dbl1d. More...
subroutine	idm_export_dbl2d (p_mem, varname, mempath, shapestr, iout)
	Create export file dbl2d. More...
subroutine	idm_export_dbl3d (p_mem, varname, mempath, shapestr, iout)
	Create export file dbl3d. More...
integer(i4b) function	distype_export_dim (distype, shapestr, is_layered)
	Set dis type export_dim. More...
integer(i4b) function	create_export_file (varname, mempath, layer, iout)
	Create export file. More...

Detailed Description

This module contains the subroutines for logging messages to the list file as the input data model loads model input.

Function/Subroutine Documentation

create_export_file()

integer(i4b) function idmloggermodule::create_export_file ( character(len=*), intent(in)  varname, character(len=*), intent(in)  mempath, integer(i4b), intent(in)  layer, integer(i4b), intent(in)  iout  )

private

Name formats where l=layer, a=auxiliary, p=period : <comp>-<subcomp>.varname.txt : <comp>-<subcomp>.varname.l<num>.txt : <comp>-<subcomp>.varname.p<num>.txt : <comp>-<subcomp>.varname.a<num>.p<num>.txt

Parameters

[in]	varname	variable name
[in]	mempath	variable memory path

Definition at line 774 of file IdmLogger.f90.

    use constantsmodule, only: lenvarname
    use inputoutputmodule, only: openfile, getunit
    use inputoutputmodule, only: upcase, lowcase
    use memoryhelpermodule, only: create_mem_path, split_mem_path
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    integer(I4B), intent(in) :: layer
    integer(I4B), intent(in) :: iout
    integer(I4B) :: inunit
    character(len=LENCOMPONENTNAME) :: comp, subcomp
    character(len=LINELENGTH) :: filename, suffix
 
    ! split the mempath
    call split_mem_path(mempath, comp, subcomp)
    call lowcase(comp)
    call lowcase(subcomp)
 
    ! build suffix
    suffix = varname
    call lowcase(suffix)
    if (layer > 0) then
      write (suffix, '(a,i0)') trim(suffix)//'.l', layer
    end if
    suffix = trim(suffix)//'.txt'
 
    ! set filename
    filename = trim(comp)//'-'//trim(subcomp)//'.'//trim(suffix)
 
    ! silently create the array file
    inunit = getunit()
    call openfile(inunit, 0, filename, 'EXPORT', filstat_opt='REPLACE')

Here is the call graph for this function:

Here is the caller graph for this function:

distype_export_dim()

integer(i4b) function idmloggermodule::distype_export_dim	(	integer(i4b), intent(in), pointer	distype,
		character(len=*), intent(in)	shapestr,
		logical(lgp), intent(inout)	is_layered
	)

Set the dimension of the export

Parameters

[in]	shapestr	dfn shape string
[in,out]	is_layered	does this data represent layers

Definition at line 720 of file IdmLogger.f90.

    integer(I4B), pointer, intent(in) :: distype
    character(len=*), intent(in) :: shapestr !< dfn shape string
    logical(LGP), intent(inout) :: is_layered !< does this data represent layers
    integer(I4B) :: export_dim
 
    ! initialize is_layered to false
    is_layered = .false.
 
    select case (distype)
    case (dis)
      if (shapestr == 'NODES') then
        export_dim = 3
        is_layered = .true.
      else if (shapestr == 'NCOL NROW NLAY') then
        export_dim = 3
        is_layered = .true.
      else
        export_dim = 1
      end if
    case (disv)
      if (shapestr == 'NODES') then
        export_dim = 2
        is_layered = .true.
      else if (shapestr == 'NCPL NLAY') then
        export_dim = 2
        is_layered = .true.
      else
        export_dim = 1
      end if
    case (dis2d)
      if (shapestr == 'NODES') then
        export_dim = 2
      else if (shapestr == 'NCOL NROW') then
        export_dim = 2
      else
        export_dim = 1
      end if
    case (disu, disv1d)
      export_dim = 1
    case default
      export_dim = 0
    end select

Here is the caller graph for this function:

idm_export_dbl1d()

subroutine idmloggermodule::idm_export_dbl1d	(	real(dp), dimension(:), intent(in), contiguous	p_mem,
		character(len=*), intent(in)	varname,
		character(len=*), intent(in)	mempath,
		character(len=*), intent(in)	shapestr,
		integer(i4b), intent(in)	iout
	)

export layered dbl1d parameters with NODES shape

Parameters

[in]	p_mem	1d dbl array
[in]	varname	variable name
[in]	mempath	variable memory path
[in]	shapestr	dfn shape string

Definition at line 530 of file IdmLogger.f90.

    use memorymanagermodule, only: mem_setptr
    use memoryhelpermodule, only: create_mem_path, split_mem_path
    real(DP), dimension(:), contiguous, intent(in) :: p_mem !< 1d dbl array
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    character(len=*), intent(in) :: shapestr !< dfn shape string
    integer(I4B), intent(in) :: iout
    integer(I4B), dimension(:), pointer, contiguous :: model_shape
    real(DP), dimension(:, :, :), pointer, contiguous :: dbl3d
    real(DP), dimension(:, :), pointer, contiguous :: dbl2d
    integer(I4B), dimension(3) :: dis3d_shape
    integer(I4B), dimension(2) :: dis2d_shape
    integer(I4B), pointer :: distype
    character(LENMEMPATH) :: input_mempath
    character(LENCOMPONENTNAME) :: comp, subcomp
    integer(I4B) :: i, j, k, inunit, export_dim
    logical(LGP) :: is_layered
 
    ! set pointer to DISENUM and MODEL_SHAPE
    call split_mem_path(mempath, comp, subcomp)
    input_mempath = create_mem_path(component=comp, context=idm_context)
    call mem_setptr(distype, 'DISENUM', input_mempath)
    call mem_setptr(model_shape, 'MODEL_SHAPE', input_mempath)
 
    ! set export_dim
    export_dim = distype_export_dim(distype, shapestr, is_layered)
 
    ! create export file(s)
    select case (export_dim)
    case (3)
      ! set reshape array
      dis3d_shape(1) = model_shape(3)
      dis3d_shape(2) = model_shape(2)
      ! allocate and reshape
      dis3d_shape(3) = model_shape(1)
      allocate (dbl3d(dis3d_shape(1), dis3d_shape(2), dis3d_shape(3)))
      dbl3d = reshape(p_mem, dis3d_shape)
      do k = 1, dis3d_shape(3)
        ! write export files 3D array
        inunit = create_export_file(varname, mempath, k, iout)
        do i = 1, model_shape(2)
          write (inunit, '(*(G0.10, " "))') (dbl3d(j, i, k), j=1, &
                                             dis3d_shape(1))
        end do
        close (inunit)
      end do
      ! cleanup
      deallocate (dbl3d)
    case (2)
      ! set reshape array
      dis2d_shape(1) = model_shape(2)
      dis2d_shape(2) = model_shape(1)
      ! allocate and reshape
      allocate (dbl2d(dis2d_shape(1), dis2d_shape(2)))
      dbl2d = reshape(p_mem, dis2d_shape)
      if (is_layered) then
        ! write layered export files 2D array
        do i = 1, dis2d_shape(2)
          inunit = create_export_file(varname, mempath, i, iout)
          write (inunit, '(*(G0.10, " "))') (dbl2d(j, i), j=1, dis2d_shape(1))
          close (inunit)
        end do
      else
        ! write export file 2D array
        inunit = create_export_file(varname, mempath, 0, iout)
        do i = 1, dis2d_shape(2)
          write (inunit, '(*(G0.10, " "))') (dbl2d(j, i), j=1, dis2d_shape(1))
        end do
        close (inunit)
      end if
      ! cleanup
      deallocate (dbl2d)
    case (1)
      ! write export file 1D array
      inunit = create_export_file(varname, mempath, 0, iout)
      write (inunit, '(*(G0.10, " "))') p_mem
      close (inunit)
    case default
      write (errmsg, '(a,i0)') 'EXPORT unsupported dbl1d export_dim=', &
        export_dim
      call store_error(errmsg, .true.)
    end select

idm_export_dbl2d()

subroutine idmloggermodule::idm_export_dbl2d	(	real(dp), dimension(:, :), intent(in), contiguous	p_mem,
		character(len=*), intent(in)	varname,
		character(len=*), intent(in)	mempath,
		character(len=*), intent(in)	shapestr,
		integer(i4b), intent(in)	iout
	)

Parameters

[in]	p_mem	2d dbl array
[in]	varname	variable name
[in]	mempath	variable memory path
[in]	shapestr	dfn shape string

Definition at line 617 of file IdmLogger.f90.

    use memorymanagermodule, only: mem_setptr
    use memoryhelpermodule, only: create_mem_path, split_mem_path
    real(DP), dimension(:, :), contiguous, intent(in) :: p_mem !< 2d dbl array
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    character(len=*), intent(in) :: shapestr !< dfn shape string
    integer(I4B), intent(in) :: iout
    integer(I4B), dimension(:), pointer, contiguous :: model_shape
    integer(I4B), pointer :: distype
    character(LENMEMPATH) :: input_mempath
    character(LENCOMPONENTNAME) :: comp, subcomp
    integer(I4B) :: i, j, inunit, export_dim
    logical(LGP) :: is_layered
 
    ! set pointer to DISENUM
    call split_mem_path(mempath, comp, subcomp)
    input_mempath = create_mem_path(component=comp, context=idm_context)
    call mem_setptr(distype, 'DISENUM', input_mempath)
    call mem_setptr(model_shape, 'MODEL_SHAPE', input_mempath)
 
    ! set export_dim
    export_dim = distype_export_dim(distype, shapestr, is_layered)
 
    select case (export_dim)
    case (1)
      ! write export file 1D array
      inunit = create_export_file(varname, mempath, 0, iout)
      do i = 1, size(p_mem, dim=2)
        write (inunit, '(*(G0.10, " "))') (p_mem(j, i), j=1, size(p_mem, dim=1))
      end do
      close (inunit)
    case (2)
      if (is_layered) then
        ! write layered export files 2D array
        do i = 1, size(p_mem, dim=2)
          inunit = create_export_file(varname, mempath, i, iout)
          write (inunit, '(*(G0.10, " "))') (p_mem(j, i), j=1, size(p_mem, dim=1))
          close (inunit)
        end do
      else
        ! write export file 2D array
        inunit = create_export_file(varname, mempath, 0, iout)
        do i = 1, size(p_mem, dim=2)
          write (inunit, '(*(G0.10, " "))') (p_mem(j, i), j=1, size(p_mem, dim=1))
        end do
        close (inunit)
      end if
    case default
      write (errmsg, '(a,i0)') 'EXPORT unsupported dbl2d export_dim=', &
        export_dim
      call store_error(errmsg, .true.)
    end select

idm_export_dbl3d()

subroutine idmloggermodule::idm_export_dbl3d	(	real(dp), dimension(:, :, :), intent(in), contiguous	p_mem,
		character(len=*), intent(in)	varname,
		character(len=*), intent(in)	mempath,
		character(len=*), intent(in)	shapestr,
		integer(i4b), intent(in)	iout
	)

Parameters

[in]	p_mem	2d dbl array
[in]	varname	variable name
[in]	mempath	variable memory path
[in]	shapestr	dfn shape string

Definition at line 674 of file IdmLogger.f90.

    use memorymanagermodule, only: mem_setptr
    use memoryhelpermodule, only: create_mem_path, split_mem_path
    real(DP), dimension(:, :, :), contiguous, intent(in) :: p_mem !< 2d dbl array
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    character(len=*), intent(in) :: shapestr !< dfn shape string
    integer(I4B), intent(in) :: iout
    integer(I4B), dimension(:), pointer, contiguous :: model_shape
    integer(I4B), pointer :: distype
    character(LENMEMPATH) :: input_mempath
    character(LENCOMPONENTNAME) :: comp, subcomp
    integer(I4B) :: i, j, k, inunit, export_dim
    logical(LGP) :: is_layered
 
    ! set pointer to DISENUM
    call split_mem_path(mempath, comp, subcomp)
    input_mempath = create_mem_path(component=comp, context=idm_context)
    call mem_setptr(distype, 'DISENUM', input_mempath)
    call mem_setptr(model_shape, 'MODEL_SHAPE', input_mempath)
 
    ! set export_dim
    export_dim = distype_export_dim(distype, shapestr, is_layered)
 
    select case (export_dim)
    case (3)
      ! write export files 3D array
      do k = 1, size(p_mem, dim=3)
        inunit = create_export_file(varname, mempath, k, iout)
        do i = 1, size(p_mem, dim=2)
          write (inunit, '(*(G0.10, " "))') (p_mem(j, i, k), j=1, &
                                             size(p_mem, dim=1))
        end do
        close (inunit)
      end do
    case default
      write (errmsg, '(a,i0)') 'EXPORT unsupported dbl3d export_dim=', &
        export_dim
      call store_error(errmsg, .true.)
    end select

idm_export_int1d()

subroutine idmloggermodule::idm_export_int1d ( integer(i4b), dimension(:), intent(in), contiguous  p_mem, character(len=*), intent(in)  varname, character(len=*), intent(in)  mempath, character(len=*), intent(in)  shapestr, integer(i4b), intent(in)  iout  )

private

export layered int1d parameter files

Parameters

[in]	p_mem	1d integer array
[in]	varname	variable name
[in]	mempath	variable memory path
[in]	shapestr	dfn shape string

Definition at line 340 of file IdmLogger.f90.

    use memorymanagermodule, only: mem_setptr
    use memoryhelpermodule, only: create_mem_path, split_mem_path
    integer(I4B), dimension(:), contiguous, intent(in) :: p_mem !< 1d integer array
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    character(len=*), intent(in) :: shapestr !< dfn shape string
    integer(I4B), intent(in) :: iout
    integer(I4B), dimension(:), pointer, contiguous :: model_shape
    integer(I4B), dimension(:, :, :), pointer, contiguous :: int3d
    integer(I4B), dimension(:, :), pointer, contiguous :: int2d
    integer(I4B), dimension(3) :: dis3d_shape
    integer(I4B), dimension(2) :: dis2d_shape
    integer(I4B), pointer :: distype
    character(LENMEMPATH) :: input_mempath
    character(LENCOMPONENTNAME) :: comp, subcomp
    integer(I4B) :: i, j, k, inunit, export_dim
    logical(LGP) :: is_layered
 
    ! set pointer to DISENUM and MODEL_SHAPE
    call split_mem_path(mempath, comp, subcomp)
    input_mempath = create_mem_path(component=comp, context=idm_context)
    call mem_setptr(distype, 'DISENUM', input_mempath)
    call mem_setptr(model_shape, 'MODEL_SHAPE', input_mempath)
 
    ! set export_dim
    export_dim = distype_export_dim(distype, shapestr, is_layered)
 
    ! create export file(s)
    select case (export_dim)
    case (3)
      ! set reshape array
      dis3d_shape(1) = model_shape(3)
      dis3d_shape(2) = model_shape(2)
      dis3d_shape(3) = model_shape(1)
      ! allocate and reshape
      allocate (int3d(dis3d_shape(1), dis3d_shape(2), dis3d_shape(3)))
      int3d = reshape(p_mem, dis3d_shape)
      ! write export files 3D array
      do k = 1, dis3d_shape(3)
        inunit = create_export_file(varname, mempath, k, iout)
        do i = 1, model_shape(2)
          write (inunit, '(*(i0, " "))') (int3d(j, i, k), j=1, &
                                          dis3d_shape(1))
        end do
        close (inunit)
      end do
      ! cleanup
      deallocate (int3d)
    case (2)
      ! set reshape array
      dis2d_shape(1) = model_shape(2)
      dis2d_shape(2) = model_shape(1)
      ! allocate and reshape
      allocate (int2d(dis2d_shape(1), dis2d_shape(2)))
      int2d = reshape(p_mem, dis2d_shape)
      if (is_layered) then
        ! write layered export files 2D array
        do i = 1, dis2d_shape(2)
          inunit = create_export_file(varname, mempath, i, iout)
          write (inunit, '(*(i0, " "))') (int2d(j, i), j=1, dis2d_shape(1))
          close (inunit)
        end do
      else
        ! write export file 2D array
        inunit = create_export_file(varname, mempath, 0, iout)
        do i = 1, dis2d_shape(2)
          write (inunit, '(*(i0, " "))') (int2d(j, i), j=1, dis2d_shape(1))
        end do
        close (inunit)
      end if
      ! cleanup
      deallocate (int2d)
    case (1)
      ! write export file 1D array
      inunit = create_export_file(varname, mempath, 0, iout)
      write (inunit, '(*(i0, " "))') p_mem
      close (inunit)
    case default
      write (errmsg, '(a,i0)') 'EXPORT unsupported int1d export_dim=', &
        export_dim
      call store_error(errmsg, .true.)
    end select

idm_export_int2d()

subroutine idmloggermodule::idm_export_int2d	(	integer(i4b), dimension(:, :), intent(in), contiguous	p_mem,
		character(len=*), intent(in)	varname,
		character(len=*), intent(in)	mempath,
		character(len=*), intent(in)	shapestr,
		integer(i4b), intent(in)	iout
	)

Parameters

[in]	p_mem	2d dbl array
[in]	varname	variable name
[in]	mempath	variable memory path
[in]	shapestr	dfn shape string

Definition at line 427 of file IdmLogger.f90.

    use memorymanagermodule, only: mem_setptr
    use memoryhelpermodule, only: create_mem_path, split_mem_path
    integer(I4B), dimension(:, :), contiguous, intent(in) :: p_mem !< 2d dbl array
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    character(len=*), intent(in) :: shapestr !< dfn shape string
    integer(I4B), intent(in) :: iout
    integer(I4B), dimension(:), pointer, contiguous :: model_shape
    integer(I4B), pointer :: distype
    character(LENMEMPATH) :: input_mempath
    character(LENCOMPONENTNAME) :: comp, subcomp
    integer(I4B) :: i, j, inunit, export_dim
    logical(LGP) :: is_layered
 
    ! set pointer to DISENUM
    call split_mem_path(mempath, comp, subcomp)
    input_mempath = create_mem_path(component=comp, context=idm_context)
    call mem_setptr(distype, 'DISENUM', input_mempath)
    call mem_setptr(model_shape, 'MODEL_SHAPE', input_mempath)
 
    ! set export_dim
    export_dim = distype_export_dim(distype, shapestr, is_layered)
 
    select case (export_dim)
    case (1)
      ! write export file 1D array
      inunit = create_export_file(varname, mempath, 0, iout)
      do i = 1, size(p_mem, dim=2)
        write (inunit, '(*(i0, " "))') (p_mem(j, i), j=1, size(p_mem, dim=1))
      end do
      close (inunit)
    case (2)
      if (is_layered) then
        ! write layered export files 2D array
        do i = 1, size(p_mem, dim=2)
          inunit = create_export_file(varname, mempath, i, iout)
          write (inunit, '(*(i0, " "))') (p_mem(j, i), j=1, size(p_mem, dim=1))
          close (inunit)
        end do
      else
        ! write export file 2D array
        inunit = create_export_file(varname, mempath, 0, iout)
        do i = 1, size(p_mem, dim=2)
          write (inunit, '(*(i0, " "))') (p_mem(j, i), j=1, size(p_mem, dim=1))
        end do
        close (inunit)
      end if
    case default
      write (errmsg, '(a,i0)') 'EXPORT unsupported int2d export_dim=', &
        export_dim
      call store_error(errmsg, .true.)
    end select

idm_export_int3d()

subroutine idmloggermodule::idm_export_int3d	(	integer(i4b), dimension(:, :, :), intent(in), contiguous	p_mem,
		character(len=*), intent(in)	varname,
		character(len=*), intent(in)	mempath,
		character(len=*), intent(in)	shapestr,
		integer(i4b), intent(in)	iout
	)

Parameters

[in]	p_mem	2d dbl array
[in]	varname	variable name
[in]	mempath	variable memory path
[in]	shapestr	dfn shape string

Definition at line 484 of file IdmLogger.f90.

    use memorymanagermodule, only: mem_setptr
    use memoryhelpermodule, only: create_mem_path, split_mem_path
    integer(I4B), dimension(:, :, :), contiguous, intent(in) :: p_mem !< 2d dbl array
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    character(len=*), intent(in) :: shapestr !< dfn shape string
    integer(I4B), intent(in) :: iout
    integer(I4B), dimension(:), pointer, contiguous :: model_shape
    integer(I4B), pointer :: distype
    character(LENMEMPATH) :: input_mempath
    character(LENCOMPONENTNAME) :: comp, subcomp
    integer(I4B) :: i, j, k, inunit, export_dim
    logical(LGP) :: is_layered
 
    ! set pointer to DISENUM
    call split_mem_path(mempath, comp, subcomp)
    input_mempath = create_mem_path(component=comp, context=idm_context)
    call mem_setptr(distype, 'DISENUM', input_mempath)
    call mem_setptr(model_shape, 'MODEL_SHAPE', input_mempath)
 
    ! set export_dim
    export_dim = distype_export_dim(distype, shapestr, is_layered)
 
    select case (export_dim)
    case (3)
      ! write export files 3D array
      do k = 1, size(p_mem, dim=3)
        inunit = create_export_file(varname, mempath, k, iout)
        do i = 1, size(p_mem, dim=2)
          write (inunit, '(*(i0, " "))') (p_mem(j, i, k), j=1, size(p_mem, dim=1))
        end do
        close (inunit)
      end do
    case default
      write (errmsg, '(a,i0)') 'EXPORT unsupported int3d export_dim=', &
        export_dim
      call store_error(errmsg, .true.)
    end select

idm_log_close()

subroutine, public idmloggermodule::idm_log_close	(	character(len=*), intent(in)	component,
		character(len=*), intent(in)	subcomponent,
		integer(i4b), intent(in)	iout
	)

Parameters

[in]	component	component name
[in]	subcomponent	subcomponent name

Definition at line 55 of file IdmLogger.f90.

    character(len=*), intent(in) :: component !< component name
    character(len=*), intent(in) :: subcomponent !< subcomponent name
    integer(I4B), intent(in) :: iout
    if (iparamlog > 0 .and. iout > 0) then
      write (iout, '(1x,a)') 'Loading input complete...'
    end if

Here is the caller graph for this function:

idm_log_header()

subroutine, public idmloggermodule::idm_log_header	(	character(len=*), intent(in)	component,
		character(len=*), intent(in)	subcomponent,
		integer(i4b), intent(in)	iout
	)

Parameters

[in]	component	component name
[in]	subcomponent	subcomponent name

Definition at line 43 of file IdmLogger.f90.

    character(len=*), intent(in) :: component !< component name
    character(len=*), intent(in) :: subcomponent !< subcomponent name
    integer(I4B), intent(in) :: iout
    if (iparamlog > 0 .and. iout > 0) then
      write (iout, '(1x,a)') 'Loading input for '//trim(component)//&
        &'/'//trim(subcomponent)
    end if

Here is the caller graph for this function:

idm_log_period_close()

subroutine, public idmloggermodule::idm_log_period_close

(

integer(i4b), intent(in)

iout

)

Definition at line 78 of file IdmLogger.f90.

    use tdismodule, only: kstp
    integer(I4B), intent(in) :: iout
    if (iparamlog > 0 .and. iout > 0 .and. kstp == 1) then
      !backspace iout
      write (iout, '(1x,a,/)') 'IDP component dynamic load complete...'
    end if

Here is the caller graph for this function:

idm_log_period_header()

subroutine, public idmloggermodule::idm_log_period_header	(	character(len=*), intent(in)	component,
		integer(i4b), intent(in)	iout
	)

Parameters

[in]

component

component name

Definition at line 66 of file IdmLogger.f90.

    use tdismodule, only: kper, kstp
    character(len=*), intent(in) :: component !< component name
    integer(I4B), intent(in) :: iout
    if (iparamlog > 0 .and. iout > 0 .and. kstp == 1) then
      write (iout, '(/1x,a,i0,a)') 'IDP PERIOD ', kper, &
        ' load for component: '//trim(component)
    end if

Here is the caller graph for this function:

idm_log_var_dbl()

subroutine idmloggermodule::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_mem	dbl scalar
[in]	varname	variable name
[in]	mempath	variable memory path

Definition at line 232 of file IdmLogger.f90.

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

idm_log_var_dbl1d()

subroutine idmloggermodule::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_mem	1d real array
[in]	varname	variable name
[in]	mempath	variable memory path

Definition at line 247 of file IdmLogger.f90.

    real(DP), dimension(:), contiguous, intent(in) :: p_mem !< 1d real array
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    integer(I4B), intent(in) :: iout
    real(DP) :: min_val, max_val
    character(len=LINELENGTH) :: description
    if (iparamlog > 0 .and. iout > 0) then
      min_val = minval(p_mem)
      max_val = maxval(p_mem)
      if (min_val == max_val) then
        description = 'Double precision 1D constant array detected'
        write (iout, '(3x, a, ": ", a, " = ", G0)') &
          trim(description), trim(varname), min_val
      else
        description = 'Double precision 1D array detected'
        write (iout, '(3x, a, ": ", a, a, G0, a, G0)') &
          trim(description), trim(varname), &
          ' ranges from ', min_val, ' to ', max_val
      end if
    end if

idm_log_var_dbl2d()

subroutine idmloggermodule::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_mem	2d dbl array
[in]	varname	variable name
[in]	mempath	variable memory path

Definition at line 272 of file IdmLogger.f90.

    real(DP), dimension(:, :), contiguous, intent(in) :: p_mem !< 2d dbl array
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    integer(I4B), intent(in) :: iout
    real(DP) :: min_val, max_val
    character(len=LINELENGTH) :: description
    if (iparamlog > 0 .and. iout > 0) then
      min_val = minval(p_mem)
      max_val = maxval(p_mem)
      if (min_val == max_val) then
        description = 'Double precision 2D constant array detected'
        write (iout, '(3x, a, ": ", a, " = ", G0)') &
          trim(description), trim(varname), min_val
      else
        description = 'Double precision 2D array detected'
        write (iout, '(3x, a, ": ", a, a, G0, a, G0)') &
          trim(description), trim(varname), &
          ' ranges from ', min_val, ' to ', max_val
      end if
    end if

idm_log_var_dbl3d()

subroutine idmloggermodule::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_mem	3d dbl array
[in]	varname	variable name
[in]	mempath	variable memory path

Definition at line 297 of file IdmLogger.f90.

    real(DP), dimension(:, :, :), contiguous, intent(in) :: p_mem !< 3d dbl array
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    integer(I4B), intent(in) :: iout
    real(DP) :: min_val, max_val
    character(len=LINELENGTH) :: description
    if (iparamlog > 0 .and. iout > 0) then
      min_val = minval(p_mem)
      max_val = maxval(p_mem)
      if (min_val == max_val) then
        description = 'Double precision 3D constant array detected'
        write (iout, '(3x, a, ": ", a, " = ", G0)') &
          trim(description), trim(varname), min_val
      else
        description = 'Double precision 3D array detected'
        write (iout, '(3x, a, ": ", a, a, G0, a, G0)') &
          trim(description), trim(varname), &
          ' ranges from ', min_val, ' to ', max_val
      end if
    end if

idm_log_var_int()

subroutine idmloggermodule::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_mem	int scalar
[in]	varname	variable name
[in]	mempath	variable memory path
[in]	datatype	variable data type

Definition at line 136 of file IdmLogger.f90.

    integer(I4B), intent(in) :: p_mem !< int scalar
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    character(len=*), intent(in) :: datatype !< variable data type
    integer(I4B), intent(in) :: iout
    character(len=LINELENGTH) :: description
    if (iparamlog > 0 .and. iout > 0) then
      if (datatype == 'KEYWORD') then
        description = 'Keyword detected'
        write (iout, '(3x, a, ": ", a)') trim(description), trim(varname)
      else
        description = 'Integer detected'
        write (iout, '(3x, a, ": ", a, " = ", i0)') &
          trim(description), trim(varname), p_mem
      end if
    end if

idm_log_var_int1d()

subroutine idmloggermodule::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_mem	1d int array
[in]	varname	variable name
[in]	mempath	variable memory path

Definition at line 157 of file IdmLogger.f90.

    integer(I4B), dimension(:), contiguous, intent(in) :: p_mem !< 1d int array
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    integer(I4B), intent(in) :: iout
    integer(I4B) :: min_val, max_val
    character(len=LINELENGTH) :: description
    if (iparamlog > 0 .and. iout > 0) then
      min_val = minval(p_mem)
      max_val = maxval(p_mem)
      if (min_val == max_val) then
        description = 'Integer 1D constant array detected'
        write (iout, '(3x, a, ": ", a, " = ", i0)') &
          trim(description), trim(varname), min_val
      else
        description = 'Integer 1D array detected'
        write (iout, '(3x, a, ": ", a, a, i0, a, i0)') &
          trim(description), trim(varname), &
          ' ranges from ', min_val, ' to ', max_val
      end if
    end if

idm_log_var_int2d()

subroutine idmloggermodule::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_mem	2d int array
[in]	varname	variable name
[in]	mempath	variable memory path

Definition at line 182 of file IdmLogger.f90.

    integer(I4B), dimension(:, :), contiguous, intent(in) :: p_mem !< 2d int array
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    integer(I4B), intent(in) :: iout
    integer(I4B) :: min_val, max_val
    character(len=LINELENGTH) :: description
    if (iparamlog > 0 .and. iout > 0) then
      min_val = minval(p_mem)
      max_val = maxval(p_mem)
      if (min_val == max_val) then
        description = 'Integer 2D constant array detected'
        write (iout, '(3x, a, ": ", a, " = ", i0)') &
          trim(description), trim(varname), min_val
      else
        description = 'Integer 2D array detected'
        write (iout, '(3x, a, ": ", a, a, i0, a, i0)') &
          trim(description), trim(varname), &
          ' ranges from ', min_val, ' to ', max_val
      end if
    end if

idm_log_var_int3d()

subroutine idmloggermodule::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_mem	3d int array
[in]	varname	variable name
[in]	mempath	variable memory path

Definition at line 207 of file IdmLogger.f90.

    integer(I4B), dimension(:, :, :), contiguous, intent(in) :: p_mem !< 3d int array
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    integer(I4B), intent(in) :: iout
    integer(I4B) :: min_val, max_val
    character(len=LINELENGTH) :: description
    if (iparamlog > 0 .and. iout > 0) then
      min_val = minval(p_mem)
      max_val = maxval(p_mem)
      if (min_val == max_val) then
        description = 'Integer 3D constant array detected'
        write (iout, '(3x, a, ": ", a, " = ", i0)') &
          trim(description), trim(varname), min_val
      else
        description = 'Integer 3D array detected'
        write (iout, '(3x, a, ": ", a, a, i0, a, i0)') &
          trim(description), trim(varname), &
          ' ranges from ', min_val, ' to ', max_val
      end if
    end if

idm_log_var_logical()

subroutine idmloggermodule::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_mem	logical scalar
[in]	varname	variable name
[in]	mempath	variable memory path

Definition at line 121 of file IdmLogger.f90.

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

idm_log_var_str()

subroutine idmloggermodule::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_mem	pointer to str scalar
[in]	varname	variable name
[in]	mempath	variable memory path

Definition at line 322 of file IdmLogger.f90.

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

idm_log_var_ts()

subroutine idmloggermodule::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]	varname	variable name
[in]	mempath	variable memory path
[in]	detail	additional info (ts name or count)

Definition at line 89 of file IdmLogger.f90.

    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable memory path
    integer(I4B), intent(in) :: iout
    logical(LGP), intent(in) :: is_tas
    character(len=*), intent(in), optional :: detail !< additional info (ts name or count)
    if (iparamlog > 0 .and. iout > 0) then
      if (is_tas) then
        if (present(detail)) then
          write (iout, '(3x, a, ": ", a, " (", a, ")")') &
            'Time-array-series controlled dynamic variable detected', &
            trim(varname), trim(detail)
        else
          write (iout, '(3x, a, ": ", a)') &
            'Time-array-series controlled dynamic variable detected', &
            trim(varname)
        end if
      else
        if (present(detail)) then
          write (iout, '(3x, a, ": ", a, " (", a, ")")') &
            'Time-series controlled dynamic variable detected', &
            trim(varname), trim(detail)
        else
          write (iout, '(3x, a, ": ", a)') &
            'Time-series controlled dynamic variable detected', trim(varname)
        end if
      end if
    end if