inputloadtypemodule Module Reference

This module contains the InputLoadTypeModule. More...

Data Types
type	subpackagelisttype
	type representing package subpackage list More...
type	staticpkgloadtype
	Static loader type. More...
type	staticpkgloadbasetype
	Base abstract type for static input loader. More...
type	dynamicpkgloadtype
	Dynamic loader type. More...
type	dynamicpkgloadbasetype
	Base abstract type for dynamic input loader. More...
interface	load_if
	load interfaces for source static and dynamic types More...
interface	period_load_if
type	modeldynamicpkgstype
	type for storing a dynamic package load list More...

Functions/Subroutines
subroutine	subpkg_create (this, mempath, component_name)
	create a new package type More...
subroutine	subpkg_add (this, pkgtype, component_type, subcomponent_type, tagname, filename)
	create a new package type More...
subroutine	subpkg_destroy (this)
	create a new package type More...
subroutine	static_init (this, mf6_input, component_name, component_input_name, input_name)
	initialize static package loader More...
subroutine	create_subpkg_list (this)
	create the subpackage list More...
subroutine	static_destroy (this)
subroutine	dynamic_init (this, mf6_input, component_name, component_input_name, input_name, iperblock, iout)
	initialize dynamic package loader More...
subroutine	dynamic_df (this)
	dynamic package loader define More...
subroutine	dynamic_ad (this)
	dynamic package loader advance More...
subroutine	dynamic_destroy (this)
	dynamic package loader destroy More...
subroutine	dynamicpkgs_init (this, modeltype, modelname, modelfname, nc_fname, ncid, iout)
	model dynamic packages init More...
subroutine	dynamicpkgs_add (this, dynamic_pkg)
	add package to model dynamic packages list More...
class(dynamicpkgloadbasetype) function, pointer	dynamicpkgs_get (this, idx)
	retrieve package from model dynamic packages list More...
subroutine	dynamicpkgs_rp (this)
	read and prepare model dynamic packages More...
subroutine	dynamicpkgs_df (this)
	define model dynamic packages More...
subroutine	dynamicpkgs_ad (this)
	advance model dynamic packages More...
integer(i4b) function	dynamicpkgs_size (this)
	get size of model dynamic packages list More...
subroutine	dynamicpkgs_destroy (this)
	destroy model dynamic packages object More...
subroutine, public	adddynamicmodeltolist (list, model_dynamic)
	add model dynamic packages object to list More...
class(modeldynamicpkgstype) function, pointer, public	getdynamicmodelfromlist (list, idx)
	get model dynamic packages object from list More...

Variables
type(listtype), public	model_inputs

Detailed Description

This module defines types that support generic IDM static and dynamic input loading.

Function/Subroutine Documentation

adddynamicmodeltolist()

subroutine, public inputloadtypemodule::adddynamicmodeltolist	(	type(listtype), intent(inout)	list,
		class(modeldynamicpkgstype), intent(inout), pointer	model_dynamic
	)

Parameters

[in,out]

list

package list

Definition at line 570 of file InputLoadType.f90.

    type(ListType), intent(inout) :: list !< package list
    class(ModelDynamicPkgsType), pointer, intent(inout) :: model_dynamic
    class(*), pointer :: obj
    obj => model_dynamic
    call list%Add(obj)

Here is the caller graph for this function:

create_subpkg_list()

subroutine inputloadtypemodule::create_subpkg_list ( class(staticpkgloadtype), intent(inout)  this )

private

Definition at line 275 of file InputLoadType.f90.

    use idmdfnselectormodule, only: idm_subpackages, idm_integrated, &
                                    idm_multi_package
    use sourcecommonmodule, only: filein_fname
    class(StaticPkgLoadType), intent(inout) :: this
    character(len=16), dimension(:), pointer :: subpkgs
    character(len=LINELENGTH) :: tag, fname, pkgtype
    character(len=LENFTYPE) :: c_type, sc_type
    character(len=16) :: subpkg
    integer(I4B) :: idx, n
 
    ! set pointer to package (idm integrated) subpackage list
    subpkgs => idm_subpackages(this%mf6_input%component_type, &
                               this%mf6_input%subcomponent_type)
 
    ! check if tag matches subpackage
    do n = 1, size(subpkgs)
      subpkg = subpkgs(n)
      idx = index(subpkg, '-')
      ! split sp string into component/subcomponent
      if (idx > 0) then
        ! split string in component/subcomponent types
        c_type = subpkg(1:idx - 1)
        sc_type = subpkg(idx + 1:len_trim(subpkg))
        if (idm_integrated(c_type, sc_type)) then
          ! set pkgtype and input filename tag
          pkgtype = trim(sc_type)//'6'
          tag = trim(pkgtype)//'_FILENAME'
          ! support single instance of each subpackage
          if (idm_multi_package(c_type, sc_type)) then
            errmsg = 'Multi-instance subpackages not supported. Remove dfn &
                     &subpackage tagline for package "'//trim(subpkg)//'".'
            call store_error(errmsg)
            call store_error_filename(this%input_name)
          else
            if (filein_fname(fname, tag, this%mf6_input%mempath, &
                             this%input_name)) then
              call this%subpkg_list%add(pkgtype, c_type, sc_type, &
                                        trim(tag), trim(fname))
            end if
          end if
        else
          errmsg = 'Identified subpackage is not IDM integrated. Remove dfn &
                   &subpackage tagline for package "'//trim(subpkg)//'".'
          call store_error(errmsg)
          call store_error_filename(this%input_name)
        end if
      end if
    end do

Here is the call graph for this function:

dynamic_ad()

subroutine inputloadtypemodule::dynamic_ad ( class(dynamicpkgloadtype), intent(inout)  this )

private

Definition at line 423 of file InputLoadType.f90.

    class(DynamicPkgLoadType), intent(inout) :: this
    ! override in derived type

dynamic_destroy()

subroutine inputloadtypemodule::dynamic_destroy ( class(dynamicpkgloadtype), intent(inout)  this )

private

Definition at line 431 of file InputLoadType.f90.

    use memorymanagermodule, only: mem_deallocate
    use memorymanagerextmodule, only: memorystore_remove
    use simvariablesmodule, only: idm_context
    class(DynamicPkgLoadType), intent(inout) :: this
 
    ! clean up netcdf variables structure
    if (associated(this%nc_vars)) then
      call this%nc_vars%destroy()
      deallocate (this%nc_vars)
      nullify (this%nc_vars)
    end if
 
    ! deallocate package static and dynamic input context
    call memorystore_remove(this%mf6_input%component_name, &
                            this%mf6_input%subcomponent_name, &
                            idm_context)

Here is the call graph for this function:

dynamic_df()

subroutine inputloadtypemodule::dynamic_df

(

class(dynamicpkgloadtype), intent(inout)

this

)

Definition at line 415 of file InputLoadType.f90.

    class(DynamicPkgLoadType), intent(inout) :: this
    ! override in derived type

dynamic_init()

subroutine inputloadtypemodule::dynamic_init ( class(dynamicpkgloadtype), 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, integer(i4b), intent(in)  iout  )

private

Any managed memory pointed to from model/package context must be allocated when dynamic loader is initialized.

Definition at line 342 of file InputLoadType.f90.

    use simvariablesmodule, only: errmsg
    use inputdefinitionmodule, only: inputparamdefinitiontype
    use definitionselectmodule, only: idt_datatype
    class(DynamicPkgLoadType), 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
    integer(I4B), intent(in) :: iout
    type(InputParamDefinitionType), pointer :: idt
    integer(I4B) :: iparam, ilen
 
    this%mf6_input = mf6_input
    this%component_name = component_name
    this%component_input_name = component_input_name
    this%input_name = input_name
    this%readasarrays = .false.
    this%readarraygrid = .false.
    this%has_setting = .false.
    this%iperblock = iperblock
    this%nparam = 0
    this%iout = iout
    nullify (idt)
 
    ! throw error and exit if not found
    if (this%iperblock == 0) then
      write (errmsg, '(a,a)') &
        'Programming error. (IDM) PERIOD block not found in '&
        &'dynamic package input block dfns: ', &
        trim(mf6_input%subcomponent_name)
      call store_error(errmsg)
      call store_error_filename(this%input_name)
    end if
 
    ! set readasarrays and readarraygrid
    if (mf6_input%block_dfns(iperblock)%aggregate) then
      ! no-op
    else
      do iparam = 1, size(mf6_input%param_dfns)
        idt => mf6_input%param_dfns(iparam)
        if (idt%blockname == 'OPTIONS') then
          select case (idt%tagname)
          case ('READASARRAYS')
            this%readasarrays = .true.
          case ('READARRAYGRID')
            this%readarraygrid = .true.
          case default
            ! no-op
          end select
        end if
      end do
    end if
 
    ! determine if has setting type
    do iparam = 1, size(mf6_input%param_dfns)
      idt => mf6_input%param_dfns(iparam)
      if (idt%blockname == 'PERIOD') then
        if (idt_datatype(idt) == 'KEYSTRING') then
          ilen = len_trim(idt%tagname)
          if (idt%tagname(ilen - 6:ilen) == 'SETTING') then
            this%has_setting = .true.
          end if
        end if
      end if
    end do

Here is the call graph for this function:

dynamicpkgs_ad()

subroutine inputloadtypemodule::dynamicpkgs_ad ( class(modeldynamicpkgstype), intent(inout)  this )

private

Definition at line 531 of file InputLoadType.f90.

    class(ModelDynamicPkgsType), intent(inout) :: this
    class(DynamicPkgLoadBaseType), pointer :: dynamic_pkg
    integer(I4B) :: n
    do n = 1, this%pkglist%Count()
      dynamic_pkg => this%get(n)
      call dynamic_pkg%ad()
    end do

dynamicpkgs_add()

subroutine inputloadtypemodule::dynamicpkgs_add ( class(modeldynamicpkgstype), intent(inout)  this, class(dynamicpkgloadbasetype), intent(inout), pointer  dynamic_pkg  )

private

Definition at line 473 of file InputLoadType.f90.

    class(ModelDynamicPkgsType), intent(inout) :: this
    class(DynamicPkgLoadBaseType), pointer, intent(inout) :: dynamic_pkg
    class(*), pointer :: obj
    obj => dynamic_pkg
    call this%pkglist%add(obj)

dynamicpkgs_destroy()

subroutine inputloadtypemodule::dynamicpkgs_destroy ( class(modeldynamicpkgstype), intent(inout)  this )

private

Definition at line 553 of file InputLoadType.f90.

    class(ModelDynamicPkgsType), intent(inout) :: this
    class(DynamicPkgLoadBaseType), pointer :: dynamic_pkg
    integer(I4B) :: n
    ! destroy dynamic loaders
    do n = 1, this%pkglist%Count()
      dynamic_pkg => this%get(n)
      call dynamic_pkg%destroy()
      deallocate (dynamic_pkg)
      nullify (dynamic_pkg)
    end do
    call this%pkglist%Clear()

dynamicpkgs_df()

subroutine inputloadtypemodule::dynamicpkgs_df

(

class(modeldynamicpkgstype), intent(inout)

this

)

Definition at line 518 of file InputLoadType.f90.

    class(ModelDynamicPkgsType), intent(inout) :: this
    class(DynamicPkgLoadBaseType), pointer :: dynamic_pkg
    integer(I4B) :: n
    do n = 1, this%pkglist%Count()
      dynamic_pkg => this%get(n)
      call dynamic_pkg%df()
    end do

dynamicpkgs_get()

class(dynamicpkgloadbasetype) function, pointer inputloadtypemodule::dynamicpkgs_get ( class(modeldynamicpkgstype), intent(inout)  this, integer(i4b), intent(in)  idx  )

private

Definition at line 484 of file InputLoadType.f90.

    class(ModelDynamicPkgsType), intent(inout) :: this
    integer(I4B), intent(in) :: idx
    class(DynamicPkgLoadBaseType), pointer :: res
    class(*), pointer :: obj
    nullify (res)
    obj => this%pkglist%GetItem(idx)
    if (associated(obj)) then
      select type (obj)
      class is (dynamicpkgloadbasetype)
        res => obj
      end select
    end if

dynamicpkgs_init()

subroutine inputloadtypemodule::dynamicpkgs_init	(	class(modeldynamicpkgstype), intent(inout)	this,
		character(len=*), intent(in)	modeltype,
		character(len=*), intent(in)	modelname,
		character(len=*), intent(in)	modelfname,
		character(len=*), intent(in)	nc_fname,
		integer(i4b), intent(in)	ncid,
		integer(i4b), intent(in)	iout
	)

Definition at line 453 of file InputLoadType.f90.

    class(ModelDynamicPkgsType), intent(inout) :: this
    character(len=*), intent(in) :: modeltype
    character(len=*), intent(in) :: modelname
    character(len=*), intent(in) :: modelfname
    character(len=*), intent(in) :: nc_fname
    integer(I4B), intent(in) :: ncid
    integer(I4B), intent(in) :: iout
    this%modeltype = modeltype
    this%modelname = modelname
    this%modelfname = modelfname
    this%nc_fname = nc_fname
    this%ncid = ncid
    this%iout = iout

dynamicpkgs_rp()

subroutine inputloadtypemodule::dynamicpkgs_rp ( class(modeldynamicpkgstype), intent(inout)  this )

private

Definition at line 502 of file InputLoadType.f90.

    use idmloggermodule, only: idm_log_period_header, idm_log_period_close
    class(ModelDynamicPkgsType), intent(inout) :: this
    class(DynamicPkgLoadBaseType), pointer :: dynamic_pkg
    integer(I4B) :: n
    call idm_log_period_header(this%modelname, this%iout)
    do n = 1, this%pkglist%Count()
      dynamic_pkg => this%get(n)
      call dynamic_pkg%rp()
    end do
    call idm_log_period_close(this%iout)

Here is the call graph for this function:

dynamicpkgs_size()

integer(i4b) function inputloadtypemodule::dynamicpkgs_size ( class(modeldynamicpkgstype), intent(inout)  this )

private

Definition at line 544 of file InputLoadType.f90.

    class(ModelDynamicPkgsType), intent(inout) :: this
    integer(I4B) :: size
    size = this%pkglist%Count()

getdynamicmodelfromlist()

class(modeldynamicpkgstype) function, pointer, public inputloadtypemodule::getdynamicmodelfromlist	(	type(listtype), intent(inout)	list,
		integer(i4b), intent(in)	idx
	)

Parameters

[in,out]	list	spd list
[in]	idx	package number

Definition at line 581 of file InputLoadType.f90.

    type(ListType), intent(inout) :: list !< spd list
    integer(I4B), intent(in) :: idx !< package number
    class(ModelDynamicPkgsType), pointer :: res
    class(*), pointer :: obj
    ! initialize res
    nullify (res)
    ! get the object from the list
    obj => list%GetItem(idx)
    if (associated(obj)) then
      select type (obj)
      class is (modeldynamicpkgstype)
        res => obj
      end select
    end if

Here is the caller graph for this function:

static_destroy()

subroutine inputloadtypemodule::static_destroy

(

class(staticpkgloadtype), intent(inout)

this

)

Definition at line 326 of file InputLoadType.f90.

    class(StaticPkgLoadType), intent(inout) :: this
    call this%subpkg_list%destroy()
    if (associated(this%nc_vars)) then
      call this%nc_vars%destroy()
      deallocate (this%nc_vars)
      nullify (this%nc_vars)
    end if

static_init()

subroutine inputloadtypemodule::static_init ( class(staticpkgloadtype), 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  )

private

Definition at line 244 of file InputLoadType.f90.

    class(StaticPkgLoadType), 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) :: iblock
 
    this%mf6_input = mf6_input
    this%component_name = component_name
    this%component_input_name = component_input_name
    this%input_name = input_name
    this%iperblock = 0
 
    ! create subpackage list
    call this%subpkg_list%create(this%mf6_input%mempath, &
                                 this%mf6_input%component_name)
 
    ! identify period block definition
    do iblock = 1, size(mf6_input%block_dfns)
      if (mf6_input%block_dfns(iblock)%blockname == 'PERIOD') then
        this%iperblock = iblock
        exit
      end if
    end do

subpkg_add()

subroutine inputloadtypemodule::subpkg_add ( class(subpackagelisttype)  this, character(len=*), intent(in)  pkgtype, character(len=*), intent(in)  component_type, character(len=*), intent(in)  subcomponent_type, character(len=*), intent(in)  tagname, character(len=*), intent(in)  filename  )

private

Definition at line 173 of file InputLoadType.f90.

    use arrayhandlersmodule, only: expandarray
    use memoryhelpermodule, only: create_mem_path
    use memorymanagermodule, only: mem_allocate
    use simvariablesmodule, only: idm_context
    class(SubPackageListType) :: this
    character(len=*), intent(in) :: pkgtype
    character(len=*), intent(in) :: component_type
    character(len=*), intent(in) :: subcomponent_type
    character(len=*), intent(in) :: tagname
    character(len=*), intent(in) :: filename
    character(len=LENVARNAME) :: mempath_tag
    character(len=LENMEMPATH), pointer :: subpkg_mempath
    character(len=LINELENGTH), pointer :: input_fname
    integer(I4B) :: idx, trimlen
 
    ! reallocate
    call expandarray(this%pkgtypes)
    call expandarray(this%component_types)
    call expandarray(this%subcomponent_types)
    call expandarray(this%filenames)
 
    ! add new package instance
    this%pnum = this%pnum + 1
    this%pkgtypes(this%pnum) = pkgtype
    this%component_types(this%pnum) = component_type
    this%subcomponent_types(this%pnum) = subcomponent_type
    this%filenames(this%pnum) = filename
 
    ! initialize mempath tag
    mempath_tag = tagname
    trimlen = len_trim(tagname)
    idx = 0
 
    ! create mempath tagname
    idx = index(tagname, '_')
    if (idx > 0) then
      if (tagname(idx + 1:trimlen) == 'FILENAME') then
        write (mempath_tag, '(a)') tagname(1:idx)//'MEMPATH'
      end if
    end if
 
    ! allocate mempath variable for subpackage
    call mem_allocate(subpkg_mempath, lenmempath, mempath_tag, &
                      this%mempath)
 
    ! create and set the mempath
    subpkg_mempath = &
      create_mem_path(this%component_name, &
                      subcomponent_type, idm_context)
 
    ! allocate and initialize filename for subpackage
    call mem_allocate(input_fname, linelength, 'INPUT_FNAME', subpkg_mempath)
    input_fname = filename

Here is the call graph for this function:

subpkg_create()

subroutine inputloadtypemodule::subpkg_create ( class(subpackagelisttype)  this, character(len=*), intent(in)  mempath, character(len=*), intent(in)  component_name  )

private

Definition at line 154 of file InputLoadType.f90.

    class(SubPackageListType) :: this
    character(len=*), intent(in) :: mempath
    character(len=*), intent(in) :: component_name
 
    ! initialize
    this%pnum = 0
    this%mempath = mempath
    this%component_name = component_name
 
    ! allocate arrays
    allocate (this%pkgtypes(0))
    allocate (this%component_types(0))
    allocate (this%subcomponent_types(0))
    allocate (this%filenames(0))

subpkg_destroy()

subroutine inputloadtypemodule::subpkg_destroy

(

class(subpackagelisttype)

this

)

Definition at line 232 of file InputLoadType.f90.

    class(SubPackageListType) :: this
    ! allocate arrays
    deallocate (this%pkgtypes)
    deallocate (this%component_types)
    deallocate (this%subcomponent_types)
    deallocate (this%filenames)

Variable Documentation

model_inputs

type(listtype), public inputloadtypemodule::model_inputs

Definition at line 148 of file InputLoadType.f90.

  type(ListType) :: model_inputs