Teuchos - Trilinos Tools Package Version of the Day
Teuchos_Comm.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef TEUCHOS_COMM_HPP
00043 #define TEUCHOS_COMM_HPP
00044 
00045 #include "Teuchos_ReductionOp.hpp"
00046 #include "Teuchos_ArrayRCP.hpp"
00047 
00048 
00049 namespace Teuchos {
00050 
00060 class CommRequest : public Teuchos::Describable {};
00061 
00078 template<class OrdinalType>
00079 class CommStatus {
00080 public:
00082   virtual ~CommStatus() {}
00083 
00085   virtual OrdinalType getSourceRank () = 0;
00086 };
00087 
00104 template<typename Ordinal>
00105 class Comm : virtual public Describable {
00106 public:
00107   
00109 
00110 
00117   virtual int getRank() const = 0;
00118 
00125   virtual int getSize() const = 0;
00126   
00128 
00130 
00131 
00135   virtual void barrier() const = 0;
00136   
00151   virtual void broadcast(
00152     const int rootRank, const Ordinal bytes, char buffer[]
00153     ) const = 0;
00154 
00177   virtual void gatherAll(
00178     const Ordinal sendBytes, const char sendBuffer[]
00179     ,const Ordinal recvBytes, char recvBuffer[]
00180     ) const = 0;
00181 
00195   virtual void reduceAll(
00196     const ValueTypeReductionOp<Ordinal,char> &reductOp
00197     ,const Ordinal bytes, const char sendBuffer[], char globalReducts[]
00198     ) const = 0;
00199 
00223   virtual void reduceAllAndScatter(
00224     const ValueTypeReductionOp<Ordinal,char> &reductOp
00225     ,const Ordinal sendBytes, const char sendBuffer[]
00226     ,const Ordinal recvCounts[], char myGlobalReducts[]
00227     ) const = 0;
00228 
00242   virtual void scan(
00243     const ValueTypeReductionOp<Ordinal,char> &reductOp
00244     ,const Ordinal bytes, const char sendBuffer[], char scanReducts[]
00245     ) const = 0;
00246 
00248 
00249 
00270   virtual void send(
00271     const Ordinal bytes, const char sendBuffer[], const int destRank
00272     ) const = 0;
00273 
00293   virtual void ssend(
00294     const Ordinal bytes, const char sendBuffer[], const int destRank
00295     ) const = 0;
00296 
00297 
00318   virtual int receive(
00319     const int sourceRank, const Ordinal bytes, char recvBuffer[]
00320     ) const = 0;
00321 
00322 
00334   virtual void readySend(
00335     const ArrayView<const char> &sendBuffer,
00336     const int destRank
00337     ) const = 0;
00338   
00339 
00341 
00342 
00344 
00345 
00346 
00358   virtual RCP<CommRequest> isend(
00359     const ArrayView<const char> &sendBuffer,
00360     const int destRank
00361     ) const = 0;
00362 
00363 
00378   virtual RCP<CommRequest> ireceive(
00379     const ArrayView<char> &recvBuffer,
00380     const int sourceRank
00381     ) const = 0;
00382 
00383 
00394   virtual void waitAll(
00395     const ArrayView<RCP<CommRequest> > &requests
00396     ) const = 0;
00397 
00414   virtual void 
00415   waitAll (const ArrayView<RCP<CommRequest> >& requests,
00416      const ArrayView<RCP<CommStatus<Ordinal> > >& statuses) const = 0;
00417 
00442   virtual RCP<CommStatus<Ordinal> > 
00443   wait (const Ptr<RCP<CommRequest> >& request) const = 0;
00444 
00446 
00448 
00449 
00459   virtual RCP< Comm > duplicate() const = 0;
00460 
00487   virtual RCP< Comm > split(const int color, const int key) const = 0;
00488 
00506   virtual RCP<Comm> createSubcommunicator(
00507     const ArrayView<const int>& ranks) const = 0;
00508 
00510   
00511 }; // class Comm
00512   
00513 } // namespace Teuchos
00514 
00515 #endif // TEUCHOS_COMM_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines