Mf6FileList.f90

Go to the documentation of this file.

!> @brief This module contains the ListLoadModule
!!
!! This module contains the routines for reading period block
!! list based input.
!!
!<
module listloadmodule
 
  use kindmodule, only: i4b, lgp
  use constantsmodule, only: linelength
  use inputdefinitionmodule, only: inputparamdefinitiontype
  use memorymanagermodule, only: mem_setptr
  use characterstringmodule, only: characterstringtype
  use modflowinputmodule, only: modflowinputtype
  use timeseriesmanagermodule, only: timeseriesmanagertype, tsmanager_cr
  use structarraymodule, only: structarraytype, constructstructarray, &
                               destructstructarray
  use asciiinputloadtypemodule, only: asciidynamicpkgloadbasetype
  use loadcontextmodule, only: loadcontexttype
  use loadmf6filemodule, only: loadmf6filetype
 
  implicit none
  private
  public :: listloadtype
 
  !> @brief list input loader for dynamic packages.
  !!
  !! Create and update input context for list based period blocks.
  !!
  !<
  type, extends(asciidynamicpkgloadbasetype) :: listloadtype
    type(timeseriesmanagertype), pointer :: tsmanager => null()
    type(structarraytype), pointer :: structarray => null()
    type(loadcontexttype) :: ctx
    type(loadmf6filetype) :: static_loader ! persistent static loader
    logical(LGP) :: ts_active !< .true. if TS files are loaded
  contains
    procedure :: ainit
    procedure :: df
    procedure :: ad
    procedure :: reset
    procedure :: rp
    procedure :: destroy
    procedure :: create_structarray
  end type listloadtype
 
contains
 
  subroutine ainit(this, mf6_input, component_name, component_input_name, &
                   input_name, iperblock, parser, iout)
    use inputoutputmodule, only: getunit
    use memorymanagermodule, only: get_isize
    use characterstringmodule, only: characterstringtype
    use blockparsermodule, only: blockparsertype
    class(listloadtype), intent(inout) :: this
    type(modflowinputtype), intent(in) :: mf6_input
    character(len=*), intent(in) :: component_name
    character(len=*), intent(in) :: component_input_name
    character(len=*), intent(in) :: input_name
    integer(I4B), intent(in) :: iperblock
    type(blockparsertype), pointer, intent(inout) :: parser
    integer(I4B), intent(in) :: iout
    type(characterstringtype), dimension(:), pointer, contiguous :: ts_fnames
    character(len=LINELENGTH) :: fname
    integer(I4B) :: ts6_size, n
 
    ! init loader
    call this%DynamicPkgLoadType%init(mf6_input, component_name, &
                                      component_input_name, input_name, &
                                      iperblock, iout)
    ! initialize scalars
    this%ts_active = .false.
 
    ! create tsmanager
    allocate (this%tsmanager)
    call tsmanager_cr(this%tsmanager, iout)
 
    ! load static input (TS6_FILENAME tag sets static_loader%ts_active)
    call this%static_loader%load(parser, mf6_input, this%nc_vars, &
                                 this%input_name, iout)
 
    ! if TS files were declared, add them to our tsmanager now
    if (this%static_loader%ts_active) then
      this%ts_active = .true.
      call get_isize('TS6_FILENAME', mf6_input%mempath, ts6_size)
      if (ts6_size > 0) then
        call mem_setptr(ts_fnames, 'TS6_FILENAME', mf6_input%mempath)
        do n = 1, size(ts_fnames)
          fname = ts_fnames(n)
          call this%tsmanager%add_tsfile(fname, getunit())
        end do
      end if
    end if
 
    ! initialize package input context
    call this%ctx%init(mf6_input)
 
    ! store in scope SA cols for list input
    call this%ctx%tags(this%param_names, this%nparam, this%input_name)
 
    ! construct and set up the struct array object
    call this%create_structarray()
 
    ! finalize input context setup
    call this%ctx%allocate_arrays()
  end subroutine ainit
 
  subroutine df(this)
    use structarraymodule, only: structarraytype
    class(listloadtype), intent(inout) :: this
    type(structarraytype), pointer :: sa
    integer(I4B) :: n
    ! define tsmanager (TDIS is now available)
    call this%tsmanager%tsmanager_df()
    ! link static TS strlocs; preserve for re-registration after reset()
    do n = 1, this%static_loader%ts_sa_count()
      sa => this%static_loader%get_ts_sa(n)
      if (associated(sa)) then
        call sa%ts_update(this%tsmanager, &
                          this%mf6_input%subcomponent_name, &
                          this%ctx%iprpak, this%input_name, &
                          this%ctx%auxname_cst, &
                          clear_strlocs=.false.)
      end if
    end do
  end subroutine df
 
  subroutine ad(this)
    class(listloadtype), intent(inout) :: this
    ! advance timeseries
    call this%tsmanager%ad()
  end subroutine ad
 
  subroutine reset(this)
    use structarraymodule, only: structarraytype
    class(listloadtype), intent(inout) :: this
    type(structarraytype), pointer :: sa
    integer(I4B) :: n
    ! clear TS links
    call this%tsmanager%reset(this%mf6_input%subcomponent_name)
    ! re-register static TS links (strlocs preserved in df)
    if (this%ts_active) then
      do n = 1, this%static_loader%ts_sa_count()
        sa => this%static_loader%get_ts_sa(n)
        if (associated(sa)) then
          call sa%ts_update(this%tsmanager, &
                            this%mf6_input%subcomponent_name, &
                            this%ctx%iprpak, this%input_name, &
                            this%ctx%auxname_cst, &
                            clear_strlocs=.false.)
        end if
      end do
    end if
  end subroutine reset
 
  subroutine rp(this, parser)
    use blockparsermodule, only: blockparsertype
    use loadmf6filemodule, only: read_control_record
    use structvectormodule, only: structvectortype
    use idmloggermodule, only: idm_log_header, idm_log_close
    class(listloadtype), intent(inout) :: this
    type(blockparsertype), pointer, intent(inout) :: parser
    integer(I4B) :: ibinary
    integer(I4B) :: oc_inunit
 
    call this%reset()
    ibinary = read_control_record(parser, oc_inunit, this%iout)
 
    ! log lst file header
    call idm_log_header(this%mf6_input%component_name, &
                        this%mf6_input%subcomponent_name, this%iout)
 
    if (ibinary == 1) then
      this%ctx%nbound = &
        this%structarray%read_from_binary(oc_inunit, this%iout)
      call parser%terminateblock()
      close (oc_inunit)
    else
      this%ctx%nbound = &
        this%structarray%read_from_parser(parser, this%ts_active, this%iout, &
                                          this%input_name)
    end if
 
    ! update ts links
    if (this%ts_active) then
      call this%structarray%ts_update(this%tsmanager, &
                                      this%mf6_input%subcomponent_name, &
                                      this%ctx%iprpak, this%input_name, &
                                      this%ctx%auxname_cst)
    end if
 
    ! close logging statement
    call idm_log_close(this%mf6_input%component_name, &
                       this%mf6_input%subcomponent_name, this%iout)
  end subroutine rp
 
  subroutine destroy(this)
    class(listloadtype), intent(inout) :: this
    !
    ! clean up saved static structarrays
    call this%static_loader%cleanup()
    !
    ! deallocate tsmanager
    call this%tsmanager%da()
    deallocate (this%tsmanager)
    nullify (this%tsmanager)
    !
    ! deallocate StructArray
    call destructstructarray(this%structarray)
    call this%ctx%destroy()
  end subroutine destroy
 
  subroutine create_structarray(this)
    use inputdefinitionmodule, only: inputparamdefinitiontype
    use definitionselectmodule, only: get_param_definition_type
    class(listloadtype), intent(inout) :: this
    type(inputparamdefinitiontype), pointer :: idt
    integer(I4B) :: icol
 
    ! construct and set up the struct array object
    this%structarray => constructstructarray(this%mf6_input, this%nparam, &
                                             this%ctx%maxbound, 0, &
                                             this%mf6_input%mempath, &
                                             this%mf6_input%component_mempath)
    ! set up struct array
    do icol = 1, this%nparam
      idt => get_param_definition_type(this%mf6_input%param_dfns, &
                                       this%mf6_input%component_type, &
                                       this%mf6_input%subcomponent_type, &
                                       'PERIOD', &
                                       this%param_names(icol), this%input_name)
      ! allocate variable in memory manager
      call this%structarray%mem_create_vector(icol, idt)
    end do
  end subroutine create_structarray
 
end module listloadmodule