idmmf6filemodule Module Reference

This module contains the IdmMf6FileModule. More...

Data Types
type	mf6filestaticpkgloadtype
	MF6File static loader type. More...
type	mf6filedynamicpkgloadtype
	MF6File dynamic loader type. More...

Functions/Subroutines
subroutine, public	input_load (filename, mf6_input, component_filename, iout, nc_vars)
	input load for traditional mf6 simulation static input file More...
subroutine	static_init (this, mf6_input, component_name, component_input_name, input_name)
	static loader init More...
class(dynamicpkgloadbasetype) function, pointer	static_load (this, iout)
	load routine for static loader More...
subroutine	static_destroy (this)
	static loader destroy More...
subroutine	dynamic_init (this, mf6_input, component_name, component_input_name, input_name, iperblock, iout)
	dynamic loader init More...
subroutine	dynamic_df (this)
	define routine for dynamic loader More...
subroutine	dynamic_ad (this)
	advance routine for dynamic loader More...
subroutine	dynamic_rp (this)
	read and prepare routine for dynamic loader More...
subroutine	dynamic_read_ionper (this)
	dynamic loader read ionper of next period block More...
subroutine	dynamic_create_loader (this)
	allocate a dynamic loader based on load context More...
subroutine	dynamic_destroy (this)
	dynamic loader destroy More...
integer(i4b) function, public	open_mf6file (filetype, filename, component_fname, iout)
	open a model package files More...

Detailed Description

This module contains high-level routines for loading MODFLOW 6 ASCII source input. This module implements the loader types that the IdmLoadModule creates and invokes. It also creates and manages dynamic ASCII input loaders for all supported types of MODFLOW 6 ASCII dynamic input.

Function/Subroutine Documentation

dynamic_ad()

subroutine idmmf6filemodule::dynamic_ad ( class(mf6filedynamicpkgloadtype), intent(inout)  this )

private

Definition at line 198 of file IdmMf6File.f90.

    class(Mf6FileDynamicPkgLoadType), intent(inout) :: this
    ! invoke loader advance
    call this%rp_loader%ad()

dynamic_create_loader()

subroutine idmmf6filemodule::dynamic_create_loader

(

class(mf6filedynamicpkgloadtype), intent(inout)

this

)

Definition at line 269 of file IdmMf6File.f90.

    use layerarrayloadmodule, only: layerarrayloadtype
    use gridarrayloadmodule, only: gridarrayloadtype
    use listloadmodule, only: listloadtype
    use mf6filesettingloadmodule, only: settingloadtype
    use mf6filestoinputmodule, only: stoinputtype
    use devfeaturemodule, only: dev_feature
    class(Mf6FileDynamicPkgLoadType), intent(inout) :: this
    class(ListLoadType), pointer :: list_loader
    class(GridArrayLoadType), pointer :: arrgrid_loader
    class(LayerArrayLoadType), pointer :: arrlayer_loader
    class(SettingLoadType), pointer :: setting_loader
    class(StoInputType), pointer :: sto_loader
 
    ! allocate and set loader
    if (this%mf6_input%subcomponent_type == 'STO') then
      allocate (sto_loader)
      this%rp_loader => sto_loader
    else if (this%mf6_input%subcomponent_type == 'PRP') then
      allocate (setting_loader)
      this%rp_loader => setting_loader
    else if (this%readasarrays) then
      allocate (arrlayer_loader)
      this%rp_loader => arrlayer_loader
    else if (this%readarraygrid) then
      call dev_feature('Input file "'//trim(this%input_name)// &
        '" READARRAYGRID option is still under development, install the &
        &nightly build or compile from source with IDEVELOPMODE = 1.', &
        this%iout)
      allocate (arrgrid_loader)
      this%rp_loader => arrgrid_loader
    else
      allocate (list_loader)
      this%rp_loader => list_loader
    end if
 
    ! set nc_vars pointer
    this%rp_loader%nc_vars => this%nc_vars
 
    ! initialize loader
    call this%rp_loader%ainit(this%mf6_input, &
                              this%component_name, &
                              this%component_input_name, &
                              this%input_name, &
                              this%iperblock, &
                              this%parser, &
                              this%iout)

Here is the call graph for this function:

dynamic_destroy()

subroutine idmmf6filemodule::dynamic_destroy

(

class(mf6filedynamicpkgloadtype), intent(inout)

this

)

Definition at line 320 of file IdmMf6File.f90.

    use memorymanagermodule, only: mem_deallocate
    class(Mf6FileDynamicPkgLoadType), intent(inout) :: this
 
    ! deallocate scalars
    call mem_deallocate(this%iper)
    call mem_deallocate(this%ionper)
 
    ! deallocate loader
    nullify (this%rp_loader%nc_vars)
    call this%rp_loader%destroy()
    deallocate (this%rp_loader)
 
    ! deallocate parser
    call this%parser%clear()
    deallocate (this%parser)
 
    ! deallocate input context
    call this%DynamicPkgLoadType%destroy()

dynamic_df()

subroutine idmmf6filemodule::dynamic_df

(

class(mf6filedynamicpkgloadtype), intent(inout)

this

)

Definition at line 188 of file IdmMf6File.f90.

    class(Mf6FileDynamicPkgLoadType), intent(inout) :: this
    ! invoke loader define
    call this%rp_loader%df()
    ! read first ionper
    call this%read_ionper()

dynamic_init()

subroutine idmmf6filemodule::dynamic_init ( class(mf6filedynamicpkgloadtype), 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

Definition at line 149 of file IdmMf6File.f90.

    use memorymanagermodule, only: mem_allocate
    use inputdefinitionmodule, only: inputparamdefinitiontype
    class(Mf6FileDynamicPkgLoadType), 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
    integer(I4B) :: inunit
 
    ! initialize base loader
    call this%DynamicPkgLoadType%init(mf6_input, component_name, &
                                      component_input_name, input_name, &
                                      iperblock, iout)
    ! allocate scalars
    call mem_allocate(this%iper, 'IPER', mf6_input%mempath)
    call mem_allocate(this%ionper, 'IONPER', mf6_input%mempath)
 
    ! initialize
    this%iper = 0
    this%ionper = 0
 
    ! open input file
    inunit = open_mf6file(mf6_input%pkgtype, input_name, &
                          component_input_name, iout)
 
    ! allocate and initialize parser
    allocate (this%parser)
    call this%parser%Initialize(inunit, iout)
 
    ! allocate and initialize loader
    call this%create_loader()

Here is the call graph for this function:

dynamic_read_ionper()

subroutine idmmf6filemodule::dynamic_read_ionper

(

class(mf6filedynamicpkgloadtype), intent(inout)

this

)

Definition at line 229 of file IdmMf6File.f90.

    use tdismodule, only: kper, nper
    class(Mf6FileDynamicPkgLoadType), intent(inout) :: this
    character(len=LINELENGTH) :: line
    logical(LGP) :: isblockfound
    integer(I4B) :: ierr
    character(len=*), parameter :: fmtblkerr = &
      &"('Looking for BEGIN PERIOD iper.  Found ', a, ' instead.')"
 
    call this%parser%GetBlock('PERIOD', isblockfound, ierr, &
                              supportopenclose=.true., &
                              blockrequired=.false.)
    ! set first period block IPER
    if (isblockfound) then
      this%ionper = this%parser%GetInteger()
      if (this%ionper <= this%iper) then
        write (errmsg, '(a, i0, a, i0, a, i0, a)') &
          'Error in stress period ', kper, &
          '. Period numbers not increasing.  Found ', this%ionper, &
          ' but last period block was assigned ', this%iper, '.'
        call store_error(errmsg)
        call this%parser%StoreErrorUnit()
      end if
    else
      ! PERIOD block not found
      if (ierr < 0) then
        ! End of file found; data applies for remainder of simulation.
        this%ionper = nper + 1
      else
        ! Found invalid block
        call this%parser%GetCurrentLine(line)
        write (errmsg, fmtblkerr) adjustl(trim(line))
        call store_error(errmsg)
        call this%parser%StoreErrorUnit()
      end if
    end if

Here is the call graph for this function:

dynamic_rp()

subroutine idmmf6filemodule::dynamic_rp ( class(mf6filedynamicpkgloadtype), intent(inout)  this )

private

Definition at line 206 of file IdmMf6File.f90.

    use tdismodule, only: kper, nper
    class(Mf6FileDynamicPkgLoadType), intent(inout) :: this
 
    ! check if ready to load
    if (this%ionper /= kper) return
 
    ! dynamic load
    call this%rp_loader%rp(this%parser)
 
    ! update loaded iper
    this%iper = kper
 
    ! read next iper
    if (kper < nper) then
      call this%read_ionper()
    else
      this%ionper = nper + 1
    end if

input_load()

subroutine, public idmmf6filemodule::input_load	(	character(len=*), intent(in)	filename,
		type(modflowinputtype), intent(in)	mf6_input,
		character(len=*), intent(in)	component_filename,
		integer(i4b), intent(in)	iout,
		type(ncpackagevarstype), intent(in), optional, pointer	nc_vars
	)

Parameters

[in]	component_filename	component (e.g. model) filename
[in]	iout	unit number for output

Definition at line 58 of file IdmMf6File.f90.

    use loadmf6filemodule, only: loadmf6filetype
    character(len=*), intent(in) :: filename
    type(ModflowInputType), intent(in) :: mf6_input
    character(len=*), intent(in) :: component_filename !< component (e.g. model) filename
    integer(I4B), intent(in) :: iout !< unit number for output
    type(NCPackageVarsType), pointer, optional, intent(in) :: nc_vars
    type(BlockParserType), allocatable, target :: parser !< block parser
    type(NCPackageVarsType), pointer :: netcdf_vars
    type(LoadMf6FileType) :: loader
    integer(I4B) :: inunit
 
    if (present(nc_vars)) then
      netcdf_vars => nc_vars
    else
      nullify (netcdf_vars)
    end if
 
    ! open input file
    inunit = open_mf6file(mf6_input%pkgtype, filename, component_filename, iout)
 
    ! allocate and initialize parser
    allocate (parser)
    call parser%Initialize(inunit, iout)
 
    ! invoke the load routine
    call loader%load(parser, mf6_input, netcdf_vars, filename, iout)
 
    ! clear parser file handles
    call parser%clear()
 
    ! cleanup
    deallocate (parser)

Here is the call graph for this function:

Here is the caller graph for this function:

open_mf6file()

integer(i4b) function, public idmmf6filemodule::open_mf6file	(	character(len=*), intent(in)	filetype,
		character(len=*), intent(in)	filename,
		character(len=*), intent(in)	component_fname,
		integer(i4b), intent(in)	iout
	)

Definition at line 343 of file IdmMf6File.f90.

    use inputoutputmodule, only: openfile, getunit
    character(len=*), intent(in) :: filetype
    character(len=*), intent(in) :: filename
    character(len=*), intent(in) :: component_fname
    integer(I4B), intent(in) :: iout
    integer(I4B) :: inunit
 
    ! initialize
    inunit = 0
 
    if (filename /= '') then
      ! get unit number and open file
      inunit = getunit()
      call openfile(inunit, iout, trim(adjustl(filename)), filetype, &
                    'FORMATTED', 'SEQUENTIAL', 'OLD')
    else
      write (errmsg, '(a,a,a)') &
        'File unspecified, cannot load model or package &
        &type "', trim(filetype), '".'
      call store_error(errmsg)
      call store_error_filename(component_fname)
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

static_destroy()

subroutine idmmf6filemodule::static_destroy ( class(mf6filestaticpkgloadtype), intent(inout)  this )

private

Definition at line 141 of file IdmMf6File.f90.

    class(Mf6FileStaticPkgLoadType), intent(inout) :: this
    ! deallocate base type
    call this%StaticPkgLoadType%destroy()

static_init()

subroutine idmmf6filemodule::static_init	(	class(mf6filestaticpkgloadtype), 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
	)

Definition at line 95 of file IdmMf6File.f90.

    class(Mf6FileStaticPkgLoadType), 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
    ! initialize base type
    call this%StaticPkgLoadType%init(mf6_input, component_name, &
                                     component_input_name, input_name)

static_load()

class(dynamicpkgloadbasetype) function, pointer idmmf6filemodule::static_load ( class(mf6filestaticpkgloadtype), intent(inout)  this, integer(i4b), intent(in)  iout  )

private

Definition at line 109 of file IdmMf6File.f90.

    class(Mf6FileStaticPkgLoadType), intent(inout) :: this
    integer(I4B), intent(in) :: iout
    class(DynamicPkgLoadBaseType), pointer :: rp_loader
    class(Mf6FileDynamicPkgLoadType), pointer :: mf6_loader
 
    ! initialize return pointer
    nullify (rp_loader)
 
    ! load model package to input context
    if (this%iperblock > 0) then
      ! allocate dynamic loader
      allocate (mf6_loader)
      ! point to nc_vars structure
      mf6_loader%nc_vars => this%nc_vars
      ! nullify nc_vars pointer so it isn't deallocated
      nullify (this%nc_vars)
      ! initialize dynamic loader
      call mf6_loader%init(this%mf6_input, this%component_name, &
                           this%component_input_name, this%input_name, &
                           this%iperblock, iout)
      ! set return pointer to base dynamic loader
      rp_loader => mf6_loader
    else
      ! load static input
      call input_load(this%input_name, this%mf6_input, &
                      this%component_input_name, iout, this%nc_vars)
    end if

Here is the call graph for this function: