Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_Comm.hpp
Go to the documentation of this file.
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 
00051 
00053 class CommRequest : public Teuchos::Describable {};
00054  
00055 
00072 template<typename Ordinal>
00073 class Comm : virtual public Describable {
00074 public:
00075   
00077 
00078 
00085   virtual int getRank() const = 0;
00086 
00093   virtual int getSize() const = 0;
00094   
00096 
00098 
00099 
00103   virtual void barrier() const = 0;
00104   
00119   virtual void broadcast(
00120     const int rootRank, const Ordinal bytes, char buffer[]
00121     ) const = 0;
00122 
00145   virtual void gatherAll(
00146     const Ordinal sendBytes, const char sendBuffer[]
00147     ,const Ordinal recvBytes, char recvBuffer[]
00148     ) const = 0;
00149 
00163   virtual void reduceAll(
00164     const ValueTypeReductionOp<Ordinal,char> &reductOp
00165     ,const Ordinal bytes, const char sendBuffer[], char globalReducts[]
00166     ) const = 0;
00167 
00191   virtual void reduceAllAndScatter(
00192     const ValueTypeReductionOp<Ordinal,char> &reductOp
00193     ,const Ordinal sendBytes, const char sendBuffer[]
00194     ,const Ordinal recvCounts[], char myGlobalReducts[]
00195     ) const = 0;
00196 
00210   virtual void scan(
00211     const ValueTypeReductionOp<Ordinal,char> &reductOp
00212     ,const Ordinal bytes, const char sendBuffer[], char scanReducts[]
00213     ) const = 0;
00214 
00216 
00217 
00234   virtual void send(
00235     const Ordinal bytes, const char sendBuffer[], const int destRank
00236     ) const = 0;
00237 
00258   virtual int receive(
00259     const int sourceRank, const Ordinal bytes, char recvBuffer[]
00260     ) const = 0;
00261 
00262 
00274   virtual void readySend(
00275     const ArrayView<const char> &sendBuffer,
00276     const int destRank
00277     ) const = 0;
00278   
00279 
00281 
00282 
00284 
00285 
00286 
00298   virtual RCP<CommRequest> isend(
00299     const ArrayView<const char> &sendBuffer,
00300     const int destRank
00301     ) const = 0;
00302 
00303 
00318   virtual RCP<CommRequest> ireceive(
00319     const ArrayView<char> &recvBuffer,
00320     const int sourceRank
00321     ) const = 0;
00322 
00323 
00334   virtual void waitAll(
00335     const ArrayView<RCP<CommRequest> > &requests
00336     ) const = 0;
00337 
00338 
00349   virtual void wait(
00350     const Ptr<RCP<CommRequest> > &request
00351     ) const = 0;
00352 
00353 
00355 
00357 
00358 
00368   virtual RCP< Comm > duplicate() const = 0;
00369 
00396   virtual RCP< Comm > split(const int color, const int key) const = 0;
00397 
00415   virtual RCP<Comm> createSubcommunicator(
00416     const ArrayView<const int>& ranks) const = 0;
00417 
00419   
00420 }; // class Comm
00421   
00422 } // namespace Teuchos
00423 
00424 #endif // TEUCHOS_COMM_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines