mpimessagecachemodule Module Reference

Data Types
type	mpimessagecachetype
	Facility to cache the constructed MPI datatypes. This will avoid having to construct them over and over again for the communication inside the timestep loop. This class deals with separate caches for different units (solutions or global) and for different types of. More...

Functions/Subroutines
subroutine	mmc_init (this)
integer function	mmc_get (this, unit, rank, stage, msg_id)
subroutine	mmc_put (this, unit, rank, stage, msg_id, mpi_type)
	Put the mpi datatype for this particular unit, rank, and stage in cache. The datatype should be. More...
subroutine	mmc_clear (this)
subroutine	mmc_destroy (this)

Variables
integer(i4b), parameter, public	mpi_bdy_rcv = 1
	receiving data (body) from ranks More...
integer(i4b), parameter, public	mpi_bdy_snd = 2
	sending data (body) to ranks More...
integer(i4b), parameter, public	nr_msg_types = 2
	the total number of message types to be cached More...

Function/Subroutine Documentation

mmc_clear()

subroutine mpimessagecachemodule::mmc_clear ( class(mpimessagecachetype)  this )

private

Parameters

this	the message cache

Definition at line 111 of file MpiMessageCache.f90.

    class(MpiMessageCacheType) :: this !< the message cache
    ! local
    integer(I4B) :: i
    class(*), pointer :: obj_ptr
 
    ! clear caches
    do i = 1, this%cached_ids%size
      obj_ptr => this%unit_caches%GetItem(i)
      select type (obj_ptr)
      class is (mpiunitcachetype)
        call obj_ptr%clear()
      end select
    end do
 

mmc_destroy()

subroutine mpimessagecachemodule::mmc_destroy ( class(mpimessagecachetype)  this )

private

Parameters

this	the message cache

Definition at line 130 of file MpiMessageCache.f90.

    class(MpiMessageCacheType) :: this !< the message cache
    ! local
    integer(I4B) :: i
    class(*), pointer :: obj_ptr
 
    ! clear caches
    do i = 1, this%cached_ids%size
      obj_ptr => this%unit_caches%GetItem(i)
      select type (obj_ptr)
      class is (mpiunitcachetype)
        call obj_ptr%destroy()
      end select
    end do
    call this%unit_caches%Clear(destroy=.true.)
 
    call this%cached_ids%destroy()
 

Here is the call graph for this function:

mmc_get()

integer function mpimessagecachemodule::mmc_get ( class(mpimessagecachetype)  this, integer(i4b)  unit, integer(i4b)  rank, integer(i4b)  stage, integer(i4b)  msg_id  )

private

Parameters

this	the message cache
unit	the unit (solution or global)
rank	the rank of the MPI process to communicate with
stage	the simulation stage at which the message is sent
msg_id	the message type as an integer between 1 and NR_MSG_TYPES (see above for predefined values)

Returns

the resulting mpi datatype

Definition at line 49 of file MpiMessageCache.f90.

    class(MpiMessageCacheType) :: this !< the message cache
    integer(I4B) :: unit !< the unit (solution or global)
    integer(I4B) :: rank !< the rank of the MPI process to communicate with
    integer(I4B) :: stage !< the simulation stage at which the message is sent
    integer(I4B) :: msg_id !< the message type as an integer between 1 and NR_MSG_TYPES (see above for predefined values)
    integer :: mpi_type !< the resulting mpi datatype
    ! local
    integer(I4B) :: unit_idx
    class(*), pointer :: obj_ptr
 
    mpi_type = no_cached_value
 
    unit_idx = this%cached_ids%get_index(unit)
    if (unit_idx == -1) return ! not cached
 
    obj_ptr => this%unit_caches%GetItem(unit_idx)
    select type (obj_ptr)
    class is (mpiunitcachetype)
      mpi_type = obj_ptr%get_cached(rank, stage, msg_id)
    end select
 

mmc_init()

subroutine mpimessagecachemodule::mmc_init

(

class(mpimessagecachetype)

this

)

Parameters

this	the message cache

Definition at line 39 of file MpiMessageCache.f90.

    class(MpiMessageCacheType) :: this !< the message cache
 
    call this%cached_ids%init()
 

mmc_put()

subroutine mpimessagecachemodule::mmc_put ( class(mpimessagecachetype)  this, integer(i4b)  unit, integer(i4b)  rank, integer(i4b)  stage, integer(i4b)  msg_id, integer  mpi_type  )

private

Parameters

this	the message cache
unit	the unit (solution or global)
rank	the rank of the MPI process to communicate with
stage	the simulation stage at which the message is sent
msg_id	the message type as an integer between 1 and NR_MSG_TYPES (see above for predefined values)
mpi_type	the mpi datatype to cache

Definition at line 76 of file MpiMessageCache.f90.

    class(MpiMessageCacheType) :: this !< the message cache
    integer(I4B) :: unit !< the unit (solution or global)
    integer(I4B) :: rank !< the rank of the MPI process to communicate with
    integer(I4B) :: stage !< the simulation stage at which the message is sent
    integer(I4B) :: msg_id !< the message type as an integer between 1 and NR_MSG_TYPES (see above for predefined values)
    integer :: mpi_type !< the mpi datatype to cache
    ! local
    integer(I4B) :: unit_idx
    type(MpiUnitCacheType), pointer :: new_cache
    class(*), pointer :: obj_ptr
 
    unit_idx = this%cached_ids%get_index(unit)
    if (unit_idx == -1) then
      ! add to vector with cached unit ids
      call this%cached_ids%push_back(unit)
      ! create and add unit cache
      allocate (new_cache)
      call new_cache%init(nr_sim_stages, nr_msg_types)
      obj_ptr => new_cache
      call this%unit_caches%Add(obj_ptr)
      unit_idx = this%cached_ids%size
    end if
 
    ! get the cache for this unit
    obj_ptr => this%unit_caches%GetItem(unit_idx)
    select type (obj_ptr)
    class is (mpiunitcachetype)
      call obj_ptr%cache(rank, stage, msg_id, mpi_type)
    end select
 

Variable Documentation

mpi_bdy_rcv

integer(i4b), parameter, public mpimessagecachemodule::mpi_bdy_rcv = 1

Definition at line 11 of file MpiMessageCache.f90.

  integer(I4B), public, parameter :: MPI_BDY_RCV = 1 !< receiving data (body) from ranks

mpi_bdy_snd

integer(i4b), parameter, public mpimessagecachemodule::mpi_bdy_snd = 2

Definition at line 12 of file MpiMessageCache.f90.

  integer(I4B), public, parameter :: MPI_BDY_SND = 2 !< sending data (body) to ranks

nr_msg_types

integer(i4b), parameter, public mpimessagecachemodule::nr_msg_types = 2

Definition at line 13 of file MpiMessageCache.f90.

  integer(I4B), public, parameter :: NR_MSG_TYPES = 2 !< the total number of message types to be cached