mpiworldmodule Module Reference

Data Types
type	mpiworldtype

Functions/Subroutines
type(mpiworldtype) function, pointer, public	get_mpi_world ()
logical(lgp) function	mpiw_has_comm (this)
	Returns true when a communicator has been set. More...
subroutine	mpiw_set_comm (this, comm)
	Sets a communicator on this world, can. More...
subroutine	mpiw_init (this)
subroutine	mpiw_begin_order (this)
subroutine	mpiw_end_order (this)
subroutine	mpiw_destroy (this)
subroutine, public	check_mpi (mpi_error_code)
	Check the MPI error code, report, and. More...
subroutine, public	mpi_stop (status)

Variables
type(mpiworldtype), pointer	global_mpi_world

Function/Subroutine Documentation

check_mpi()

subroutine, public mpiworldmodule::check_mpi

(

integer

mpi_error_code

)

Definition at line 115 of file MpiWorld.f90.

    use simmodule, only: store_error
    integer :: mpi_error_code
    ! local
    character(len=1024) :: mpi_err_msg
    integer :: err_len
    integer :: ierr
 
    if (mpi_error_code /= mpi_success) then
      call mpi_error_string(mpi_error_code, mpi_err_msg, err_len, ierr)
      call store_error("Internal error: "//trim(mpi_err_msg), terminate=.true.)
    end if
 

Here is the call graph for this function:

Here is the caller graph for this function:

get_mpi_world()

type(mpiworldtype) function, pointer, public mpiworldmodule::get_mpi_world

Definition at line 31 of file MpiWorld.f90.

    type(MpiWorldType), pointer :: world
 
    if (.not. associated(global_mpi_world)) then
      allocate (global_mpi_world)
    end if
    world => global_mpi_world
 

Here is the caller graph for this function:

mpi_stop()

subroutine, public mpiworldmodule::mpi_stop

(

integer(i4b)

status

)

Definition at line 130 of file MpiWorld.f90.

    integer(I4B) :: status
    ! local
    type(MpiWorldType), pointer :: mpi_world
    integer :: ierr
 
    mpi_world => get_mpi_world()
    write (*, *) "" ! empty line
    call mpi_abort(mpi_world%comm, status, ierr)
 

Here is the call graph for this function:

Here is the caller graph for this function:

mpiw_begin_order()

subroutine mpiworldmodule::mpiw_begin_order ( class(mpiworldtype)  this )

private

Definition at line 74 of file MpiWorld.f90.

    class(MpiWorldType) :: this
    ! local
    integer :: buffer
    integer :: status(MPI_STATUS_SIZE)
    integer :: ierr
 
    if (this%mpi_rank > 0) then
      call mpi_recv(buffer, 1, mpi_integer, this%mpi_rank - 1, this%mpi_rank, &
                    this%comm, status, ierr)
    end if
 

mpiw_destroy()

subroutine mpiworldmodule::mpiw_destroy ( class(mpiworldtype)  this )

private

Definition at line 100 of file MpiWorld.f90.

    class(MpiWorldType) :: this
 
    if (associated(this%comm)) then
      deallocate (this%comm)
    end if
 
    if (associated(global_mpi_world)) then
      deallocate (global_mpi_world)
    end if
 

mpiw_end_order()

subroutine mpiworldmodule::mpiw_end_order ( class(mpiworldtype)  this )

private

Definition at line 88 of file MpiWorld.f90.

    class(MpiWorldType) :: this
    ! local
    integer :: ierr
 
    if (this%mpi_rank < this%world_size - 1) then
      call mpi_send(this%mpi_rank, 1, mpi_integer, this%mpi_rank + 1, &
                    this%mpi_rank + 1, this%comm, ierr)
    end if
 

mpiw_has_comm()

logical(lgp) function mpiworldmodule::mpiw_has_comm ( class(mpiworldtype)  this )

private

Definition at line 43 of file MpiWorld.f90.

    class(MpiWorldType) :: this
    logical(LGP) :: has_comm
 
    has_comm = associated(this%comm)
 

mpiw_init()

subroutine mpiworldmodule::mpiw_init ( class(mpiworldtype)  this )

private

Definition at line 62 of file MpiWorld.f90.

    class(MpiWorldType) :: this
    ! local
    integer :: ierr
 
    call mpi_comm_size(this%comm, this%world_size, ierr)
    call mpi_comm_rank(this%comm, this%mpi_rank, ierr)
    nr_procs = this%world_size
    proc_id = this%mpi_rank
 

mpiw_set_comm()

subroutine mpiworldmodule::mpiw_set_comm ( class(mpiworldtype)  this, integer(i4b)  comm  )

private

Definition at line 53 of file MpiWorld.f90.

    class(MpiWorldType) :: this
    integer(I4B) :: comm
 
    allocate (this%comm)
    this%comm = comm
 

Variable Documentation

global_mpi_world

type(mpiworldtype), pointer mpiworldmodule::global_mpi_world

Definition at line 27 of file MpiWorld.f90.

  type(MpiWorldType), pointer :: global_mpi_world