packagemovermodule Module Reference

Data Types
type	packagemovertype

Functions/Subroutines
subroutine, public	set_packagemover_pointer (packagemover, memPath)
subroutine, public	nulllify_packagemover_pointer (packagemover)
subroutine	ar (this, nproviders, nreceivers, memoryPath)
subroutine	ad (this)
subroutine	reset (this)
subroutine	fc (this)
subroutine	da (this)
subroutine	allocate_scalars (this)
subroutine	allocate_arrays (this)
real(dp) function	get_qfrommvr (this, ireceiver)
real(dp) function	get_qfrommvr0 (this, ireceiver)
real(dp) function	get_qtomvr (this, iprovider)
subroutine	accumulate_qformvr (this, iprovider, qformvr)

Function/Subroutine Documentation

accumulate_qformvr()

subroutine packagemovermodule::accumulate_qformvr ( class(packagemovertype)  this, integer, intent(in)  iprovider, real(dp), intent(in)  qformvr  )

private

Definition at line 218 of file PackageMover.f90.

    class(PackageMoverType) :: this
    integer, intent(in) :: iprovider
    real(DP), intent(in) :: qformvr
    this%qformvr(iprovider) = this%qformvr(iprovider) + qformvr

ad()

subroutine packagemovermodule::ad ( class(packagemovertype)  this )

private

Definition at line 89 of file PackageMover.f90.

    class(PackageMoverType) :: this
    integer :: i
    !
    ! -- set qtomvr and qformvr to zero
    do i = 1, this%nproviders
      this%qtomvr(i) = dzero
      this%qformvr(i) = dzero
    end do
    !
    ! -- return
    return

allocate_arrays()

subroutine packagemovermodule::allocate_arrays ( class(packagemovertype)  this )

private

Definition at line 169 of file PackageMover.f90.

    class(PackageMoverType) :: this
    integer(I4B) :: i
    !
    call mem_allocate(this%iprmap, this%nproviders, 'IPRMAP', this%memoryPath)
    call mem_allocate(this%qtformvr, this%nproviders, 'QTFORMVR', this%memoryPath)
    call mem_allocate(this%qformvr, this%nproviders, 'QFORMVR', this%memoryPath)
    call mem_allocate(this%qtomvr, this%nproviders, 'QTOMVR', this%memoryPath)
    call mem_allocate(this%qfrommvr, this%nreceivers, 'QFROMMVR', this%memoryPath)
    call mem_allocate(this%qfrommvr0, this%nreceivers, 'QFROMMVR0', &
                      this%memoryPath)
    !
    ! -- initialize
    do i = 1, this%nproviders
      this%iprmap(i) = i
      this%qtformvr(i) = dzero
      this%qformvr(i) = dzero
      this%qtomvr(i) = dzero
    end do
    do i = 1, this%nreceivers
      this%qfrommvr(i) = dzero
      this%qfrommvr0(i) = dzero
    end do
    !
    ! -- return
    return

allocate_scalars()

subroutine packagemovermodule::allocate_scalars ( class(packagemovertype)  this )

private

Definition at line 156 of file PackageMover.f90.

    class(PackageMoverType) :: this
    !
    call mem_allocate(this%nproviders, 'NPROVIDERS', this%memoryPath)
    call mem_allocate(this%nreceivers, 'NRECEIVERS', this%memoryPath)
    !
    this%nproviders = 0
    this%nreceivers = 0
    !
    ! -- return
    return

ar()

subroutine packagemovermodule::ar ( class(packagemovertype)  this, integer, intent(in)  nproviders, integer, intent(in)  nreceivers, character(len=*), intent(in)  memoryPath  )

private

Definition at line 72 of file PackageMover.f90.

    class(PackageMoverType) :: this
    integer, intent(in) :: nproviders
    integer, intent(in) :: nreceivers
    character(len=*), intent(in) :: memoryPath
    !
    this%memoryPath = memorypath
    call this%allocate_scalars()
    this%nproviders = nproviders
    this%nreceivers = nreceivers
    !
    call this%allocate_arrays()
    !
    ! -- return
    return

da()

subroutine packagemovermodule::da ( class(packagemovertype)  this )

private

Definition at line 134 of file PackageMover.f90.

    class(PackageMoverType) :: this
    !
    ! -- arrays
    call mem_deallocate(this%iprmap)
    call mem_deallocate(this%qtformvr)
    call mem_deallocate(this%qformvr)
    call mem_deallocate(this%qtomvr)
    call mem_deallocate(this%qfrommvr)
    call mem_deallocate(this%qfrommvr0)
    !
    ! -- scalars
    call mem_deallocate(this%nproviders)
    call mem_deallocate(this%nreceivers)
    !
    ! -- pointers
    nullify (this%iprmap)
    !
    ! -- return
    return

fc()

subroutine packagemovermodule::fc ( class(packagemovertype)  this )

private

Definition at line 121 of file PackageMover.f90.

    class(PackageMoverType) :: this
    integer :: i
    !
    ! -- set formvr to zero
    do i = 1, this%nproviders
      this%qformvr(i) = dzero
    end do
    !
    ! -- return
    return

get_qfrommvr()

real(dp) function packagemovermodule::get_qfrommvr ( class(packagemovertype)  this, integer, intent(in)  ireceiver  )

private

Definition at line 197 of file PackageMover.f90.

    class(PackageMoverType) :: this
    real(DP) :: qfrommvr
    integer, intent(in) :: ireceiver
    qfrommvr = this%qfrommvr(ireceiver)

get_qfrommvr0()

real(dp) function packagemovermodule::get_qfrommvr0 ( class(packagemovertype)  this, integer, intent(in)  ireceiver  )

private

Definition at line 204 of file PackageMover.f90.

    class(PackageMoverType) :: this
    real(DP) :: qfrommvr0
    integer, intent(in) :: ireceiver
    qfrommvr0 = this%qfrommvr0(ireceiver)

get_qtomvr()

real(dp) function packagemovermodule::get_qtomvr ( class(packagemovertype)  this, integer, intent(in)  iprovider  )

private

Definition at line 211 of file PackageMover.f90.

    class(PackageMoverType) :: this
    real(DP) :: qtomvr
    integer, intent(in) :: iprovider
    qtomvr = this%qtomvr(iprovider)

nulllify_packagemover_pointer()

subroutine, public packagemovermodule::nulllify_packagemover_pointer

(

type(packagemovertype), intent(inout)

packagemover

)

Definition at line 59 of file PackageMover.f90.

    type(PackageMoverType), intent(inout) :: packagemover
    packagemover%memoryPath = ''
    packagemover%nproviders => null()
    packagemover%nreceivers => null()
    packagemover%iprmap => null()
    packagemover%qtformvr => null()
    packagemover%qformvr => null()
    packagemover%qtomvr => null()
    packagemover%qfrommvr => null()
    packagemover%qfrommvr0 => null()

Here is the caller graph for this function:

reset()

subroutine packagemovermodule::reset ( class(packagemovertype)  this )

private

Definition at line 103 of file PackageMover.f90.

    class(PackageMoverType) :: this
    integer :: i
    !
    ! -- set frommvr and qtomvr to zero
    do i = 1, this%nreceivers
      this%qfrommvr0(i) = this%qfrommvr(i)
      this%qfrommvr(i) = dzero
    end do
    do i = 1, this%nproviders
      this%qtomvr(i) = dzero
      this%qtformvr(i) = this%qformvr(i)
    end do
    !
    ! -- return
    return

set_packagemover_pointer()

subroutine, public packagemovermodule::set_packagemover_pointer	(	type(packagemovertype), intent(inout)	packagemover,
		character(len=*), intent(in)	memPath
	)

Definition at line 43 of file PackageMover.f90.

    type(PackageMoverType), intent(inout) :: packagemover
    character(len=*), intent(in) :: memPath
    packagemover%memoryPath = mempath
    call mem_setptr(packagemover%nproviders, 'NPROVIDERS', &
                    packagemover%memoryPath)
    call mem_setptr(packagemover%nreceivers, 'NRECEIVERS', &
                    packagemover%memoryPath)
    call mem_setptr(packagemover%iprmap, 'IPRMAP', packagemover%memoryPath)
    call mem_setptr(packagemover%qtformvr, 'QTFORMVR', packagemover%memoryPath)
    call mem_setptr(packagemover%qformvr, 'QFORMVR', packagemover%memoryPath)
    call mem_setptr(packagemover%qtomvr, 'QTOMVR', packagemover%memoryPath)
    call mem_setptr(packagemover%qfrommvr, 'QFROMMVR', packagemover%memoryPath)
    call mem_setptr(packagemover%qfrommvr0, 'QFROMMVR0', packagemover%memoryPath)

Here is the caller graph for this function: