inputloadtypemodule Module Reference

This module contains the InputLoadTypeModule. More...

Data Types
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	static_init (this, mf6_input, component_name, component_input_name, input_name)
	initialize static package loader 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, modelname, modelfname, 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...

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 383 of file InputLoadType.f90.

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

Here is the caller graph for this function:

dynamic_ad()

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

private

Definition at line 218 of file InputLoadType.f90.

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

dynamic_destroy()

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

private

Definition at line 229 of file InputLoadType.f90.

    use memorymanagermodule, only: mem_deallocate
    use memorymanagerextmodule, only: memorylist_remove
    use simvariablesmodule, only: idm_context
    class(DynamicPkgLoadType), intent(inout) :: this
    !
    ! -- deallocate package static and dynamic input context
    call memorylist_remove(this%mf6_input%component_name, &
                           this%mf6_input%subcomponent_name, &
                           idm_context)
    !
    return

Here is the call graph for this function:

dynamic_df()

subroutine inputloadtypemodule::dynamic_df

(

class(dynamicpkgloadtype), intent(inout)

this

)

Definition at line 207 of file InputLoadType.f90.

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

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 164 of file InputLoadType.f90.

    use simvariablesmodule, only: errmsg
    use inputdefinitionmodule, only: inputparamdefinitiontype
    ! -- dummy
    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
    !
    this%mf6_input = mf6_input
    this%component_name = component_name
    this%component_input_name = component_input_name
    this%input_name = input_name
    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
    this%readasarrays = (.not. mf6_input%block_dfns(iperblock)%aggregate)
    !
    ! -- return
    return

Here is the call graph for this function:

dynamicpkgs_ad()

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

private

Definition at line 335 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
    !
    return

dynamicpkgs_add()

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

private

Definition at line 262 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)
    !
    return

dynamicpkgs_destroy()

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

private

Definition at line 363 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%destroy()
      deallocate (dynamic_pkg)
      nullify (dynamic_pkg)
    end do
    !
    call this%pkglist%Clear()
    !
    return

dynamicpkgs_df()

subroutine inputloadtypemodule::dynamicpkgs_df

(

class(modeldynamicpkgstype), intent(inout)

this

)

Definition at line 319 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
    !
    return

dynamicpkgs_get()

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

private

Definition at line 276 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
    !
    return

dynamicpkgs_init()

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

Definition at line 246 of file InputLoadType.f90.

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

dynamicpkgs_rp()

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

private

Definition at line 298 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)
    !
    return

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 351 of file InputLoadType.f90.

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

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 400 of file InputLoadType.f90.

    ! -- dummy variables
    type(ListType), intent(inout) :: list !< spd list
    integer(I4B), intent(in) :: idx !< package number
    class(ModelDynamicPkgsType), pointer :: res
    ! -- local variables
    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
    !
    ! -- return
    return

Here is the caller graph for this function:

static_destroy()

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

private

Definition at line 152 of file InputLoadType.f90.

    class(StaticPkgLoadType), intent(inout) :: this
    !
    return

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 125 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
    !
    ! -- 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
    !
    return