Epetra_MpiComm.h

Go to the documentation of this file.

/*
//@HEADER
// ************************************************************************
//
//               Epetra: Linear Algebra Services Package
//                 Copyright 2011 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 EPETRA_MPICOMM_H
#define EPETRA_MPICOMM_H

#if defined(Epetra_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The Epetra package is deprecated"
#endif
#endif


#include "Epetra_Object.h"
#include "Epetra_Comm.h"
#include "Epetra_MpiDistributor.h"
class Epetra_Distributor;
#include "Epetra_BasicDirectory.h"
class Epetra_Directory;
class Epetra_BlockMap;
#include <mpi.h>
#include "Epetra_MpiCommData.h"
#ifdef EPETRA_HAVE_OMP
#include <omp.h>
#endif


class EPETRA_LIB_DLL_EXPORT Epetra_MpiComm: public Epetra_Object, public virtual Epetra_Comm {

  public:



  Epetra_MpiComm(MPI_Comm comm);



  Epetra_MpiComm(const Epetra_MpiComm & Comm);

  Epetra_Comm * Clone() const
    {
      return(new Epetra_MpiComm(*this));
    };


  virtual ~Epetra_MpiComm();



  void Barrier() const;



  int Broadcast(double * MyVals, int Count, int Root) const;


  int Broadcast(int * MyVals, int Count, int Root) const;


  int Broadcast(long * MyVals, int Count, int Root) const;


  int Broadcast(long long * MyVals, int Count, int Root) const;


  int Broadcast(char * MyVals, int Count, int Root) const;



  int GatherAll(double * MyVals, double * AllVals, int Count) const;


  int GatherAll(int * MyVals, int * AllVals, int Count) const;


  int GatherAll(long * MyVals, long * AllVals, int Count) const;


  int GatherAll(long long * MyVals, long long * AllVals, int Count) const;



  int SumAll(double * PartialSums, double * GlobalSums, int Count) const;


  int SumAll(int * PartialSums, int * GlobalSums, int Count) const;


  int SumAll(long * PartialSums, long * GlobalSums, int Count) const;


  int SumAll(long long * PartialSums, long long * GlobalSums, int Count) const;



  int MaxAll(double * PartialMaxs, double * GlobalMaxs, int Count) const;


  int MaxAll(int * PartialMaxs, int * GlobalMaxs, int Count) const;


  int MaxAll(long * PartialMaxs, long * GlobalMaxs, int Count) const;


  int MaxAll(long long * PartialMaxs, long long * GlobalMaxs, int Count) const;


  int MinAll(double * PartialMins, double * GlobalMins, int Count) const;


  int MinAll(int * PartialMins, int * GlobalMins, int Count) const;


  int MinAll(long * PartialMins, long * GlobalMins, int Count) const;


  int MinAll(long long * PartialMins, long long * GlobalMins, int Count) const;



  int ScanSum(double * MyVals, double * ScanSums, int Count) const;


  int ScanSum(int * MyVals, int * ScanSums, int Count) const;


  int ScanSum(long * MyVals, long * ScanSums, int Count) const;


  int ScanSum(long long * MyVals, long long * ScanSums, int Count) const;



  MPI_Comm Comm() const {return(MpiCommData_->Comm_);};


  int MyPID() const {return(MpiCommData_->rank_);};


  int NumProc() const {return(MpiCommData_->size_);};


  Epetra_Distributor * CreateDistributor() const;
// CreateDirectory is defined in Winbase.h as a macro!
#ifdef CreateDirectory
#undef CreateDirectory
#endif
  Epetra_Directory * CreateDirectory(const Epetra_BlockMap & Map) const;


  int GetMpiTag() const {int tag = MpiCommData_->curTag_++; if (tag > MpiCommData_->maxTag_) tag = MpiCommData_->minTag_; return(tag);};

  MPI_Comm GetMpiComm() const {return(MpiCommData_->Comm_);};

  inline void Print(std::ostream & os) const {
#ifdef EPETRA_HAVE_OMP
#pragma omp parallel
{
  int numThreads = omp_get_num_threads();
  int threadNum = omp_get_thread_num();
#pragma omp critical
                os << "\n   Thread/TotalThreads " << threadNum << "/" << numThreads << " on Processor/TotalProcs "
    <<  MyPID() << "/" << NumProc();
}
#else
                os << "::Processor "<< MyPID()<<" of " << NumProc() << " total processors.";
#endif
  return;}
  void PrintInfo(std::ostream & os) const {Epetra_MpiComm::Print(os);return;};




  int ReferenceCount() const {return(MpiCommData_->ReferenceCount());};


  const Epetra_MpiCommData * DataPtr() const {return(MpiCommData_);};


  Epetra_MpiComm & operator=(const Epetra_MpiComm & Comm);

 private:

  int CheckInput(double * ptr, int count) const {if ((ptr==0) && (count>0)) return(-1); return(0);};
  int CheckInput(int * ptr, int count) const {if ((ptr==0) && (count>0)) return(-1); return(0);};
  int CheckInput(long * ptr, int count) const {if ((ptr==0) && (count>0)) return(-1); return(0);};
  int CheckInput(char * ptr, int count) const {if ((ptr==0) && (count>0)) return(-1); return(0);};
  int CheckInput(long long * ptr, int count) const {if ((ptr==0) && (count>0)) return(-1); return(0);};

  void CleanupData();
  Epetra_MpiCommData * MpiCommData_;

};
#endif /* EPETRA_MPICOMM_H */