modflowinputmodule Module Reference

This module contains the ModflowInputModule. More...

Data Types
type	modflowinputtype
	derived type for storing input definition for a file More...

Functions/Subroutines
type(modflowinputtype) function, public	getmodflowinput (pkgtype, component_type, subcomponent_type, component_name, subcomponent_name, load_scope, filename)
	function to return ModflowInputType More...
character(len=lenpackagetype) function	update_sc_type (filetype, filename, component_type, subcomponent_type)
character(len=lenpackagetype) function	readarray (filetype, filename, component_type, subcomponent_type)

Detailed Description

This module contains a helper object and function for accessing the ModflowInput, which is a description of the structure of a modflow input file.

Function/Subroutine Documentation

getmodflowinput()

type(modflowinputtype) function, public modflowinputmodule::getmodflowinput	(	character(len=*), intent(in)	pkgtype,
		character(len=*), intent(in)	component_type,
		character(len=*), intent(in)	subcomponent_type,
		character(len=*), intent(in)	component_name,
		character(len=*), intent(in)	subcomponent_name,
		character(len=*), intent(in)	load_scope,
		character(len=*), intent(in), optional	filename
	)

Parameters

[in]	pkgtype	package type to load, such as DIS6, DISV6, NPF6
[in]	component_type	component type, such as GWF or GWT
[in]	subcomponent_type	subcomponent type, such as DIS or NPF
[in]	component_name	component name, such as MYGWFMODEL
[in]	subcomponent_name	subcomponent name, such as MYWELLPACKAGE
[in]	load_scope	e.g. SIM, MODEL, EXCHANGE
[in]	filename	optional name of package input file

Definition at line 52 of file ModflowInput.f90.

    character(len=*), intent(in) :: pkgtype !< package type to load, such as DIS6, DISV6, NPF6
    character(len=*), intent(in) :: component_type !< component type, such as GWF or GWT
    character(len=*), intent(in) :: subcomponent_type !< subcomponent type, such as DIS or NPF
    character(len=*), intent(in) :: component_name !< component name, such as MYGWFMODEL
    character(len=*), intent(in) :: subcomponent_name !< subcomponent name, such as MYWELLPACKAGE
    character(len=*), intent(in) :: load_scope !< e.g. SIM, MODEL, EXCHANGE
    character(len=*), optional, intent(in) :: filename !< optional name of package input file
    type(ModflowInputType) :: mf6_input
    character(len=LENPACKAGETYPE) :: dfn_subcomponent_type
 
    ! set subcomponent type
    if (present(filename)) then
      dfn_subcomponent_type = update_sc_type(pkgtype, filename, component_type, &
                                             subcomponent_type)
    else
      dfn_subcomponent_type = trim(subcomponent_type)
    end if
 
    ! set input attributes
    mf6_input%pkgtype = trim(pkgtype)
    mf6_input%component_type = trim(component_type)
    mf6_input%subcomponent_type = trim(dfn_subcomponent_type)
    mf6_input%component_name = trim(component_name)
    mf6_input%subcomponent_name = trim(subcomponent_name)
    mf6_input%load_scope = trim(load_scope)
 
    ! set mempaths
    mf6_input%mempath = create_mem_path(component_name, subcomponent_name, &
                                        idm_context)
    mf6_input%component_mempath = create_mem_path(component=component_name, &
                                                  context=idm_context)
 
    ! set input definitions
    mf6_input%block_dfns => block_definitions(mf6_input%component_type, &
                                              mf6_input%subcomponent_type)
    mf6_input%aggregate_dfns => aggregate_definitions(mf6_input%component_type, &
                                                      mf6_input%subcomponent_type)
    mf6_input%param_dfns => param_definitions(mf6_input%component_type, &
                                              mf6_input%subcomponent_type)

Here is the call graph for this function:

Here is the caller graph for this function:

readarray()

character(len=lenpackagetype) function modflowinputmodule::readarray ( character(len=*), intent(in)  filetype, character(len=*), intent(in)  filename, character(len=*), intent(in)  component_type, character(len=*), intent(in)  subcomponent_type  )

private

Definition at line 113 of file ModflowInput.f90.

    use constantsmodule, only: linelength
    use inputoutputmodule, only: openfile, getunit
    use blockparsermodule, only: blockparsertype
    character(len=*), intent(in) :: component_type
    character(len=*), intent(in) :: subcomponent_type
    character(len=*), intent(in) :: filetype
    character(len=*), intent(in) :: filename
    character(len=LENPACKAGETYPE) :: sc_type
    type(BlockParserType) :: parser
    integer(I4B) :: ierr, inunit
    logical(LGP) :: isfound
    logical(LGP) :: endOfBlock
    character(len=LINELENGTH) :: keyword
 
    sc_type = subcomponent_type
    inunit = getunit()
    call openfile(inunit, 0, trim(adjustl(filename)), filetype, &
                  'FORMATTED', 'SEQUENTIAL', 'OLD')
    call parser%Initialize(inunit, 0)
 
    ! get options block
    call parser%GetBlock('OPTIONS', isfound, ierr, &
                         supportopenclose=.true., blockrequired=.false.)
 
    ! parse options block if detected
    if (isfound) then
      do
        call parser%GetNextLine(endofblock)
        if (endofblock) exit
        call parser%GetStringCaps(keyword)
        select case (keyword)
        case ('READASARRAYS')
          write (sc_type, '(a)') trim(subcomponent_type)//'A'
        case ('READARRAYGRID')
          write (sc_type, '(a)') trim(subcomponent_type)//'G'
        case default
        end select
      end do
    end if
 
    call parser%clear()

Here is the call graph for this function:

Here is the caller graph for this function:

update_sc_type()

character(len=lenpackagetype) function modflowinputmodule::update_sc_type ( character(len=*), intent(in)  filetype, character(len=*), intent(in)  filename, character(len=*), intent(in)  component_type, character(len=*), intent(in)  subcomponent_type  )

private

Definition at line 97 of file ModflowInput.f90.

    character(len=*), intent(in) :: component_type
    character(len=*), intent(in) :: subcomponent_type
    character(len=*), intent(in) :: filetype
    character(len=*), intent(in) :: filename
    character(len=LENPACKAGETYPE) :: sc_type
    sc_type = subcomponent_type
    select case (subcomponent_type)
    case ('CHD', 'DRN', 'EVT', 'GHB', 'RCH', 'RIV', 'SCP', 'WEL')
      sc_type = readarray(filetype, filename, component_type, &
                          subcomponent_type)
    case default
    end select

Here is the call graph for this function:

Here is the caller graph for this function: