Epetra_MpiSmpComm.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_MPISMPCOMM_H
#define EPETRA_MPISMPCOMM_H
#include "Epetra_Object.h"
#include "Epetra_Comm.h"
#include "Epetra_MpiDistributor.h"
#include <mpi.h>
class Epetra_Distributor;
#include "Epetra_MpiSmpCommData.h"


class EPETRA_DEPRECATED Epetra_MpiSmpComm: public Epetra_Object, public virtual Epetra_Comm {

  public:



  Epetra_MpiSmpComm(MPI_Comm comm);



  Epetra_MpiSmpComm(const Epetra_MpiSmpComm& Comm);

  Epetra_Comm * Clone() const {
    return(dynamic_cast<Epetra_Comm *>(new Epetra_MpiSmpComm(*this)));
  };


  virtual ~Epetra_MpiSmpComm();



  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(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 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 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 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 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;



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


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


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


  Epetra_Distributor * CreateDistributor() const;
  Epetra_Directory * CreateDirectory(const Epetra_BlockMap & Map) const;


  int GetMpiTag() const {int tag = MpiSmpCommData_->curTag_++; if (tag>MpiSmpCommData_->maxTag_) tag = MpiSmpCommData_->minTag_; return(tag);};
  MPI_Comm GetMpiComm() const {return(MpiSmpCommData_->Comm_);};


  void NodeBarrier() const;


  int MyThreadID() const {return(MpiSmpCommData_->ThreadID_);};


  int MyNodeID() const {return(MpiSmpCommData_->NodeID_);};


  int SetNumThreads(int NumThreads) {MpiSmpCommData_->NumThreads_ = NumThreads; return(0);};


  int NumThreads() const {return(MpiSmpCommData_->NumThreads_);};


  int SetMyThreadID(int ThreadID) {MpiSmpCommData_->ThreadID_ = ThreadID; return(0);};


  int SetMyNodeID(int NodeID) {MpiSmpCommData_->NodeID_ = NodeID; return(0);};


  inline void Print(std::ostream & os) const {
  os << "::Processor "<< MyPID()<<" of " << NumProc() << " total processors" << std::endl;
  os << "::Thread "<< MyThreadID()<<" of " << NumThreads() << " on node " << MyNodeID() << std::endl;
  return;}

  void PrintInfo(std::ostream & os) const {Epetra_MpiSmpComm::Print(os);return;};


  Epetra_MpiSmpComm & operator=(const Epetra_MpiSmpComm & Comm);

 private:

  void CleanupData();
  Epetra_MpiSmpCommData * MpiSmpCommData_;

};
#endif /* EPETRA_MPISMPCOMM_H */