Teuchos - Trilinos Tools Package Version of the Day
Teuchos_MpiReductionOpSetter.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_MPI_REDUCTION_OP_SETTER_HPP
00043 #define TEUCHOS_MPI_REDUCTION_OP_SETTER_HPP
00044 
00045 #include "Teuchos_RCP.hpp"
00046 #include "Teuchos_ReductionOp.hpp"
00047 #include "mpi.h"
00048 
00049 namespace Teuchos {
00050 
00059 class TEUCHOS_LIB_DLL_EXPORT MpiReductionOpBase : virtual public Describable {
00060 public:
00062   virtual void reduce(
00063     void              *invec
00064     ,void             *inoutvec
00065     ,int              *len
00066     ,MPI_Datatype     *datatype
00067     ) const = 0;
00068 };
00069 
00073 template<typename Ordinal>
00074 class MpiReductionOp : public MpiReductionOpBase {
00075 public:
00077   MpiReductionOp( const RCP<const ValueTypeReductionOp<Ordinal,char> > &reductOp );
00079   void reduce(
00080     void              *invec
00081     ,void             *inoutvec
00082     ,int              *len
00083     ,MPI_Datatype     *datatype
00084     ) const;
00085 private:
00086   RCP<const ValueTypeReductionOp<Ordinal,char> > reductOp_;
00087   // Not defined and not to be called
00088   MpiReductionOp();
00089   MpiReductionOp(const MpiReductionOp&);
00090   MpiReductionOp& operator=(const MpiReductionOp&);
00091 };
00092 
00096 template<typename Ordinal>
00097 RCP<const MpiReductionOp<Ordinal> >
00098 mpiReductionOp( const RCP<const ValueTypeReductionOp<Ordinal,char> > &reductOp );
00099 
00122 class TEUCHOS_LIB_DLL_EXPORT MpiReductionOpSetter {
00123 public:
00124 
00137   MpiReductionOpSetter( const Teuchos::RCP<const MpiReductionOpBase>& reduct_op );
00138 
00140   ~MpiReductionOpSetter();
00141 
00149   MPI_Op mpi_op() const;
00150   
00151 private:
00152   // Not defined and not to be called!
00153   MpiReductionOpSetter();
00154   MpiReductionOpSetter(const MpiReductionOpSetter&);
00155   MpiReductionOpSetter& operator=(const MpiReductionOpSetter&);
00156 };
00157 
00158 // ///////////////////////////////////////
00159 // Template implemenations
00160 
00161 template<typename Ordinal>
00162 MpiReductionOp<Ordinal>::MpiReductionOp(
00163   const RCP<const ValueTypeReductionOp<Ordinal,char> > &reductOp
00164   )
00165   :reductOp_(reductOp)
00166 {}
00167 
00168 template<typename Ordinal>
00169 void MpiReductionOp<Ordinal>::reduce(
00170   void              *invec
00171   ,void             *inoutvec
00172   ,int              *len
00173   ,MPI_Datatype     *datatype
00174   ) const
00175 {
00176   (void)datatype;
00177 #ifdef TEUCHOS_DEBUG
00178   TEST_FOR_EXCEPT(!invec);
00179   TEST_FOR_EXCEPT(!inoutvec);
00180   TEST_FOR_EXCEPT(!len);
00181   TEST_FOR_EXCEPT(!(*len>0));
00182   TEST_FOR_EXCEPT(!datatype);
00183   //TEST_FOR_EXCEPT(!(*datatype==MPI_CHAR));
00184   // We also allow datatypes that are blocks of chars!
00185 #endif
00186   reductOp_->reduce(
00187     *len,reinterpret_cast<char*>(invec),reinterpret_cast<char*>(inoutvec)
00188     );
00189 }
00190 
00191 template<typename Ordinal>
00192 RCP<const MpiReductionOp<Ordinal> >
00193 mpiReductionOp( const RCP<const ValueTypeReductionOp<Ordinal,char> > &reductOp )
00194 {
00195   return rcp(new MpiReductionOp<Ordinal>(reductOp));
00196 }
00197 
00198 } // namespace Teuchos
00199 
00200 #endif // TEUCHOS_MPI_REDUCTION_OP_SETTER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines