EpetraExt_ZoltanMpiComm.h

Go to the documentation of this file.

//@HEADER
// ***********************************************************************
//
//     EpetraExt: Epetra Extended - 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 EPETRAEXT_ZOLTANMPICOMM_H
#define EPETRAEXT_ZOLTANMPICOMM_H

#include "Epetra_Object.h"
#include "Epetra_Comm.h"
#include "EpetraExt_ZoltanMpiDistributor.h"

class Epetra_Distributor;

#include "Epetra_BasicDirectory.h"
class Epetra_Directory;
class Epetra_BlockMap;

#include <mpi.h>

#include "EpetraExt_ZoltanMpiCommData.h"

namespace EpetraExt {


class EPETRAEXT_DEPRECATED ZoltanMpiComm: public Epetra_Object, public virtual Epetra_Comm {
    
 public:



  ZoltanMpiComm(MPI_Comm comm);



  ZoltanMpiComm(const ZoltanMpiComm & Comm);

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


  virtual ~ZoltanMpiComm();



  void Barrier() const;



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


  int Broadcast(int * 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 SumAll(double * PartialSums, double * GlobalSums, int Count) const;


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



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



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


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



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



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



  int ScanSum(int * MyVals, int * 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;
  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(ostream & os) const {
  os << "  Processor "<< MyPID()<<" of " << NumProc() << " total processors"; 
  return;}
  void PrintInfo(ostream & os) const {ZoltanMpiComm::Print(os);return;};



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


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


  ZoltanMpiComm & operator=(const ZoltanMpiComm & 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);};

  void CleanupData();
  ZoltanMpiCommData * MpiCommData_;

};

} //namespace EpetraExt

#endif /* EPETRAEXT_ZOLTANMPICOMM_H */