ModelPackageInput.f90

Go to the documentation of this file.

!> @brief This module contains the ModelPackageInputModule
!!
!! Add an input model type to routines in this module
!! to integrate the Model with IDM.
!!
!<
module modelpackageinputmodule
 
  use kindmodule, only: dp, i4b, lgp
  use simvariablesmodule, only: errmsg
  use constantsmodule, only: lenftype, lenpackagetype
  use simmodule, only: store_error, store_error_filename
  use chfmodule, only: chf_nbasepkg, chf_nmultipkg, &
                       chf_basepkg, chf_multipkg
  use gwemodule, only: gwe_nbasepkg, gwe_nmultipkg, &
                       gwe_basepkg, gwe_multipkg
  use gwfmodule, only: gwf_nbasepkg, gwf_nmultipkg, &
                       gwf_basepkg, gwf_multipkg
  use gwtmodule, only: gwt_nbasepkg, gwt_nmultipkg, &
                       gwt_basepkg, gwt_multipkg
  use olfmodule, only: olf_nbasepkg, olf_nmultipkg, &
                       olf_basepkg, olf_multipkg
  use prtmodule, only: prt_nbasepkg, prt_nmultipkg, &
                       prt_basepkg, prt_multipkg
 
  implicit none
 
  private
  public :: supported_model_packages
  public :: multi_package_type
  public :: nmodel, modflow6models
 
  !> @brief Valid simulation model types
  !!
  integer(I4B), parameter :: nmodel = 10
  character(len=LENPACKAGETYPE), dimension(NMODEL) :: modflow6models
  data modflow6models/'CHF6 ', 'GWE6 ', 'GWF6 ', 'GWT6 ', 'OLF6 ', & !  5
                    &'PRT6 ', '     ', '     ', '     ', '     '/ ! 10
 
contains
 
  !> @brief set supported package types for model
  !!
  !! Allocate a list of package types supported
  !! by the model.  Base packages should be listed
  !! first as list determines load order.
  !!
  !<
  subroutine supported_model_packages(mtype, pkgtypes, numpkgs)
    ! -- modules
    ! -- dummy
    character(len=LENFTYPE), intent(in) :: mtype
    character(len=LENPACKAGETYPE), dimension(:), allocatable, &
      intent(inout) :: pkgtypes
    integer(I4B), intent(inout) :: numpkgs
    ! -- local
    !
    select case (mtype)
    case ('CHF6')
      numpkgs = chf_nbasepkg + chf_nmultipkg
      allocate (pkgtypes(numpkgs))
      pkgtypes = [chf_basepkg, chf_multipkg]
    case ('GWE6')
      numpkgs = gwe_nbasepkg + gwe_nmultipkg
      allocate (pkgtypes(numpkgs))
      pkgtypes = [gwe_basepkg, gwe_multipkg]
    case ('GWF6')
      numpkgs = gwf_nbasepkg + gwf_nmultipkg
      allocate (pkgtypes(numpkgs))
      pkgtypes = [gwf_basepkg, gwf_multipkg]
    case ('GWT6')
      numpkgs = gwt_nbasepkg + gwt_nmultipkg
      allocate (pkgtypes(numpkgs))
      pkgtypes = [gwt_basepkg, gwt_multipkg]
    case ('OLF6')
      numpkgs = olf_nbasepkg + olf_nmultipkg
      allocate (pkgtypes(numpkgs))
      pkgtypes = [olf_basepkg, olf_multipkg]
    case ('PRT6')
      numpkgs = prt_nbasepkg + prt_nmultipkg
      allocate (pkgtypes(numpkgs))
      pkgtypes = [prt_basepkg, prt_multipkg]
    case default
    end select
  end subroutine supported_model_packages
 
  !> @brief Is the package multi-instance
  !<
  function multi_package_type(mtype_component, ptype_component, pkgtype) &
    result(multi_package)
    ! -- modules
    ! -- dummy
    character(len=LENFTYPE), intent(in) :: mtype_component
    character(len=LENFTYPE), intent(in) :: ptype_component
    character(len=LENFTYPE), intent(in) :: pkgtype
    ! -- return
    logical(LGP) :: multi_package
    ! -- local
    integer(I4B) :: n
    !
    multi_package = .false.
    !
    select case (mtype_component)
    case ('CHF')
      do n = 1, chf_nmultipkg
        if (chf_multipkg(n) == pkgtype) then
          multi_package = .true.
          exit
        end if
      end do
      !
    case ('GWE')
      do n = 1, gwe_nmultipkg
        if (gwe_multipkg(n) == pkgtype) then
          multi_package = .true.
          exit
        end if
      end do
      !
    case ('GWF')
      do n = 1, gwf_nmultipkg
        if (gwf_multipkg(n) == pkgtype) then
          multi_package = .true.
          exit
        end if
      end do
      !
    case ('GWT')
      do n = 1, gwt_nmultipkg
        if (gwt_multipkg(n) == pkgtype) then
          multi_package = .true.
          exit
        end if
      end do
      !
    case ('OLF')
      do n = 1, olf_nmultipkg
        if (olf_multipkg(n) == pkgtype) then
          multi_package = .true.
          exit
        end if
      end do
      !
    case ('PRT')
      do n = 1, prt_nmultipkg
        if (prt_multipkg(n) == pkgtype) then
          multi_package = .true.
          exit
        end if
      end do
      !
    case default
    end select
  end function multi_package_type
 
end module modelpackageinputmodule