gwfgweexchangemodule Module Reference

Data Types
type	gwfgweexchangetype

Functions/Subroutines
subroutine, public	gwfgwe_cr (filename, id, m1_id, m2_id)
	Create a new GWF to GWE exchange object. More...
subroutine	set_model_pointers (this)
	Allocate and read. More...
subroutine	exg_df (this)
	Define the GwfGwe Exchange object. More...
subroutine	exg_ar (this)
	Allocate and read. More...
subroutine	gwfconn2gweconn (this, gwfModel, gweModel)
	Link GWE connections to GWF connections or exchanges. More...
subroutine	link_connections (this, gweConn, gwfConn)
	Links a GWE connection to its GWF counterpart. More...
subroutine	exg_da (this)
	Deallocate memory. More...
subroutine	allocate_scalars (this)
	Allocate GwfGwe exchange scalars. More...
subroutine	gwfbnd2gwefmi (this)
	Call routines in FMI that will set pointers to the necessary flow data (SIMVALS and SIMTOMVR) stored within each GWF flow package. More...

Function/Subroutine Documentation

allocate_scalars()

subroutine gwfgweexchangemodule::allocate_scalars

(

class(gwfgweexchangetype)

this

)

Definition at line 511 of file exg-gwfgwe.f90.

    ! -- modules
    use memorymanagermodule, only: mem_allocate
    ! -- dummy
    class(GwfGweExchangeType) :: this
    !
    call mem_allocate(this%m1_idx, 'M1ID', this%memoryPath)
    call mem_allocate(this%m2_idx, 'M2ID', this%memoryPath)
    this%m1_idx = 0
    this%m2_idx = 0

exg_ar()

subroutine gwfgweexchangemodule::exg_ar

(

class(gwfgweexchangetype)

this

)

Definition at line 181 of file exg-gwfgwe.f90.

    ! -- modules
    use memorymanagermodule, only: mem_checkin
    use dismodule, only: distype
    use disvmodule, only: disvtype
    use disumodule, only: disutype
    ! -- dummy
    class(GwfGweExchangeType) :: this
    ! -- local
    class(BaseModelType), pointer :: mb => null()
    type(GwfModelType), pointer :: gwfmodel => null()
    type(GweModelType), pointer :: gwemodel => null()
    ! -- formats
    character(len=*), parameter :: fmtdiserr = &
      "('GWF and GWE Models do not have the same discretization for exchange&
      & ',a,'.&
      &  GWF Model has ', i0, ' user nodes and ', i0, ' reduced nodes.&
      &  GWE Model has ', i0, ' user nodes and ', i0, ' reduced nodes.&
      &  Ensure discretization packages, including IDOMAIN, are identical.')"
    character(len=*), parameter :: fmtidomerr = &
      "('GWF and GWE Models do not have the same discretization for exchange&
      & ',a,'.&
      &  GWF Model and GWE Model have different IDOMAIN arrays.&
      &  Ensure discretization packages, including IDOMAIN, are identical.')"
    !
    ! -- set gwfmodel
    mb => getbasemodelfromlist(basemodellist, this%m1_idx)
    select type (mb)
    type is (gwfmodeltype)
      gwfmodel => mb
    end select
    !
    ! -- set gwemodel
    mb => getbasemodelfromlist(basemodellist, this%m2_idx)
    select type (mb)
    type is (gwemodeltype)
      gwemodel => mb
    end select
    !
    ! -- Check to make sure sizes are identical
    if (gwemodel%dis%nodes /= gwfmodel%dis%nodes .or. &
        gwemodel%dis%nodesuser /= gwfmodel%dis%nodesuser) then
      write (errmsg, fmtdiserr) trim(this%name), &
        gwfmodel%dis%nodesuser, &
        gwfmodel%dis%nodes, &
        gwemodel%dis%nodesuser, &
        gwemodel%dis%nodes
      call store_error(errmsg, terminate=.true.)
    end if
    !
    ! -- Make sure idomains are identical
    select type (gwfdis => gwfmodel%dis)
    type is (distype)
      select type (gwedis => gwemodel%dis)
      type is (distype)
        if (.not. all(gwfdis%idomain == gwedis%idomain)) then
          write (errmsg, fmtidomerr) trim(this%name)
          call store_error(errmsg, terminate=.true.)
        end if
      end select
    type is (disvtype)
      select type (gwedis => gwemodel%dis)
      type is (disvtype)
        if (.not. all(gwfdis%idomain == gwedis%idomain)) then
          write (errmsg, fmtidomerr) trim(this%name)
          call store_error(errmsg, terminate=.true.)
        end if
      end select
    type is (disutype)
      select type (gwedis => gwemodel%dis)
      type is (disutype)
        if (.not. all(gwfdis%idomain == gwedis%idomain)) then
          write (errmsg, fmtidomerr) trim(this%name)
          call store_error(errmsg, terminate=.true.)
        end if
      end select
    end select
    !
    ! -- setup pointers to gwf variables allocated in gwf_ar
    gwemodel%fmi%gwfhead => gwfmodel%x
    call mem_checkin(gwemodel%fmi%gwfhead, &
                     'GWFHEAD', gwemodel%fmi%memoryPath, &
                     'X', gwfmodel%memoryPath)
    gwemodel%fmi%gwfsat => gwfmodel%npf%sat
    call mem_checkin(gwemodel%fmi%gwfsat, &
                     'GWFSAT', gwemodel%fmi%memoryPath, &
                     'SAT', gwfmodel%npf%memoryPath)
    gwemodel%fmi%gwfspdis => gwfmodel%npf%spdis
    call mem_checkin(gwemodel%fmi%gwfspdis, &
                     'GWFSPDIS', gwemodel%fmi%memoryPath, &
                     'SPDIS', gwfmodel%npf%memoryPath)
    gwemodel%fmi%igwfspdis = gwfmodel%npf%icalcspdis
    !
    ! -- setup pointers to the flow storage rates. GWF strg arrays are
    !    available after the gwf_ar routine is called.
    if (gwemodel%inest > 0) then
      if (gwfmodel%insto > 0) then
        gwemodel%fmi%gwfstrgss => gwfmodel%sto%strgss
        gwemodel%fmi%igwfstrgss = 1
        if (gwfmodel%sto%iusesy == 1) then
          gwemodel%fmi%gwfstrgsy => gwfmodel%sto%strgsy
          gwemodel%fmi%igwfstrgsy = 1
        end if
      end if
    end if
    !
    ! -- Set a pointer to conc in buy
    if (gwfmodel%inbuy > 0) then
      call gwfmodel%buy%set_concentration_pointer(gwemodel%name, gwemodel%x, &
                                                  gwemodel%ibound)
    end if
    !
    ! -- Set a pointer to conc (which could be a temperature) in vsc
    if (gwfmodel%invsc > 0) then
      call gwfmodel%vsc%set_concentration_pointer(gwemodel%name, gwemodel%x, &
                                                  gwemodel%ibound, 1)
    end if
    !
    ! -- transfer the boundary package information from gwf to gwe
    call this%gwfbnd2gwefmi()
    !
    ! -- if mover package is active, then set a pointer to it's budget object
    if (gwfmodel%inmvr /= 0) then
      gwemodel%fmi%mvrbudobj => gwfmodel%mvr%budobj
    end if
    !
    ! -- connect Connections
    call this%gwfconn2gweconn(gwfmodel, gwemodel)

Here is the call graph for this function:

exg_da()

subroutine gwfgweexchangemodule::exg_da

(

class(gwfgweexchangetype)

this

)

Definition at line 499 of file exg-gwfgwe.f90.

    ! -- modules
    use memorymanagermodule, only: mem_deallocate
    ! -- dummy
    class(GwfGweExchangeType) :: this
    !
    call mem_deallocate(this%m1_idx)
    call mem_deallocate(this%m2_idx)

exg_df()

subroutine gwfgweexchangemodule::exg_df

(

class(gwfgweexchangetype)

this

)

Definition at line 131 of file exg-gwfgwe.f90.

    ! -- modules
    use memorymanagermodule, only: mem_checkin
    ! -- dummy
    class(GwfGweExchangeType) :: this
    ! -- local
    class(BaseModelType), pointer :: mb => null()
    type(GwfModelType), pointer :: gwfmodel => null()
    type(GweModelType), pointer :: gwemodel => null()
    !
    ! -- set gwfmodel
    mb => getbasemodelfromlist(basemodellist, this%m1_idx)
    select type (mb)
    type is (gwfmodeltype)
      gwfmodel => mb
    end select
    !
    ! -- set gwemodel
    mb => getbasemodelfromlist(basemodellist, this%m2_idx)
    select type (mb)
    type is (gwemodeltype)
      gwemodel => mb
    end select
    !
    ! -- Check to make sure that flow is solved before transport and in a
    !    different IMS solution
    if (gwfmodel%idsoln >= gwemodel%idsoln) then
      write (errmsg, '(3a)') 'Problem with GWF-GWE exchange ', trim(this%name), &
        '.  The GWF model must be solved by a different IMS than the GWE model. &
        &Furthermore, the IMS specified for GWF must be listed in mfsim.nam &
        &before the IMS for GWE.'
      call store_error(errmsg, terminate=.true.)
    end if
    !
    ! -- Set pointer to flowja
    gwemodel%fmi%gwfflowja => gwfmodel%flowja
    call mem_checkin(gwemodel%fmi%gwfflowja, &
                     'GWFFLOWJA', gwemodel%fmi%memoryPath, &
                     'FLOWJA', gwfmodel%memoryPath)
 
    !
    ! -- Set the npf flag so that specific discharge is available for
    !    transport calculations if dispersion is active
    if (gwemodel%incnd > 0) then
      gwfmodel%npf%icalcspdis = 1
    end if

Here is the call graph for this function:

gwfbnd2gwefmi()

subroutine gwfgweexchangemodule::gwfbnd2gwefmi

(

class(gwfgweexchangetype)

this

)

Definition at line 526 of file exg-gwfgwe.f90.

    ! -- dummy
    class(GwfGweExchangeType) :: this
    ! -- local
    integer(I4B) :: ngwfpack, ip, iterm, imover
    class(BaseModelType), pointer :: mb => null()
    type(GwfModelType), pointer :: gwfmodel => null()
    type(GweModelType), pointer :: gwemodel => null()
    class(BndType), pointer :: packobj => null()
    !
    ! -- set gwfmodel
    mb => getbasemodelfromlist(basemodellist, this%m1_idx)
    select type (mb)
    type is (gwfmodeltype)
      gwfmodel => mb
    end select
    !
    ! -- set gwemodel
    mb => getbasemodelfromlist(basemodellist, this%m2_idx)
    select type (mb)
    type is (gwemodeltype)
      gwemodel => mb
    end select
    !
    ! -- Call routines in FMI that will set pointers to the necessary flow
    !    data (SIMVALS and SIMTOMVR) stored within each GWF flow package
    ngwfpack = gwfmodel%bndlist%Count()
    iterm = 1
    do ip = 1, ngwfpack
      packobj => getbndfromlist(gwfmodel%bndlist, ip)
      call gwemodel%fmi%gwfpackages(iterm)%set_pointers( &
        'SIMVALS', &
        packobj%memoryPath, packobj%input_mempath)
      iterm = iterm + 1
      !
      ! -- If a mover is active for this package, then establish a separate
      !    pointer link for the mover flows stored in SIMTOMVR
      imover = packobj%imover
      if (packobj%isadvpak /= 0) imover = 0
      if (imover /= 0) then
        call gwemodel%fmi%gwfpackages(iterm)%set_pointers( &
          'SIMTOMVR', &
          packobj%memoryPath, packobj%input_mempath)
        iterm = iterm + 1
      end if
    end do

Here is the call graph for this function:

gwfconn2gweconn()

subroutine gwfgweexchangemodule::gwfconn2gweconn	(	class(gwfgweexchangetype)	this,
		type(gwfmodeltype), pointer	gwfModel,
		type(gwemodeltype), pointer	gweModel
	)

Parameters

this	this exchange
gwfmodel	the flow model
gwemodel	the energy transport model

Definition at line 313 of file exg-gwfgwe.f90.

    ! -- modules
    use simmodule, only: store_error
    use simvariablesmodule, only: iout
    use memorymanagermodule, only: mem_checkin
    ! -- dummy
    class(GwfGweExchangeType) :: this !< this exchange
    type(GwfModelType), pointer :: gwfModel !< the flow model
    type(GweModelType), pointer :: gweModel !< the energy transport model
    ! -- local
    class(SpatialModelConnectionType), pointer :: conn => null()
    class(*), pointer :: objPtr => null()
    class(GweGweConnectionType), pointer :: gweConn => null()
    class(GwfGwfConnectionType), pointer :: gwfConn => null()
    class(GwfExchangeType), pointer :: gwfEx => null()
    integer(I4B) :: ic1, ic2, iex
    integer(I4B) :: gwfConnIdx, gwfExIdx
    logical(LGP) :: areEqual
    !
    ! loop over all connections
    gweloop: do ic1 = 1, baseconnectionlist%Count()
      !
      conn => get_smc_from_list(baseconnectionlist, ic1)
      if (.not. associated(conn%owner, gwemodel)) cycle gweloop
      !
      ! start with a GWE conn.
      objptr => conn
      gweconn => castasgwegweconnection(objptr)
      gwfconnidx = -1
      gwfexidx = -1
      !
      ! find matching GWF conn. in same list
      gwfloop: do ic2 = 1, baseconnectionlist%Count()
        conn => get_smc_from_list(baseconnectionlist, ic2)
        !
        if (associated(conn%owner, gwfmodel)) then
          objptr => conn
          gwfconn => castasgwfgwfconnection(objptr)
          !
          ! A model can have multiple exchanges, even connecting the same two
          ! models. Require that the GWF models match those referenced by the
          ! GWE exchange before comparing node lists, otherwise a GWE exchange
          ! could be linked to the wrong GWF-GWF exchange.
          if (gwfconn%gwfExchange%v_model1%name /= &
              gweconn%gweExchange%gwfmodelname1) cycle
          if (gwfconn%gwfExchange%v_model2%name /= &
              gweconn%gweExchange%gwfmodelname2) cycle
          !
          ! then, connecting the same nodes nrs will be
          ! sufficient evidence of equality
          areequal = (gwfconn%gwfExchange%nexg == gweconn%gweExchange%nexg)
          if (areequal) then
            areequal = all(gwfconn%prim_exchange%nodem1 == &
                           gweconn%prim_exchange%nodem1)
            areequal = areequal .and. all(gwfconn%prim_exchange%nodem2 == &
                                          gweconn%prim_exchange%nodem2)
          end if
          if (areequal) then
            ! same DIS, same exchange: link and go to next GWE conn.
            write (iout, '(/6a)') 'Linking exchange ', &
              trim(gweconn%prim_exchange%name), &
              ' to ', trim(gwfconn%prim_exchange%name), &
              ' (using interface model) for GWE model ', &
              trim(gwemodel%name)
            gwfconnidx = ic2
            call this%link_connections(gweconn, gwfconn)
            exit gwfloop
          end if
        end if
      end do gwfloop
      !
      ! fallback option: coupling to old gwfgwf exchange,
      ! (this will go obsolete at some point)
      if (gwfconnidx == -1) then
        gwfloopexg: do iex = 1, baseexchangelist%Count()
          gwfex => getgwfexchangefromlist(baseexchangelist, iex)
          !
          ! -- There is no guarantee that iex is a gwfExg, in which case
          !    it will return as null.  cycle if so.
          if (.not. associated(gwfex)) cycle gwfloopexg
          !
          if (associated(gwfex%model1, gwfmodel) .or. &
              associated(gwfex%model2, gwfmodel)) then
            !
            ! require that the GWF models match those referenced by the GWE
            ! exchange, otherwise a GWE exchange could be linked to the wrong
            ! GWF-GWF exchange
            if (gwfex%v_model1%name /= gweconn%gweExchange%gwfmodelname1) cycle
            if (gwfex%v_model2%name /= gweconn%gweExchange%gwfmodelname2) cycle
 
            ! check exchanges have same node counts
            areequal = size(gwfex%nodem1) == size(gweconn%prim_exchange%nodem1)
            ! then, connecting the same nodes nrs will be
            ! sufficient evidence of equality
            if (areequal) &
              areequal = all(gwfex%nodem1 == gweconn%prim_exchange%nodem1)
            if (areequal) &
              areequal = all(gwfex%nodem2 == gweconn%prim_exchange%nodem2)
            if (areequal) then
              ! link exchange to connection
              write (iout, '(/6a)') 'Linking exchange ', &
                trim(gweconn%prim_exchange%name), &
                ' to ', trim(gwfex%name), ' for GWE model ', &
                trim(gwemodel%name)
              gwfexidx = iex
              if (gweconn%owns_exchange) then
                gweconn%gweExchange%gwfsimvals => gwfex%simvals
                call mem_checkin(gweconn%gweExchange%gwfsimvals, &
                                 'GWFSIMVALS', gweconn%gweExchange%memoryPath, &
                                 'SIMVALS', gwfex%memoryPath)
              end if
              !
              !cdl link up mvt to mvr
              if (gwfex%inmvr > 0) then
                if (gweconn%owns_exchange) then
                  !cdl todo: check and make sure gweEx has mvt active
                  call gweconn%gweExchange%mvt%set_pointer_mvrbudobj( &
                    gwfex%mvr%budobj)
                end if
              end if
              !
              if (associated(gwfex%model2, gwfmodel)) gweconn%exgflowSign = -1
              gweconn%gweInterfaceModel%fmi%flows_from_file = .false.
              !
              exit gwfloopexg
            end if
          end if
          !
        end do gwfloopexg
      end if
      !
      if (gwfconnidx == -1 .and. gwfexidx == -1) then
        ! none found, report
        write (errmsg, '(/6a)') 'Missing GWF-GWF exchange when connecting GWE'// &
          ' model ', trim(gwemodel%name), ' with exchange ', &
          trim(gweconn%prim_exchange%name), ' to GWF model ', &
          trim(gwfmodel%name)
        call store_error(errmsg, terminate=.true.)
      end if
      !
    end do gweloop

Here is the call graph for this function:

gwfgwe_cr()

subroutine, public gwfgweexchangemodule::gwfgwe_cr	(	character(len=*), intent(in)	filename,
		integer(i4b), intent(in)	id,
		integer(i4b), intent(in)	m1_id,
		integer(i4b), intent(in)	m2_id
	)

Definition at line 46 of file exg-gwfgwe.f90.

    ! -- modules
    use simvariablesmodule, only: model_loc_idx
    ! -- dummy
    character(len=*), intent(in) :: filename
    integer(I4B), intent(in) :: id
    integer(I4B), intent(in) :: m1_id
    integer(I4B), intent(in) :: m2_id
    ! -- local
    class(BaseExchangeType), pointer :: baseexchange => null()
    type(GwfGweExchangeType), pointer :: exchange => null()
    character(len=20) :: cint
    !
    ! -- Create a new exchange and add it to the baseexchangelist container
    allocate (exchange)
    baseexchange => exchange
    call addbaseexchangetolist(baseexchangelist, baseexchange)
    !
    ! -- Assign id and name
    exchange%id = id
    write (cint, '(i0)') id
    exchange%name = 'GWF-GWE_'//trim(adjustl(cint))
    exchange%memoryPath = exchange%name
    !
    ! -- allocate scalars
    call exchange%allocate_scalars()
    !
    ! -- NB: convert from id to local model index in base model list
    exchange%m1_idx = model_loc_idx(m1_id)
    exchange%m2_idx = model_loc_idx(m2_id)
    !
    ! -- set model pointers
    call exchange%set_model_pointers()

Here is the call graph for this function:

Here is the caller graph for this function:

link_connections()

subroutine gwfgweexchangemodule::link_connections	(	class(gwfgweexchangetype)	this,
		class(gwegweconnectiontype), pointer	gweConn,
		class(gwfgwfconnectiontype), pointer	gwfConn
	)

Parameters

this	this exchange
gweconn	GWE connection
gwfconn	GWF connection

Definition at line 458 of file exg-gwfgwe.f90.

    ! -- modules
    use memorymanagermodule, only: mem_checkin
    ! -- dummy
    class(GwfGweExchangeType) :: this !< this exchange
    class(GweGweConnectionType), pointer :: gweConn !< GWE connection
    class(GwfGwfConnectionType), pointer :: gwfConn !< GWF connection
    !
    !gweConn%exgflowja => gwfConn%exgflowja
    if (gweconn%owns_exchange) then
      gweconn%gweExchange%gwfsimvals => gwfconn%gwfExchange%simvals
      call mem_checkin(gweconn%gweExchange%gwfsimvals, &
                       'GWFSIMVALS', gweconn%gweExchange%memoryPath, &
                       'SIMVALS', gwfconn%gwfExchange%memoryPath)
    end if
    !
    !cdl link up mvt to mvr
    if (gwfconn%gwfExchange%inmvr > 0) then
      if (gweconn%owns_exchange) then
        !cdl todo: check and make sure gweEx has mvt active
        call gweconn%gweExchange%mvt%set_pointer_mvrbudobj( &
          gwfconn%gwfExchange%mvr%budobj)
      end if
    end if
    !
    if (associated(gwfconn%gwfExchange%model2, gwfconn%owner)) then
      gweconn%exgflowSign = -1
    end if
    !
    ! fmi flows are not read from file
    gweconn%gweInterfaceModel%fmi%flows_from_file = .false.
    !
    ! set concentration pointer for buoyancy
    !call gwfConn%gwfInterfaceModel%buy%set_concentration_pointer( &
    !  gweConn%gweModel%name, &
    !  gweConn%conc, &
    !  gweConn%icbound)

set_model_pointers()

subroutine gwfgweexchangemodule::set_model_pointers

(

class(gwfgweexchangetype)

this

)

Definition at line 83 of file exg-gwfgwe.f90.

    ! -- dummy
    class(GwfGweExchangeType) :: this
    ! -- local
    class(BaseModelType), pointer :: mb => null()
    type(GwfModelType), pointer :: gwfmodel => null()
    type(GweModelType), pointer :: gwemodel => null()
    !
    ! -- set gwfmodel
    gwfmodel => null()
    mb => getbasemodelfromlist(basemodellist, this%m1_idx)
    select type (mb)
    type is (gwfmodeltype)
      gwfmodel => mb
    end select
    !
    ! -- set gwemodel
    gwemodel => null()
    mb => getbasemodelfromlist(basemodellist, this%m2_idx)
    select type (mb)
    type is (gwemodeltype)
      gwemodel => mb
    end select
    !
    ! -- Verify that gwf model is of the correct type
    if (.not. associated(gwfmodel)) then
      write (errmsg, '(3a)') 'Problem with GWF-GWE exchange ', trim(this%name), &
        '.  Specified GWF Model does not appear to be of the correct type.'
      call store_error(errmsg, terminate=.true.)
    end if
    !
    ! -- Verify that gwe model is of the correct type
    if (.not. associated(gwemodel)) then
      write (errmsg, '(3a)') 'Problem with GWF-GWE exchange ', trim(this%name), &
        '.  Specified GWF Model does not appear to be of the correct type.'
      call store_error(errmsg, terminate=.true.)
    end if
    !
    ! -- Tell transport model fmi flows are not read from file
    gwemodel%fmi%flows_from_file = .false.
    !
    ! -- Set a pointer to the GWF bndlist.  This will allow the transport model
    !    to look through the flow packages and establish a link to GWF flows
    gwemodel%fmi%gwfbndlist => gwfmodel%bndlist

Here is the call graph for this function: