gwfexgmovermodule Module Reference

Data Types
type	gwfexgmovertype
	Extends model mover for exchanges to also handle the. More...

Functions/Subroutines
subroutine, public	exg_mvr_cr (exg_mvr, name_parent, inunit, iout, dis)
subroutine	xmvr_check_packages (this)
subroutine	xmvr_assign_packagemovers (this)
	Overrides GWF MVR routine to skip assigning. More...
subroutine	xmvr_initialize_movers (this, nr_active_movers)
	Overrides mover initialization in GWF MVR to deactivate remote parts and build up sync. arrays. More...
subroutine	xmvr_cf (this)
	Calculates qpactual and stores it for synchronization. More...
subroutine	xmvr_fc (this)
	Assign synced qpactual to mover and update receiver. More...
subroutine	xmvr_bd (this)
	Overrides budget routine to first assign the. More...
subroutine	xmvr_allocate_arrays (this)
subroutine	xmvr_da (this)

Function/Subroutine Documentation

exg_mvr_cr()

subroutine, public gwfexgmovermodule::exg_mvr_cr	(	class(gwfexgmovertype), pointer	exg_mvr,
		character(len=*), intent(in)	name_parent,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout,
		class(disbasetype), pointer	dis
	)

Definition at line 40 of file GwfExchangeMover.f90.

    class(GwfExgMoverType), pointer :: exg_mvr
    character(len=*), intent(in) :: name_parent
    integer(I4B), intent(in) :: inunit
    integer(I4B), intent(in) :: iout
    class(DisBaseType), pointer :: dis
 
    allocate (exg_mvr)
 
    ! Init through base
    call exg_mvr%mvr_init(name_parent, inunit, iout, dis, 1)
 

Here is the caller graph for this function:

xmvr_allocate_arrays()

subroutine gwfexgmovermodule::xmvr_allocate_arrays ( class(gwfexgmovertype)  this )

private

Definition at line 247 of file GwfExchangeMover.f90.

    class(GwfExgMoverType) :: this
    ! local
    integer(I4B) :: i
 
    call this%GwfMvrType%allocate_arrays()
 
    allocate (this%prov_is_m1(this%maxmvr))
    call mem_allocate(this%qpactual_m1, this%maxmvr, 'QPACTUAL_M1', &
                      this%memoryPath)
    call mem_allocate(this%qpactual_m2, this%maxmvr, 'QPACTUAL_M2', &
                      this%memoryPath)
    call mem_allocate(this%qavailable_m1, this%maxmvr, 'QAVAILABLE_M1', &
                      this%memoryPath)
    call mem_allocate(this%qavailable_m2, this%maxmvr, 'QAVAILABLE_M2', &
                      this%memoryPath)
    call mem_allocate(this%id_mapped_m1, this%maxmvr, 'ID_MAPPED_M1', &
                      this%memoryPath)
    call mem_allocate(this%id_mapped_m2, this%maxmvr, 'ID_MAPPED_M2', &
                      this%memoryPath)
 
    do i = 1, this%maxmvr
      this%id_mapped_m1(i) = 0
      this%id_mapped_m2(i) = 0
      this%qpactual_m1(i) = dnodata
      this%qpactual_m2(i) = dnodata
      this%qavailable_m1(i) = dnodata
      this%qavailable_m2(i) = dnodata
    end do
 

xmvr_assign_packagemovers()

subroutine gwfexgmovermodule::xmvr_assign_packagemovers

(

class(gwfexgmovertype), intent(inout)

this

)

Parameters

[in,out]

this

this exchange mover

Definition at line 105 of file GwfExchangeMover.f90.

    class(GwfExgMoverType), intent(inout) :: this !< this exchange mover
    ! local
    integer(I4B) :: i
    character(len=LENMODELNAME) :: mname
    character(len=LENPACKAGENAME) :: pname
    class(VirtualModelType), pointer :: vm
 
    do i = 1, size(this%pckMemPaths)
      if (this%pakmovers(i)%memoryPath == '') then
        ! is it local?
        call split_mem_path(this%pckMemPaths(i), mname, pname)
        vm => get_virtual_model(mname)
        if (vm%is_local) then
          ! yes, we need the pointers
          call set_packagemover_pointer(this%pakmovers(i), &
                                        trim(this%pckMemPaths(i)))
        end if
      end if
    end do

Here is the call graph for this function:

xmvr_bd()

subroutine gwfexgmovermodule::xmvr_bd ( class(gwfexgmovertype)  this )

private

Definition at line 229 of file GwfExchangeMover.f90.

    class(GwfExgMoverType) :: this
    ! local
    integer(I4B) :: i
 
    ! copy from synchronization arrays back into movers:
    do i = 1, this%nmvr
      if (this%prov_is_m1(i)) then
        this%mvr(i)%iRchNrSrcMapped = this%id_mapped_m1(i)
      else
        this%mvr(i)%iRchNrSrcMapped = this%id_mapped_m2(i)
      end if
    end do
 
    call this%fill_budobj()
 

xmvr_cf()

subroutine gwfexgmovermodule::xmvr_cf ( class(gwfexgmovertype)  this )

private

Definition at line 177 of file GwfExchangeMover.f90.

    class(GwfExgMoverType) :: this
    ! local
    integer(I4B) :: i
 
    do i = 1, this%nmvr
      if (this%mvr(i)%is_provider_active) then
 
        call this%mvr(i)%update_provider()
 
        ! copy calculated rate to arrays for synchronization:
        if (this%prov_is_m1(i)) then
          this%qpactual_m1(i) = this%mvr(i)%qpactual
          this%qavailable_m1(i) = this%mvr(i)%qavailable
          this%qpactual_m2(i) = dnodata
          this%qavailable_m2(i) = dnodata
        else
          this%qpactual_m1(i) = dnodata
          this%qavailable_m1(i) = dnodata
          this%qpactual_m2(i) = this%mvr(i)%qpactual
          this%qavailable_m2(i) = this%mvr(i)%qavailable
        end if
      end if
    end do
 

xmvr_check_packages()

subroutine gwfexgmovermodule::xmvr_check_packages ( class(gwfexgmovertype), intent(inout)  this )

private

Definition at line 54 of file GwfExchangeMover.f90.

    use constantsmodule, only: linelength
    use memorymanagermodule, only: mem_setptr
    use simmodule, only: store_error, count_errors, store_error_unit
    class(GwfExgMoverType), intent(inout) :: this
    ! local
    character(len=LENMODELNAME) :: mname
    character(len=LENPACKAGENAME) :: pname
    class(VirtualModelType), pointer :: vm
    character(len=LINELENGTH) :: errmsg
    integer(I4B) :: i
    integer(I4B), pointer :: imover_ptr
 
    do i = 1, size(this%pckMemPaths)
      ! check only when local
      call split_mem_path(this%pckMemPaths(i), mname, pname)
      vm => get_virtual_model(mname)
      if (vm%is_local) then
        ! check if PackageMover is active in package:
        imover_ptr => null()
        call mem_setptr(imover_ptr, 'IMOVER', trim(this%pckMemPaths(i)))
        if (imover_ptr == 0) then
          write (errmsg, '(a, a, a)') &
            'ERROR.  MODEL AND PACKAGE "', &
            trim(this%pckMemPaths(i)), &
            '" DOES NOT HAVE MOVER SPECIFIED IN OPTIONS BLOCK.'
          call store_error(errmsg)
        end if
      end if
      !
      ! ensure that the current model name, which is listed in the PACKAGES
      ! block of the exchange MVR input, is one of the two models connected
      ! by the exchange. If not, then the model should not be listed.
      if (mname == this%model1%name .or. mname == this%model2%name) then
        continue
      else
        write (errmsg, '(a, a, a)') 'The input for an exchange mover &
          &lists a model name ("', trim(mname), '") in the PACKAGES &
          &input block that is not a member of the exchange.'
        call store_error(errmsg)
      end if
    end do
 
    if (count_errors() > 0) then
      call this%parser%StoreErrorUnit()
    end if
 

