Mf6FileListInput.f90

Go to the documentation of this file.

!> @brief This module contains the Mf6FileListInputModule
!!
!! This module contains the routines for reading period block
!! list based input.
!!
!<
module mf6filelistinputmodule
 
  use kindmodule, only: i4b, dp, lgp
  use constantsmodule, only: dzero, izero, linelength, lenmempath, lenvarname, &
                             lentimeseriesname, lenauxname, lenboundname, &
                             lencomponentname
  use simvariablesmodule, only: errmsg
  use simmodule, only: store_error, count_errors, store_error_unit
  use inputoutputmodule, only: openfile, getunit
  use inputdefinitionmodule, only: inputparamdefinitiontype
  use memorymanagermodule, only: mem_setptr
  use characterstringmodule, only: characterstringtype
  use modflowinputmodule, only: modflowinputtype, getmodflowinput
  use timeseriesmanagermodule, only: timeseriesmanagertype, tsmanager_cr
  use structarraymodule, only: structarraytype, constructstructarray, &
                               destructstructarray
  use asciiinputloadtypemodule, only: asciidynamicpkgloadbasetype
  use boundinputcontextmodule, only: boundinputcontexttype
  use structvectormodule, only: structvectortype, tsstringloctype
 
  implicit none
  private
  public :: boundlistinputtype
 
  !> @brief Abstract base class for ascii list loaders
  !!
  !! Abstract class with types and routines common to Ascii list
  !! based loaders.
  !!
  !<
  type, abstract, extends(asciidynamicpkgloadbasetype) :: listinputbasetype
    integer(I4B) :: ts_active
    type(timeseriesmanagertype), pointer :: tsmanager => null()
    type(structarraytype), pointer :: structarray => null()
  contains
    procedure :: base_init
    procedure :: base_destroy
    procedure :: df
    procedure :: ad
    procedure :: reset
  end type listinputbasetype
 
  !> @brief Boundary package list loader.
  !!
  !! Creates boundary input context for a package,
  !! (e.g. CHD or MAW) and updates that context in
  !! read and prepare (RP) routines.
  !!
  !<
  type, extends(listinputbasetype) :: boundlistinputtype
    integer(I4B) :: iboundname
    type(boundinputcontexttype) :: bound_context
  contains
    procedure :: ainit => bndlist_init
    procedure :: rp => bndlist_rp
    procedure :: destroy => bndlist_destroy
    procedure :: ts_link_bnd => bndlist_ts_link_bnd
    procedure :: ts_link_aux => bndlist_ts_link_aux
    procedure :: ts_link => bndlist_ts_link
    procedure :: ts_update => bndlist_ts_update
    procedure :: create_structarray => bndlist_create_structarray
  end type boundlistinputtype
 
contains
 
  subroutine bndlist_init(this, mf6_input, component_name, component_input_name, &
                          input_name, iperblock, parser, iout)
    use blockparsermodule, only: blockparsertype
    use loadmf6filemodule, only: loadmf6filetype
    class(boundlistinputtype), 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(loadmf6filetype) :: loader
    character(len=LINELENGTH) :: blockname
    integer(I4B) :: iblk
    !
    ! -- initialize scalars
    this%iboundname = 0
    !
    ! -- initialize base class
    call this%base_init(mf6_input, component_name, component_input_name, &
                        input_name, iperblock, parser, loader, iout)
    !
    ! -- initialize package input context
    call this%bound_context%create(mf6_input, this%readasarrays)
    !
    ! -- load blocks after OPTIONS and DIMENSIONS
    do iblk = 1, size(this%mf6_input%block_dfns)
      !
      ! -- log block header via loader or directly here?
      !
      ! -- set blockname
      blockname = this%mf6_input%block_dfns(iblk)%blockname
      !
      ! -- base_init loads OPTIONS and DIMENSIONS blocks if defined
      if (blockname == 'OPTIONS' .or. blockname == 'DIMENSIONS') cycle
      if (blockname == 'PERIOD') exit
      !
      ! -- load block
      call loader%load_block(iblk)
      !
      if (this%mf6_input%block_dfns(iblk)%aggregate) then
        if (this%mf6_input%block_dfns(iblk)%timeseries) then
          if (this%ts_active > 0) then
            call this%ts_update(loader%structarray)
          end if
        end if
      end if
      !
    end do
    !
    call loader%finalize()
    !
    ! -- store in scope SA cols for list input
    call this%bound_context%bound_params(this%param_names, this%nparam, &
                                         this%input_name, create=.false.)
    !
    ! -- construct and set up the struct array object
    call this%create_structarray()
    !
    ! -- finalize input context setup
    call this%bound_context%allocate_arrays()
    !
    ! -- return
    return
  end subroutine bndlist_init
 
  subroutine bndlist_rp(this, parser)
    ! -- modules
    use blockparsermodule, only: blockparsertype
    use loadmf6filemodule, only: read_control_record
    use structvectormodule, only: structvectortype
    use idmloggermodule, only: idm_log_header, idm_log_close
    ! -- dummy
    class(boundlistinputtype), intent(inout) :: this
    type(blockparsertype), pointer, intent(inout) :: parser
    ! -- local
    integer(I4B) :: ibinary
    integer(I4B) :: oc_inunit
    logical(LGP) :: ts_active
    !
    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%bound_context%nbound = &
        this%structarray%read_from_binary(oc_inunit, this%iout)
      !
      call parser%terminateblock()
      !
      close (oc_inunit)
      !
    else
      !
      ts_active = (this%ts_active /= 0)
      !
      this%bound_context%nbound = &
        this%structarray%read_from_parser(parser, ts_active, this%iout)
    end if
    !
    ! update ts links
    if (this%ts_active /= 0) then
      call this%ts_update(this%structarray)
    end if
    !
    ! -- close logging statement
    call idm_log_close(this%mf6_input%component_name, &
                       this%mf6_input%subcomponent_name, this%iout)
    !
    ! -- return
    return
  end subroutine bndlist_rp
 
  subroutine bndlist_destroy(this)
    ! -- modules
    class(boundlistinputtype), intent(inout) :: this !< BoundListInputType
    !
    call this%base_destroy()
    call this%bound_context%destroy()
    !
    ! -- return
    return
  end subroutine bndlist_destroy
 
  subroutine bndlist_ts_link_bnd(this, structvector, ts_strloc)
    ! -- modules
    use timeserieslinkmodule, only: timeserieslinktype
    use timeseriesmanagermodule, only: read_value_or_time_series
    use structvectormodule, only: structvectortype, tsstringloctype
    ! -- dummy
    class(boundlistinputtype), intent(inout) :: this
    type(structvectortype), pointer, intent(in) :: structvector
    type(tsstringloctype), pointer, intent(in) :: ts_strloc
    ! -- local
    real(DP), pointer :: bndElem
    type(timeserieslinktype), pointer :: tsLinkBnd
    type(structvectortype), pointer :: sv_bound
    character(len=LENBOUNDNAME) :: boundname
    !
    nullify (tslinkbnd)
    !
    ! -- set bound element
    bndelem => structvector%dbl1d(ts_strloc%row)
    !
    ! -- set link
    call read_value_or_time_series(ts_strloc%token, ts_strloc%row, &
                                   ts_strloc%structarray_col, bndelem, &
                                   this%mf6_input%subcomponent_name, &
                                   'BND', this%tsmanager, &
                                   this%bound_context%iprpak, tslinkbnd)
    !
    if (associated(tslinkbnd)) then
      !
      ! -- set variable name
      tslinkbnd%Text = structvector%idt%mf6varname
      !
      ! -- set boundname if provided
      if (this%bound_context%inamedbound > 0) then
        sv_bound => this%structarray%get(this%iboundname)
        boundname = sv_bound%charstr1d(ts_strloc%row)
        tslinkbnd%BndName = boundname
      end if
    end if
    !
    ! -- return
    return
  end subroutine bndlist_ts_link_bnd
 
  subroutine bndlist_ts_link_aux(this, structvector, ts_strloc)
    ! -- modules
    use timeserieslinkmodule, only: timeserieslinktype
    use timeseriesmanagermodule, only: read_value_or_time_series
    use structvectormodule, only: structvectortype, tsstringloctype
    ! -- dummy
    class(boundlistinputtype), intent(inout) :: this
    type(structvectortype), pointer, intent(in) :: structvector
    type(tsstringloctype), pointer, intent(in) :: ts_strloc
    ! -- local
    real(DP), pointer :: bndElem
    type(timeserieslinktype), pointer :: tsLinkAux
    type(structvectortype), pointer :: sv_bound
    character(len=LENBOUNDNAME) :: boundname
    !
    nullify (tslinkaux)
    !
    ! -- set bound element
    bndelem => structvector%dbl2d(ts_strloc%col, ts_strloc%row)
    !
    ! -- set link
    call read_value_or_time_series(ts_strloc%token, ts_strloc%row, &
                                   ts_strloc%structarray_col, bndelem, &
                                   this%mf6_input%subcomponent_name, &
                                   'AUX', this%tsmanager, &
                                   this%bound_context%iprpak, tslinkaux)
 
    if (associated(tslinkaux)) then
      !
      ! -- set variable name
      tslinkaux%Text = this%bound_context%auxname_cst(ts_strloc%col)
      !
      ! -- set boundname if provided
      if (this%bound_context%inamedbound > 0) then
        sv_bound => this%structarray%get(this%iboundname)
        boundname = sv_bound%charstr1d(ts_strloc%row)
        tslinkaux%BndName = boundname
      end if
      !
    end if
    !
    ! -- return
    return
  end subroutine bndlist_ts_link_aux
 
  subroutine bndlist_ts_update(this, structarray)
    ! -- modules
    use structvectormodule, only: tsstringloctype
    use structvectormodule, only: structvectortype
    ! -- dummy
    class(boundlistinputtype), intent(inout) :: this
    type(structarraytype), pointer, intent(inout) :: structarray
    ! -- local
    integer(I4B) :: n, m
    type(tsstringloctype), pointer :: ts_strloc
    type(structvectortype), pointer :: sv
    !
    do m = 1, structarray%count()
 
      sv => structarray%get(m)
 
      if (sv%idt%timeseries) then
        !
        do n = 1, sv%ts_strlocs%count()
          ts_strloc => sv%get_ts_strloc(n)
          call this%ts_link(sv, ts_strloc)
        end do
        !
        call sv%clear()
      end if
    end do
    !
    ! -- return
    return
  end subroutine bndlist_ts_update
 
  subroutine bndlist_ts_link(this, structvector, ts_strloc)
    ! -- modules
    use structvectormodule, only: structvectortype, tsstringloctype
    ! -- dummy
    class(boundlistinputtype), intent(inout) :: this
    type(structvectortype), pointer, intent(in) :: structvector
    type(tsstringloctype), pointer, intent(in) :: ts_strloc
    ! -- local
    !
    select case (structvector%memtype)
    case (2) ! -- dbl1d
      !
      call this%ts_link_bnd(structvector, ts_strloc)
      !
    case (6) ! -- dbl2d
      !
      call this%ts_link_aux(structvector, ts_strloc)
      !
    case default
    end select
    !
    ! -- return
    return
  end subroutine bndlist_ts_link
 
  subroutine bndlist_create_structarray(this)
    ! -- modules
    use inputdefinitionmodule, only: inputparamdefinitiontype
    use definitionselectmodule, only: get_param_definition_type
    ! -- dummy
    class(boundlistinputtype), intent(inout) :: this
    ! -- local
    type(inputparamdefinitiontype), pointer :: idt
    integer(I4B) :: icol
    !
    ! -- construct and set up the struct array object
    this%structarray => constructstructarray(this%mf6_input, this%nparam, &
                                             this%bound_context%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)
      !
      ! -- store boundname index when found
      if (idt%mf6varname == 'BOUNDNAME') this%iboundname = icol
      !
    end do
    !
    ! -- return
    return
  end subroutine bndlist_create_structarray
 
  subroutine base_init(this, mf6_input, component_name, component_input_name, &
                       input_name, iperblock, parser, loader, iout)
    use constantsmodule, only: lencomponentname
    use blockparsermodule, only: blockparsertype
    use loadmf6filemodule, only: loadmf6filetype
    use memorymanagermodule, only: get_isize
    use idmloggermodule, only: idm_log_header
    class(listinputbasetype), 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), intent(inout) :: parser
    type(loadmf6filetype), intent(inout) :: loader
    integer(I4B), intent(in) :: iout
    type(characterstringtype), dimension(:), pointer, &
      contiguous :: ts_fnames
    character(len=LINELENGTH) :: fname
    integer(I4B) :: ts6_size, n
    character(len=LINELENGTH) :: blockname
    integer(I4B) :: iblk
    !
    ! -- init loader
    call this%DynamicPkgLoadType%init(mf6_input, component_name, &
                                      component_input_name, input_name, &
                                      iperblock, iout)
    !
    ! -- initialize
    this%ts_active = 0
    !
    ! -- initialize static loader
    call loader%init(parser, mf6_input, this%input_name, iout)
    !
    ! -- load OPTIONS and DIMENSIONS blocks
    do iblk = 1, size(this%mf6_input%block_dfns)
      !
      ! -- set blockname
      blockname = this%mf6_input%block_dfns(iblk)%blockname
      !
      ! -- step 1 loads OPTIONS and DIMENSIONS blocks if defined
      if (blockname /= 'OPTIONS' .and. blockname /= 'DIMENSIONS') exit
      !
      ! -- load block
      call loader%load_block(iblk)
      !
    end do
    !
    ! -- create tsmanager
    allocate (this%tsmanager)
    call tsmanager_cr(this%tsmanager, iout)
    !
    ! -- determine if TS6 files were provided in OPTIONS block
    call get_isize('TS6_FILENAME', this%mf6_input%mempath, ts6_size)
    !
    if (ts6_size > 0) then
      !
      this%ts_active = 1
      call mem_setptr(ts_fnames, 'TS6_FILENAME', this%mf6_input%mempath)
      !
      do n = 1, size(ts_fnames)
        fname = ts_fnames(n)
        call this%tsmanager%add_tsfile(fname, getunit())
      end do
      !
    end if
    !
    ! -- define TS manager
    call this%tsmanager%tsmanager_df()
    !
    ! -- return
    return
  end subroutine base_init
 
  subroutine base_destroy(this)
    ! -- modules
    class(listinputbasetype), intent(inout) :: this !< ListInputType
    !
    deallocate (this%tsmanager)
    !
    ! -- deallocate StructArray
    call destructstructarray(this%structarray)
    !
    ! -- return
    return
  end subroutine base_destroy
 
  subroutine df(this)
    ! -- modules
    ! -- dummy
    class(listinputbasetype), intent(inout) :: this !< ListInputType
    !
    ! -- define tsmanager
    !call this%tsmanager%tsmanager_df()
    !
    ! -- return
    return
  end subroutine df
 
  subroutine ad(this)
    ! -- modules
    class(listinputbasetype), intent(inout) :: this !< ListInputType
    !
    ! -- advance timeseries
    call this%tsmanager%ad()
    !
    ! -- return
    return
  end subroutine ad
 
  subroutine reset(this)
    ! -- modules
    class(listinputbasetype), intent(inout) :: this !< ListInputType
    !
    ! -- reset tsmanager
    call this%tsmanager%reset(this%mf6_input%subcomponent_name)
    !
    ! -- return
    return
  end subroutine reset
 
end module mf6filelistinputmodule