MPI Subroutine Reference

MPI::Comm::Clone

Purpose

Creates a new communicator that is a duplicate of an existing communicator.

C++ synopsis

#include mpi.h
MPI::Cartcomm& MPI::Cartcomm::Clone() const;

#include mpi.h
MPI::Graphcomm& MPI::Graphcomm::Clone() const;

#include mpi.h
MPI::Intercomm& MPI::Intercomm::Clone() const;

#include mpi.h
MPI::Intracomm& MPI::Intracomm::Clone() const;

Parameters

comm

is the communicator (handle) (IN)

newcomm

is the copy of comm (handle) (OUT)

IERROR

is the FORTRAN return code. It is always the last argument.

Description

This subroutine is a pure virtual function. For the derived communicator classes, MPI::Comm::Clone() behaves like Dup(), except that it returns a new object by reference.

Errors

Conflicting collective operations on communicator

A copy_fn did not return MPI_SUCCESS

A delete_fn did not return MPI_SUCCESS

Invalid communicator

MPI not initialized

MPI already finalized

Related information

MPI_COMM_DUP