Epetra_SerialComm.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_SERIALCOMM_H
#define EPETRA_SERIALCOMM_H

#include "Epetra_ConfigDefs.h"
#include "Epetra_Object.h"
#include "Epetra_Comm.h"
#include "Epetra_SerialCommData.h"
#ifdef EPETRA_HAVE_OMP
#include <omp.h>
#endif
class Epetra_Distributor;


class EPETRA_LIB_DLL_EXPORT Epetra_SerialComm: public Epetra_Object, public virtual Epetra_Comm {

  public:



  Epetra_SerialComm();



  Epetra_SerialComm(const Epetra_SerialComm& Comm);

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


  virtual ~Epetra_SerialComm();



  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;




  int MyPID() const {return(SerialCommData_->MyPID_);};

  int NumProc() const {return(SerialCommData_->NumProc_);};



  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;


  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 single
               os << "::Processor "<< MyPID()<<" of " << NumProc() << " total processors.";
#pragma omp critical
                os << "\n   Thread " << threadNum << " of " << numThreads << " total threads.";
}
#else
    os << "::Processor "<< MyPID()<<" of " << NumProc() << " total processors.";
#endif

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




  int ReferenceCount() const;


  const Epetra_SerialCommData * DataPtr() const {return(SerialCommData_);};


  Epetra_SerialComm & operator=(const Epetra_SerialComm & Comm);

 private:

  void CleanupData();
  Epetra_SerialCommData * SerialCommData_;

};
#endif /* EPETRA_SERIALCOMM_H */