MPI_REDUCE_SCATTER_BLOCK(3)			     Open MPI			       MPI_REDUCE_SCATTER_BLOCK(3)

MPI_Reduce_scatter_block, MPI_Ireduce_scatter_block <#mpi-ireduce-scatter-block>, MPI_Reduce_scatter_block_init <#
mpi-reduce-scatter-block-init> — Combines values and scatters the results in blocks.

SYNTAX
   C Syntax
	  #include <mpi.h>

	  int MPI_Reduce_scatter_block(const void *sendbuf, void *recvbuf, int recvcount,
	       MPI_Datatype datatype, MPI_Op op, MPI_Comm comm)

	  int MPI_Ireduce_scatter_block(const void *sendbuf, void *recvbuf, int recvcount,
	       MPI_Datatype datatype, MPI_Op op, MPI_Comm comm, MPI_Request *request)

	  int MPI_Reduce_scatter_block_init(const void *sendbuf, void *recvbuf, int recvcount,
	       MPI_Datatype datatype, MPI_Op op, MPI_Comm comm, MPI_Info info, MPI_Request *request)

   Fortran Syntax
	  USE MPI
	  ! or the older form: INCLUDE 'mpif.h'
	  MPI_REDUCE_SCATTER_BLOCK(SENDBUF, RECVBUF, RECVCOUNT, DATATYPE, OP,
		       COMM, IERROR)
	       <type>  SENDBUF(*), RECVBUF(*)
	       INTEGER RECVCOUNT, DATATYPE, OP, COMM, IERROR

	  MPI_IREDUCE_SCATTER_BLOCK(SENDBUF, RECVBUF, RECVCOUNT, DATATYPE, OP,
		       COMM, REQUEST, IERROR)
	       <type>  SENDBUF(*), RECVBUF(*)
	       INTEGER RECVCOUNT, DATATYPE, OP, COMM, REQUEST, IERROR

	  MPI_REDUCE_SCATTER_BLOCK_INOT(SENDBUF, RECVBUF, RECVCOUNT, DATATYPE, OP,
		       COMM, INFO, REQUEST, IERROR)
	       <type>  SENDBUF(*), RECVBUF(*)
	       INTEGER RECVCOUNT, DATATYPE, OP, COMM, INFO, REQUEST, IERROR

   Fortran 2008 Syntax
	  USE mpi_f08
	  MPI_Ireduce_scatter_block(sendbuf, recvbuf, recvcount, datatype, op, comm,
		       ierror)
	       TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: sendbuf
	       TYPE(*), DIMENSION(..), ASYNCHRONOUS :: recvbuf
	       INTEGER, INTENT(IN) :: recvcount
	       TYPE(MPI_Datatype), INTENT(IN) :: datatype
	       TYPE(MPI_Op), INTENT(IN) :: op
	       TYPE(MPI_Comm), INTENT(IN) :: comm
	       INTEGER, OPTIONAL, INTENT(OUT) :: ierror

	  MPI_Ireduce_scatter_block(sendbuf, recvbuf, recvcount, datatype, op, comm,
		       request, ierror)
	       TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: sendbuf
	       TYPE(*), DIMENSION(..), ASYNCHRONOUS :: recvbuf
	       INTEGER, INTENT(IN) :: recvcount
	       TYPE(MPI_Datatype), INTENT(IN) :: datatype
	       TYPE(MPI_Op), INTENT(IN) :: op
	       TYPE(MPI_Comm), INTENT(IN) :: comm
	       TYPE(MPI_Request), INTENT(OUT) :: request
	       INTEGER, OPTIONAL, INTENT(OUT) :: ierror

	  MPI_Reduce_scatter_block_init(sendbuf, recvbuf, recvcount, datatype, op, comm,
		       info, request, ierror)
	       TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: sendbuf
	       TYPE(*), DIMENSION(..), ASYNCHRONOUS :: recvbuf
	       INTEGER, INTENT(IN) :: recvcount
	       TYPE(MPI_Datatype), INTENT(IN) :: datatype
	       TYPE(MPI_Op), INTENT(IN) :: op
	       TYPE(MPI_Comm), INTENT(IN) :: comm
	       TYPE(MPI_Info), INTENT(IN) :: info
	       TYPE(MPI_Request), INTENT(OUT) :: request
	       INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT PARAMETERS
       • sendbuf: Starting address of send buffer (choice).

       • recvcount: lement count per block (non-negative integer).

       • datatype: Datatype of elements of input buffer (handle).

       • op: Operation (handle).

       • comm: Communicator (handle).

       • info: Info (handle, persistent only).

OUTPUT PARAMETERS
       • recvbuf: Starting address of receive buffer (choice).

       • request: Request (handle, non-blocking only).

       • ierror: Fortran only: Error status (integer).

DESCRIPTION
       MPI_Reduce_scatter_block	 first	does an element-wise reduction on vector of count = n * recvcount elements
       in the send buffer defined by sendbuf, count, and datatype, using the operation op, where n is  the  number
       of processes in the group of comm. Next, the resulting vector of results is split into n disjoint segments,
       where n is the number of processes in the group. Each segments contains recvcount elements. The ith segment
       is sent to process i and stored in the receive buffer defined by recvbuf, recvcount, and datatype.

USE OF IN-PLACE OPTION
       When  the  communicator	is  an intracommunicator, you can perform a reduce-scatter operation in-place (the
       output buffer is used as the input buffer). Use the variable MPI_IN_PLACE as the value of the  sendbuf.	In
       this  case, the input data is taken from the top of the receive buffer. The area occupied by the input data
       may be either longer or shorter than the data filled by the output data.

WHEN COMMUNICATOR IS AN INTER-COMMUNICATOR
       When the communicator is an inter-communicator, the reduce-scatter operation occurs in two  phases.  First,
       the result of the reduction performed on the data provided by the processes in the first group is scattered
       among  the  processes  in  the  second  group. Then the reverse occurs: the reduction performed on the data
       provided by the processes in the second group is scattered among the processes in  the  first  group.   For
       each group, all processes provide the same recvcounts argument, and the sum of the recvcounts values should
       be the same for both groups.

NOTES ON COLLECTIVE OPERATIONS
       The  reduction  functions  ( MPI_Op ) do not return an error value. As a result, if the functions detect an
       error, all they can do is either call MPI_Abort <#mpi-abort> or silently skip the  problem.  Thus,  if  you
       change the error handler from MPI_ERRORS_ARE_FATAL to something else, for example, MPI_ERRORS_RETURN , then
       no error may be indicated.

       The  reason  for	 this is the performance problems in ensuring that all collective routines return the same
       error value.

ERRORS
       Almost all MPI routines return an error value; C routines as the return result of the function and  Fortran
       routines in the last argument.

       Before  the error value is returned, the current MPI error handler associated with the communication object
       (e.g., communicator, window, file) is called.  If no communication object is associated with the MPI  call,
       then  the call is considered attached to MPI_COMM_SELF and will call the associated MPI error handler. When
       MPI_COMM_SELF is not initialized (i.e.,	before	MPI_Init  <#mpi-init>/MPI_Init_thread  <#mpi-init-thread>,
       after  MPI_Finalize  <#mpi-finalize>,  or  when	using the Sessions Model exclusively) the error raises the
       initial error handler. The initial error handler can  be	 changed  by  calling  MPI_Comm_set_errhandler	<#
       mpi-comm-set-errhandler>	 on  MPI_COMM_SELF  when  using the World model, or the mpi_initial_errhandler CLI
       argument	 to  mpiexec  or  info	key   to   MPI_Comm_spawn   <#mpi-comm-spawn>/MPI_Comm_spawn_multiple	<#
       mpi-comm-spawn-multiple>.   If  no other appropriate error handler has been set, then the MPI_ERRORS_RETURN
       error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error  handler  is  called  for  all
       other MPI functions.

       Open MPI includes three predefined error handlers that can be used:

       • MPI_ERRORS_ARE_FATAL Causes the program to abort all connected MPI processes.

       • MPI_ERRORS_ABORT  An  error handler that can be invoked on a communicator, window, file, or session. When
	 called on a communicator, it acts as if MPI_Abort <#mpi-abort> was called on that communicator. If called
	 on a window or file, acts as if MPI_Abort <#mpi-abort> was called on a communicator containing the  group
	 of processes in the corresponding window or file. If called on a session, aborts only the local process.

       • MPI_ERRORS_RETURN Returns an error code to the application.

       MPI applications can also implement their own error handlers by calling:

       • MPI_Comm_create_errhandler	 <#mpi-comm-create-errhandler>	   then	    MPI_Comm_set_errhandler	<#
	 mpi-comm-set-errhandler>

       • MPI_File_create_errhandler	<#mpi-file-create-errhandler>	  then	   MPI_File_set_errhandler	<#
	 mpi-file-set-errhandler>

       • MPI_Session_create_errhandler	 <#mpi-session-create-errhandler>   then   MPI_Session_set_errhandler	<#
	 mpi-session-set-errhandler> or at MPI_Session_init <#mpi-session-init>

       • MPI_Win_create_errhandler	<#mpi-win-create-errhandler>	  then	    MPI_Win_set_errhandler	<#
	 mpi-win-set-errhandler>

       Note that MPI does not guarantee that an MPI program can continue past an error.

       See the MPI man page <#open-mpi> for a full list of MPI error codes <#open-mpi-errors>.

       See the Error Handling section of the MPI-3.1 standard for more information.

       See also:

	  • MPI_Reduce_scatter <#mpi-reduce-scatter>

Copyright
       2003-2026, The Open MPI Community

						   Mar 05, 2026			       MPI_REDUCE_SCATTER_BLOCK(3)
