PlayaMPIOp.hpp

Go to the documentation of this file.

/* @HEADER@ */
// ************************************************************************
// 
//                 Playa: Programmable Linear Algebra
//                 Copyright 2012 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 Kevin Long (kevin.long@ttu.edu)
// 

/* @HEADER@ */

#ifndef PLAYA_MPI_OP_H
#define PLAYA_MPI_OP_H


#include "PlayaDefs.hpp"
#include "Teuchos_ConfigDefs.hpp"
#include "Teuchos_RCP.hpp"
#include <stack>

#ifdef HAVE_MPI
#include "mpi.h"
#endif


namespace Playa
{
using Teuchos::RCP;
using Teuchos::rcp;

/** */
class MPIOp
{
public:
  /** */
  MPIOp(const std::string& name);

#ifdef HAVE_MPI
  /** */
  MPIOp(const std::string& name, const RCP<MPI_Op>& mpiType);
#endif

  /** */
  const std::string& name() const {return name_;}

#ifdef HAVE_MPI
  MPI_Op* ptr() ;
#endif

#ifdef HAVE_MPI
  const MPI_Op& handle() const ;
#endif


  /** */
  static MPIOp sumOp() ;
  
  /** */
  static MPIOp minOp() ;
  
  /** */
  static MPIOp maxOp() ;
  
  /** */
  static MPIOp minlocOp() ;
  
  /** */
  static MPIOp maxlocOp() ;
  
  /** */
  static MPIOp productOp() ;

  /** */
  static void registerOp(const MPIOp& op);
      
  static std::stack<MPIOp>& opRegistry();

  static void clearOpRegistry();
private:
  std::string name_;
#ifdef HAVE_MPI
  RCP<MPI_Op> mpiOp_;
#endif
};


  
} // namespace Playa

#endif