dynamicpackageparamsmodule Module Reference

This module contains the DynamicPackageParamsModule.

Data Types
type	dynamicpackageparamstype
	dynamic parameter filter type More...

Functions/Subroutines
subroutine	init (this, mf6_input, readasarrays, naux, inamedbound)
	initialize dynamic param filter More...
subroutine	destroy (this)
	destroy More...
subroutine	set_filtered_grid (this)
	array based input dynamic param filter More...
subroutine	set_filtered_list (this)
	create array of in scope list input columns More...
subroutine	package_params (this, params, nparam)
	allocate and set input array to filtered param set More...
subroutine, public	allocate_param_charstr (strlen, nrow, varname, mempath)
	allocate character string type array More...
subroutine, public	allocate_param_int1d (nrow, varname, mempath)
	allocate int1d More...
subroutine, public	allocate_param_int2d (ncol, nrow, varname, mempath)
	allocate int2d More...
subroutine, public	allocate_param_dbl1d (nrow, varname, mempath)
	allocate dbl1d More...
subroutine, public	allocate_param_dbl2d (ncol, nrow, varname, mempath)
	allocate dbl2d More...
logical(lgp) function	pkg_param_in_scope (mf6_input, tagname)
	determine if input param is in scope for a package More...

Function/Subroutine Documentation

allocate_param_charstr()

subroutine, public dynamicpackageparamsmodule::allocate_param_charstr	(	integer(i4b), intent(in)	strlen,
		integer(i4b), intent(in)	nrow,
		character(len=*), intent(in)	varname,
		character(len=*), intent(in)	mempath
	)

Parameters

[in]	strlen	string number of characters
[in]	nrow	integer array number of rows
[in]	varname	variable name
[in]	mempath	variable mempath

Definition at line 250 of file DynamicPackageParams.f90.

    integer(I4B), intent(in) :: strlen !< string number of characters
    integer(I4B), intent(in) :: nrow !< integer array number of rows
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable mempath
    type(CharacterStringType), dimension(:), pointer, &
      contiguous :: charstr1d
    integer(I4B) :: n
    !
    call mem_allocate(charstr1d, strlen, nrow, varname, mempath)
    do n = 1, nrow
      charstr1d(n) = ''
    end do

Here is the caller graph for this function:

allocate_param_dbl1d()

subroutine, public dynamicpackageparamsmodule::allocate_param_dbl1d	(	integer(i4b), intent(in)	nrow,
		character(len=*), intent(in)	varname,
		character(len=*), intent(in)	mempath
	)

Parameters

[in]	nrow	integer array number of rows
[in]	varname	variable name
[in]	mempath	variable mempath

Definition at line 300 of file DynamicPackageParams.f90.

    integer(I4B), intent(in) :: nrow !< integer array number of rows
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable mempath
    real(DP), dimension(:), pointer, contiguous :: dbl1d
    integer(I4B) :: n
    !
    call mem_allocate(dbl1d, nrow, varname, mempath)
    do n = 1, nrow
      dbl1d(n) = dzero
    end do

Here is the caller graph for this function:

allocate_param_dbl2d()

subroutine, public dynamicpackageparamsmodule::allocate_param_dbl2d	(	integer(i4b), intent(in)	ncol,
		integer(i4b), intent(in)	nrow,
		character(len=*), intent(in)	varname,
		character(len=*), intent(in)	mempath
	)

Parameters

[in]	ncol	integer array number of cols
[in]	nrow	integer array number of rows
[in]	varname	variable name
[in]	mempath	variable mempath

Definition at line 315 of file DynamicPackageParams.f90.

    integer(I4B), intent(in) :: ncol !< integer array number of cols
    integer(I4B), intent(in) :: nrow !< integer array number of rows
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable mempath
    real(DP), dimension(:, :), pointer, contiguous :: dbl2d
    integer(I4B) :: n, m
    !
    call mem_allocate(dbl2d, ncol, nrow, varname, mempath)
    do m = 1, nrow
      do n = 1, ncol
        dbl2d(n, m) = dzero
      end do
    end do

Here is the caller graph for this function:

allocate_param_int1d()

subroutine, public dynamicpackageparamsmodule::allocate_param_int1d	(	integer(i4b), intent(in)	nrow,
		character(len=*), intent(in)	varname,
		character(len=*), intent(in)	mempath
	)

Parameters

[in]	nrow	integer array number of rows
[in]	varname	variable name
[in]	mempath	variable mempath

Definition at line 267 of file DynamicPackageParams.f90.

    integer(I4B), intent(in) :: nrow !< integer array number of rows
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable mempath
    integer(I4B), dimension(:), pointer, contiguous :: int1d
    integer(I4B) :: n
    !
    call mem_allocate(int1d, nrow, varname, mempath)
    do n = 1, nrow
      int1d(n) = izero
    end do

Here is the caller graph for this function:

allocate_param_int2d()

subroutine, public dynamicpackageparamsmodule::allocate_param_int2d	(	integer(i4b), intent(in)	ncol,
		integer(i4b), intent(in)	nrow,
		character(len=*), intent(in)	varname,
		character(len=*), intent(in)	mempath
	)

Parameters

[in]	ncol	integer array number of cols
[in]	nrow	integer array number of rows
[in]	varname	variable name
[in]	mempath	variable mempath

Definition at line 282 of file DynamicPackageParams.f90.

    integer(I4B), intent(in) :: ncol !< integer array number of cols
    integer(I4B), intent(in) :: nrow !< integer array number of rows
    character(len=*), intent(in) :: varname !< variable name
    character(len=*), intent(in) :: mempath !< variable mempath
    integer(I4B), dimension(:, :), pointer, contiguous :: int2d
    integer(I4B) :: n, m
    !
    call mem_allocate(int2d, ncol, nrow, varname, mempath)
    do m = 1, nrow
      do n = 1, ncol
        int2d(n, m) = izero
      end do
    end do

Here is the caller graph for this function:

destroy()

subroutine dynamicpackageparamsmodule::destroy ( class(dynamicpackageparamstype)  this )

private

Definition at line 79 of file DynamicPackageParams.f90.

    ! -- modules
    ! -- dummy
    class(DynamicPackageParamsType) :: this
    !
    ! -- deallocate
    if (allocated(this%params)) deallocate (this%params)
    !
    ! --return
    return

init()

subroutine dynamicpackageparamsmodule::init ( class(dynamicpackageparamstype)  this, type(modflowinputtype), intent(in)  mf6_input, logical(lgp), intent(in)  readasarrays, integer(i4b), intent(in)  naux, integer(i4b), intent(in)  inamedbound  )

private

Definition at line 50 of file DynamicPackageParams.f90.

    ! -- modules
    ! -- dummy
    class(DynamicPackageParamsType) :: this
    type(ModflowInputType), intent(in) :: mf6_input
    logical(LGP), intent(in) :: readasarrays
    integer(I4B), intent(in) :: naux
    integer(I4B), intent(in) :: inamedbound
    ! -- local
    !
    this%mf6_input = mf6_input
    this%nparam = 0
    this%naux = naux
    this%inamedbound = inamedbound
    !
    ! -- determine in scope input params
    if (readasarrays) then
      call this%set_filtered_grid()
    else
      call this%set_filtered_list()
    end if
    !
    ! --return
    return

package_params()

subroutine dynamicpackageparamsmodule::package_params ( class(dynamicpackageparamstype)  this, character(len=linelength), dimension(:), intent(inout), allocatable  params, integer(i4b), intent(inout)  nparam  )

private

Definition at line 225 of file DynamicPackageParams.f90.

    ! -- modules
    ! -- dummy
    class(DynamicPackageParamsType) :: this
    character(len=LINELENGTH), dimension(:), allocatable, &
      intent(inout) :: params
    integer(I4B), intent(inout) :: nparam
    integer(I4B) :: n
    !
    if (allocated(params)) deallocate (params)
    !
    nparam = this%nparam
    !
    allocate (params(nparam))
    !
    do n = 1, nparam
      params(n) = this%params(n)
    end do
    !
    ! -- return
    return

pkg_param_in_scope()

logical(lgp) function dynamicpackageparamsmodule::pkg_param_in_scope ( type(modflowinputtype), intent(in)  mf6_input, character(len=*), intent(in)  tagname  )

private

Definition at line 334 of file DynamicPackageParams.f90.

    ! -- modules
    use memorymanagermodule, only: get_isize, mem_setptr
    ! -- dummy
    type(ModflowInputType), intent(in) :: mf6_input
    character(len=*), intent(in) :: tagname
    ! -- return
    logical(LGP) :: in_scope
    ! -- local
    type(InputParamDefinitionType), pointer :: idt
    integer(I4B) :: pdim_isize, popt_isize
    integer(I4B), pointer :: pdim
    !
    ! -- initialize
    in_scope = .false.
    !
    idt => get_param_definition_type(mf6_input%param_dfns, &
                                     mf6_input%component_type, &
                                     mf6_input%subcomponent_type, &
                                     'PERIOD', tagname, '')
    !
    if (idt%required) then
      ! -- required params always included
      in_scope = .true.
    else
      !
      ! -- package specific logic to determine if input params to be read
      select case (mf6_input%subcomponent_type)
      case ('EVT')
        !
        if (tagname == 'PXDP' .or. tagname == 'PETM') then
          call get_isize('NSEG', mf6_input%mempath, pdim_isize)
          if (pdim_isize > 0) then
            call mem_setptr(pdim, 'NSEG', mf6_input%mempath)
            if (pdim > 1) then
              in_scope = .true.
            end if
          end if
        else if (tagname == 'PETM0') then
          call get_isize('SURFRATESPEC', mf6_input%mempath, popt_isize)
          if (popt_isize > 0) then
            in_scope = .true.
          end if
        end if
        !
      case default
        errmsg = 'IDM unimplemented. DynamicPackageParamsType::pkg_param_in_scope &
                 &add case tagname='//trim(idt%tagname)
        call store_error(errmsg, .true.)
        !call store_error_filename(sourcename)
      end select
    end if
    !
    ! -- return
    return

Here is the call graph for this function:

Here is the caller graph for this function:

set_filtered_grid()

subroutine dynamicpackageparamsmodule::set_filtered_grid ( class(dynamicpackageparamstype)  this )

private

Definition at line 94 of file DynamicPackageParams.f90.

    ! -- modules
    ! -- dummy
    class(DynamicPackageParamsType) :: this
    ! -- local
    type(InputParamDefinitionType), pointer :: idt
    integer(I4B), dimension(:), allocatable :: idt_idxs
    integer(I4B) :: keepcnt, iparam
    logical(LGP) :: keep
    !
    ! -- initialize
    keepcnt = 0
    !
    ! -- allocate dfn input params
    do iparam = 1, size(this%mf6_input%param_dfns)
      !
      keep = .true.
      !
      ! -- assign param definition pointer
      idt => this%mf6_input%param_dfns(iparam)
      !
      if (idt%blockname /= 'PERIOD') then
        keep = .false.
      end if
      !
      if (idt%tagname == 'AUX') then
        if (this%naux == 0) then
          keep = .false.
        end if
      end if
      !
      if (keep) then
        keepcnt = keepcnt + 1
        call expandarray(idt_idxs)
        idt_idxs(keepcnt) = iparam
      end if
    end do
    !
    ! -- update nparam
    this%nparam = keepcnt
    !
    ! -- allocate filtcols
    allocate (this%params(this%nparam))
    !
    ! -- set filtcols
    do iparam = 1, this%nparam
      idt => this%mf6_input%param_dfns(idt_idxs(iparam))
      this%params(iparam) = trim(idt%tagname)
    end do
    !
    ! -- cleanup
    deallocate (idt_idxs)
    !
    ! -- return
    return

set_filtered_list()

subroutine dynamicpackageparamsmodule::set_filtered_list ( class(dynamicpackageparamstype)  this )

private

Filter the recarray description of list input parameters to determine which columns are to be read in this run.

Definition at line 156 of file DynamicPackageParams.f90.

    ! -- modules
    ! -- dummy
    class(DynamicPackageParamsType) :: this
    ! -- local
    type(InputParamDefinitionType), pointer :: ra_idt, idt
    character(len=LINELENGTH), dimension(:), allocatable :: ra_cols
    integer(I4B) :: ra_ncol, icol, keepcnt
    logical(LGP) :: keep
    !
    ! -- initialize
    keepcnt = 0
    !
    ! -- get aggregate param definition for period block
    ra_idt => &
      get_aggregate_definition_type(this%mf6_input%aggregate_dfns, &
                                    this%mf6_input%component_type, &
                                    this%mf6_input%subcomponent_type, &
                                    'PERIOD')
    !
    ! -- split recarray definition
    call idt_parse_rectype(ra_idt, ra_cols, ra_ncol)
    !
    ! -- determine which columns are in scope
    do icol = 1, ra_ncol
      !
      keep = .false.
      !
      ! -- set dfn pointer to recarray parameter
      idt => get_param_definition_type(this%mf6_input%param_dfns, &
                                       this%mf6_input%component_type, &
                                       this%mf6_input%subcomponent_type, &
                                       'PERIOD', ra_cols(icol), '')
      !
      if (ra_cols(icol) == 'RECARRAY') then
        ! no-op
      else if (ra_cols(icol) == 'AUX') then
        if (this%naux > 0) then
          keep = .true.
        end if
      else if (ra_cols(icol) == 'BOUNDNAME') then
        if (this%inamedbound /= 0) then
          keep = .true.
        end if
      else
        ! -- determine if the param is scope
        keep = pkg_param_in_scope(this%mf6_input, ra_cols(icol))
      end if
      !
      if (keep) then
        keepcnt = keepcnt + 1
        call expandarray(this%params)
        this%params(keepcnt) = trim(ra_cols(icol))
      end if
    end do
    !
    ! -- update nparam
    this%nparam = keepcnt
    !
    ! -- cleanup
    deallocate (ra_cols)
    !
    ! -- return
    return

Here is the call graph for this function: