Epetra_Comm.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_COMM_H
#define EPETRA_COMM_H

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



#include "Epetra_ConfigDefs.h"
#include "Epetra_Object.h"

class Epetra_Distributor;
class Epetra_Directory;
class Epetra_BlockMap;


class EPETRA_LIB_DLL_EXPORT Epetra_Comm {

  public:


  virtual Epetra_Comm * Clone() const = 0;
  virtual ~Epetra_Comm() {};



  virtual void Barrier() const = 0;



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


  virtual int Broadcast(int * MyVals, int Count, int Root) const = 0;


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


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


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




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


  virtual int GatherAll(int * MyVals, int * AllVals, int Count) const = 0;


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


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



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


  virtual int SumAll(int * PartialSums, int * GlobalSums, int Count) const = 0;


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


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



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


  virtual int MaxAll(int * PartialMaxs, int * GlobalMaxs, int Count) const = 0;


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


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


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


  virtual int MinAll(int * PartialMins, int * GlobalMins, int Count) const = 0;


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

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



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


  virtual int ScanSum(int * MyVals, int * ScanSums, int Count) const = 0;


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


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




  virtual int MyPID() const = 0;


  virtual int NumProc() const = 0;


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


  virtual void PrintInfo(std::ostream & os) const = 0;
};
#endif /* EPETRA_COMM_H */