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 namespace Teuchos {
00049 
00050 
00052 class CommRequest : public Teuchos::Describable {};
00053 
00054 
00071 template<typename Ordinal>
00072 class Comm : virtual public Describable {
00073 public:
00074   
00076 
00077 
00084   virtual int getRank() const = 0;
00085 
00092   virtual int getSize() const = 0;
00093   
00095 
00097 
00098 
00102   virtual void barrier() const = 0;
00103   
00118   virtual void broadcast(
00119     const int rootRank, const Ordinal bytes, char buffer[]
00120     ) const = 0;
00121 
00144   virtual void gatherAll(
00145     const Ordinal sendBytes, const char sendBuffer[]
00146     ,const Ordinal recvBytes, char recvBuffer[]
00147     ) const = 0;
00148 
00162   virtual void reduceAll(
00163     const ValueTypeReductionOp<Ordinal,char> &reductOp
00164     ,const Ordinal bytes, const char sendBuffer[], char globalReducts[]
00165     ) const = 0;
00166 
00190   virtual void reduceAllAndScatter(
00191     const ValueTypeReductionOp<Ordinal,char> &reductOp
00192     ,const Ordinal sendBytes, const char sendBuffer[]
00193     ,const Ordinal recvCounts[], char myGlobalReducts[]
00194     ) const = 0;
00195 
00209   virtual void scan(
00210     const ValueTypeReductionOp<Ordinal,char> &reductOp
00211     ,const Ordinal bytes, const char sendBuffer[], char scanReducts[]
00212     ) const = 0;
00213 
00215 
00216 
00233   virtual void send(
00234     const Ordinal bytes, const char sendBuffer[], const int destRank
00235     ) const = 0;
00236 
00257   virtual int receive(
00258     const int sourceRank, const Ordinal bytes, char recvBuffer[]
00259     ) const = 0;
00260 
00261 
00273   virtual void readySend(
00274     const ArrayView<const char> &sendBuffer,
00275     const int destRank
00276     ) const = 0;
00277   
00278 
00280 
00281 
00283 
00284 
00285 
00297   virtual RCP<CommRequest> isend(
00298     const ArrayView<const char> &sendBuffer,
00299     const int destRank
00300     ) const = 0;
00301 
00302 
00317   virtual RCP<CommRequest> ireceive(
00318     const ArrayView<char> &recvBuffer,
00319     const int sourceRank
00320     ) const = 0;
00321 
00322 
00333   virtual void waitAll(
00334     const ArrayView<RCP<CommRequest> > &requests
00335     ) const = 0;
00336 
00337 
00348   virtual void wait(
00349     const Ptr<RCP<CommRequest> > &request
00350     ) const = 0;
00351 
00352 
00354   
00355 }; // class Comm
00356 
00357 } // namespace Teuchos
00358 
00359 #endif // TEUCHOS_COMM_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines