mpiunitcachemodule Module Reference

Data Types
type	mpiunitcachetype

Functions/Subroutines
subroutine	cc_init (this, nr_stages, nr_msg_types)
	Initialize the unit cache. More...
integer function	cc_get_cached (this, rank, stage, msg_id)
	Get the cached mpi type for this rank and. More...
subroutine	cc_cache (this, rank, stage, msg_id, mpi_type)
	Cache the mpi datatype for this particular rank and stage. The datatype should be committed. More...
logical(lgp) function	is_rank_cached (this, rank)
subroutine	add_rank_cache (this, rank)
integer(i4b) function	get_rank_index (this, rank)
	@Brief returns -1 when not present More...
integer(i4b) function	get_msg_index (this, rank, stage, msg_id)
	@Brief returns -1 when not present More...
subroutine	cc_clear (this)
	Clear the cache: free MPI types. More...
subroutine	cc_destroy (this)
	Destroy unit cache. More...

Variables
integer(i4b), parameter, public	no_cached_value = -1

Function/Subroutine Documentation

add_rank_cache()

subroutine mpiunitcachemodule::add_rank_cache ( class(mpiunitcachetype)  this, integer(i4b)  rank  )

private

Definition at line 100 of file MpiUnitCache.f90.

    class(MpiUnitCacheType) :: this
    integer(I4B) :: rank
    ! local
    integer(I4B) :: i, j
 
    call this%cached_ranks%push_back(rank)
    do i = 1, this%nr_stages
      do j = 1, this%nr_msg_types
        call this%cached_messages%push_back(no_cached_value)
      end do
    end do
 

cc_cache()

subroutine mpiunitcachemodule::cc_cache ( class(mpiunitcachetype)  this, integer(i4b)  rank, integer(i4b)  stage, integer(i4b)  msg_id, integer  mpi_type  )

private

Definition at line 70 of file MpiUnitCache.f90.

    class(MpiUnitCacheType) :: this
    integer(I4B) :: rank
    integer(I4B) :: stage
    integer(I4B) :: msg_id
    integer :: mpi_type
    ! local
    integer(I4B) :: msg_idx
 
    ! add if rank not present in cache yet
    if (.not. this%is_rank_cached(rank)) then
      call this%add_rank_cache(rank)
    end if
 
    ! rank has been added to cache, now set
    ! mpi datatype for this stage's message:
    msg_idx = this%get_msg_index(rank, stage, msg_id)
    call this%cached_messages%set(msg_idx, mpi_type)
 

cc_clear()

subroutine mpiunitcachemodule::cc_clear ( class(mpiunitcachetype)  this )

private

Definition at line 150 of file MpiUnitCache.f90.

    class(MpiUnitCacheType) :: this
    ! local
    integer(I4B) :: i
    integer :: mpi_type, ierr
 
    do i = 1, this%cached_messages%size
      mpi_type = this%cached_messages%at(i)
      if (mpi_type /= no_cached_value) then
        call mpi_type_free(mpi_type, ierr)
        call check_mpi(ierr)
      end if
    end do
    call this%cached_messages%clear()
 

Here is the call graph for this function:

cc_destroy()

subroutine mpiunitcachemodule::cc_destroy ( class(mpiunitcachetype)  this )

private

Definition at line 169 of file MpiUnitCache.f90.

    class(MpiUnitCacheType) :: this
 
    call this%cached_ranks%destroy()
    call this%cached_messages%destroy()
 

cc_get_cached()

integer function mpiunitcachemodule::cc_get_cached ( class(mpiunitcachetype)  this, integer(i4b)  rank, integer(i4b)  stage, integer(i4b)  msg_id  )

private

Definition at line 50 of file MpiUnitCache.f90.

    class(MpiUnitCacheType) :: this
    integer(I4B) :: rank
    integer(I4B) :: stage
    integer(I4B) :: msg_id
    integer :: mpi_type
    ! local
    integer(I4B) :: msg_idx
 
    mpi_type = no_cached_value
    msg_idx = this%get_msg_index(rank, stage, msg_id)
    if (msg_idx > 0) then
      mpi_type = this%cached_messages%at(msg_idx)
    end if
 

cc_init()

subroutine mpiunitcachemodule::cc_init	(	class(mpiunitcachetype)	this,
		integer(i4b)	nr_stages,
		integer(i4b)	nr_msg_types
	)

Parameters

nr_stages	number of (simulation) stages
nr_msg_types	number of message types to be cached during a stage

Definition at line 36 of file MpiUnitCache.f90.

    class(MpiUnitCacheType) :: this
    integer(I4B) :: nr_stages !< number of (simulation) stages
    integer(I4B) :: nr_msg_types !< number of message types to be cached during a stage
 
    this%nr_stages = nr_stages
    this%nr_msg_types = nr_msg_types
    call this%cached_ranks%init()
    call this%cached_messages%init()
 

get_msg_index()

integer(i4b) function mpiunitcachemodule::get_msg_index ( class(mpiunitcachetype)  this, integer(i4b)  rank, integer(i4b)  stage, integer(i4b)  msg_id  )

private

Definition at line 128 of file MpiUnitCache.f90.

    class(MpiUnitCacheType) :: this
    integer(I4B) :: rank
    integer(I4B) :: stage
    integer(I4B) :: msg_id
    integer(I4B) :: msg_index
    ! local
    integer(I4B) :: rank_idx
    integer(I4B) :: rank_offset, stage_offset
 
    msg_index = -1
    rank_idx = this%get_rank_index(rank)
    if (rank_idx < 1) return
 
    rank_offset = (rank_idx - 1) * (this%nr_stages * this%nr_msg_types)
    stage_offset = (stage - 1) * this%nr_msg_types
    msg_index = rank_offset + stage_offset + msg_id
 

get_rank_index()

integer(i4b) function mpiunitcachemodule::get_rank_index ( class(mpiunitcachetype)  this, integer(i4b)  rank  )

private

Definition at line 117 of file MpiUnitCache.f90.

    class(MpiUnitCacheType) :: this
    integer(I4B) :: rank
    integer(I4B) :: rank_index
 
    rank_index = this%cached_ranks%get_index(rank)
 

is_rank_cached()

logical(lgp) function mpiunitcachemodule::is_rank_cached ( class(mpiunitcachetype)  this, integer(i4b)  rank  )

private

Definition at line 91 of file MpiUnitCache.f90.

    class(MpiUnitCacheType) :: this
    integer(I4B) :: rank
    logical(LGP) :: in_cache
 
    in_cache = this%cached_ranks%contains(rank)
 

Variable Documentation

no_cached_value

integer(i4b), parameter, public mpiunitcachemodule::no_cached_value = -1

Definition at line 11 of file MpiUnitCache.f90.

  integer(I4B), public, parameter :: NO_CACHED_VALUE = -1