Here is the call graph for this function:

xmvr_da()

subroutine gwfexgmovermodule::xmvr_da ( class(gwfexgmovertype)  this )

private

Definition at line 279 of file GwfExchangeMover.f90.

    class(GwfExgMoverType) :: this
 
    call this%GwfMvrType%mvr_da()
 
    deallocate (this%prov_is_m1)
    call mem_deallocate(this%qpactual_m1)
    call mem_deallocate(this%qpactual_m2)
    call mem_deallocate(this%qavailable_m1)
    call mem_deallocate(this%qavailable_m2)
    call mem_deallocate(this%id_mapped_m1)
    call mem_deallocate(this%id_mapped_m2)
 

xmvr_fc()

subroutine gwfexgmovermodule::xmvr_fc ( class(gwfexgmovertype)  this )

private

Definition at line 206 of file GwfExchangeMover.f90.

    class(GwfExgMoverType) :: this
    ! local
    integer(I4B) :: i
 
    do i = 1, this%nmvr
      if (this%mvr(i)%is_receiver_active) then
        ! copy from synchronization arrays back into movers:
        if (this%prov_is_m1(i)) then
          this%mvr(i)%qpactual = this%qpactual_m1(i)
          this%mvr(i)%qavailable = this%qavailable_m1(i)
        else
          this%mvr(i)%qpactual = this%qpactual_m2(i)
          this%mvr(i)%qavailable = this%qavailable_m2(i)
        end if
        call this%mvr(i)%update_receiver()
      end if
    end do
 

xmvr_initialize_movers()

subroutine gwfexgmovermodule::xmvr_initialize_movers ( class(gwfexgmovertype)  this, integer(i4b)  nr_active_movers  )

private

Definition at line 130 of file GwfExchangeMover.f90.

    class(GwfExgMoverType) :: this
    integer(I4B) :: nr_active_movers
    ! local
    integer(I4B) :: i
    character(len=LENMODELNAME) :: mname
    character(len=LENPACKAGENAME) :: pname
    class(VirtualModelType), pointer :: vm
    class(PackageMoverType), allocatable :: pkg_mvr
 
    call this%GwfMvrType%initialize_movers(nr_active_movers)
 
    this%prov_is_m1 = .false.
 
    ! deactivate remote parts
    do i = 1, nr_active_movers
      call split_mem_path(this%mvr(i)%mem_path_src, mname, pname)
      vm => get_virtual_model(mname)
      this%mvr(i)%is_provider_active = vm%is_local
      this%prov_is_m1(i) = associated(vm, this%model1)
      call split_mem_path(this%mvr(i)%mem_path_tgt, mname, pname)
      vm => get_virtual_model(mname)
      this%mvr(i)%is_receiver_active = vm%is_local
    end do
 
    ! loop over mvr's, if provider is active,
    ! store mapped feature index in array for sync
    allocate (pkg_mvr)
 
    do i = 1, nr_active_movers
      if (this%mvr(i)%is_provider_active) then
        ! store mapped feature id in array (for synchronization when parallel)
        call set_packagemover_pointer(pkg_mvr, this%mvr(i)%mem_path_src)
        if (this%prov_is_m1(i)) then
          this%id_mapped_m1(i) = pkg_mvr%iprmap(this%mvr(i)%iRchNrSrc)
          this%id_mapped_m2(i) = -1
        else
          this%id_mapped_m1(i) = -1
          this%id_mapped_m2(i) = pkg_mvr%iprmap(this%mvr(i)%iRchNrSrc)
        end if
      end if
    end do
 

Here is the call graph for this function: