Teuchos_MPIComm.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_MPICOMM_H
#define TEUCHOS_MPICOMM_H


#include "Teuchos_ConfigDefs.hpp"
#include "Teuchos_Array.hpp"
#include "Teuchos_RCP.hpp"

#ifdef HAVE_MPI
#include "mpi.h"
#endif


namespace Teuchos
{
  class TEUCHOS_DEPRECATED TEUCHOS_LIB_DLL_EXPORT MPIComm
  {
  public:

    MPIComm();

#ifdef HAVE_MPI

    MPIComm(MPI_Comm comm);
#endif

    static MPIComm& world();
    static MPIComm& self();

    int getRank() const {return myRank_;}

    int getNProc() const {return nProc_;}

    void synchronize() const ;



    void allToAll(void* sendBuf, int sendCount, int sendType,
      void* recvBuf, int recvCount, int recvType) const ;

    void allToAllv(void* sendBuf, int* sendCount, int* sendDisplacements,
       int sendType,
       void* recvBuf, int* recvCount,
       int* recvDisplacements,
       int recvType) const ;

    void allReduce(void* input, void* result, int inputCount, int type,
       int op) const ;


    void gather(void* sendBuf, int sendCount, int sendType,
    void* recvBuf, int recvCount, int recvType,
    int root) const ;

    void gatherv(void* sendBuf, int sendCount, int sendType,
     void* recvBuf, int* recvCount, int* displacements, 
     int recvType, int root) const ;

    void allGather(void* sendBuf, int sendCount, int sendType,
       void* recvBuf, int recvCount, int recvType) const ;

    void allGatherv(void* sendBuf, int sendCount, int sendType,
        void* recvBuf, int* recvCount, int* recvDisplacements,
        int recvType) const ;

    void bcast(void* msg, int length, int type, int src) const ;


#ifdef HAVE_MPI

    MPI_Comm getComm() const {return comm_;}
#endif



    static const int INT;
    static const int FLOAT;
    static const int DOUBLE;
    static const int DOUBLE_INT;
    static const int CHAR;



    static const int SUM;
    static const int MIN;
    static const int MAX;
    static const int MINLOC;
    static const int MAXLOC;
    static const int PROD;

    // errCheck() checks the return value of an MPI call and throws
    // a ParallelException upon failure.
    static void errCheck(int errCode, const std::string& methodName);

#ifdef HAVE_MPI

    static MPI_Datatype getDataType(int type);

    static MPI_Op getOp(int op);
#endif
  private:
#ifdef HAVE_MPI
    MPI_Comm comm_;
#endif

    int nProc_;
    int myRank_;

    void init();

    int mpiIsRunning() const ;
  };
}
#endif