MpiComm.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// QUESO - a library to support the Quantification of Uncertainty
// for Estimation, Simulation and Optimization
//
// Copyright (C) 2008,2009,2010,2011,2012,2013 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-

#ifndef UQ_MPI_COMM_H
#define UQ_MPI_COMM_H

#include <queso/Defines.h>

#ifdef QUESO_HAS_TRILINOS
#include <Epetra_MpiComm.h>
#endif

#include <mpi.h>

namespace QUESO {

typedef MPI_Comm     RawType_MPI_Comm ;
typedef MPI_Group    RawType_MPI_Group ;
typedef MPI_Datatype RawType_MPI_Datatype ;
typedef MPI_Op       RawType_MPI_Op ;
typedef MPI_Status   RawType_MPI_Status ;
#define RawValue_MPI_COMM_SELF  MPI_COMM_SELF 
#define RawValue_MPI_IN_PLACE   MPI_IN_PLACE
#define RawValue_MPI_ANY_SOURCE MPI_ANY_SOURCE
#define RawValue_MPI_CHAR       MPI_CHAR
#define RawValue_MPI_INT        MPI_INT
#define RawValue_MPI_DOUBLE     MPI_DOUBLE
#define RawValue_MPI_UNSIGNED   MPI_UNSIGNED
#define RawValue_MPI_MIN        MPI_MIN
#define RawValue_MPI_MAX        MPI_MAX
#define RawValue_MPI_SUM        MPI_SUM

}  // End namespace QUESO


namespace QUESO {

class BaseEnvironment;

class MpiComm
{
public:



  MpiComm();
  

  MpiComm(const BaseEnvironment& env, RawType_MPI_Comm inputRawComm);
  

  MpiComm(const MpiComm& src);
  
 ~MpiComm();
 

  MpiComm& operator= (const MpiComm& rhs);
  
  

  RawType_MPI_Comm Comm     () const;
  
  int                MyPID    () const;
  
  int                NumProc  () const;
  


  void               Allreduce(void* sendbuf, void* recvbuf, int count, RawType_MPI_Datatype datatype, 
                               RawType_MPI_Op op, const char* whereMsg, const char* whatMsg) const;
                               

  void               Barrier  () const; // const char* whereMsg, const char* whatMsg) const;
  

  void               Bcast    (void* buffer, int count, RawType_MPI_Datatype datatype, int root,
                               const char* whereMsg, const char* whatMsg) const;
                               

  void               Gather   (void *sendbuf, int sendcnt, RawType_MPI_Datatype sendtype, 
                               void *recvbuf, int recvcount, RawType_MPI_Datatype recvtype, 
                               int root,
                               const char* whereMsg, const char* whatMsg) const;
                               

  void               Gatherv  (void *sendbuf, int sendcnt, RawType_MPI_Datatype sendtype, 
                               void *recvbuf, int *recvcnts, int *displs, RawType_MPI_Datatype recvtype, 
                               int root,
                               const char* whereMsg, const char* whatMsg) const;
                               

  void               Recv     (void *buf, int count, RawType_MPI_Datatype datatype, int source, int tag, RawType_MPI_Status *status,
                               const char* whereMsg, const char* whatMsg) const;
                               

  void               Send     (void *buf, int count, RawType_MPI_Datatype datatype, int dest, int tag,
                               const char* whereMsg, const char* whatMsg) const;
                               

  void               syncPrintDebugMsg(const char* msg, unsigned int msgVerbosity, unsigned int numUSecs) const;

#ifdef QUESO_HAS_TRILINOS
  const Epetra_MpiComm& epetraMpiComm() const;
#endif
  
private:
  void               copy          (const MpiComm& src);

  // QUESO environment 
  const BaseEnvironment& m_env;
#ifdef QUESO_HAS_TRILINOS
  
  // Epetra MPI communicator
  Epetra_MpiComm*               m_epetraMpiComm;
#endif
  RawType_MPI_Comm            m_rawComm;
  
  int                           m_worldRank;
  
  int                           m_myPid;
  
  // Total number of processes
  int                           m_numProc;
};

}  // End namespace QUESO

#endif // UQ_MPI_COMM_H