Teko_TpetraHelpers.hpp

/*
// @HEADER
//
// ***********************************************************************
//
//      Teko: A package for block and physics based preconditioning
//                  Copyright 2010 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 Eric C. Cyr (eccyr@sandia.gov)
//
// ***********************************************************************
//
// @HEADER

*/

#ifndef __Teko_TpetraHelpers_hpp__
#define __Teko_TpetraHelpers_hpp__

// stl includes
#include <string>

#include "Teko_ConfigDefs.hpp"

#ifdef TEKO_HAVE_EPETRA
// Epetra includes
#include "Epetra_Operator.h"
#include "Epetra_CrsMatrix.h"
#include "Epetra_MultiVector.h"
#endif

// Teuchos includes
#include "Teuchos_RCP.hpp"

// Thyra includes
#include "Thyra_VectorBase.hpp"
#include "Thyra_TpetraMultiVector.hpp"
#include "Thyra_DefaultSpmdMultiVector.hpp"

// Tpetra
#include "Tpetra_Map.hpp"
#include "Tpetra_Vector.hpp"
#include "Tpetra_CrsMatrix.hpp"

namespace Teko {

typedef Teuchos::RCP<const Thyra::LinearOpBase<double> > LinearOp;

namespace TpetraHelpers {

void fillDefaultSpmdMultiVector(Teuchos::RCP<Thyra::TpetraMultiVector<ST, LO, GO, NT> >& spmdMV,
                                Teuchos::RCP<Tpetra::MultiVector<ST, LO, GO, NT> >& tpetraMV);

const Teuchos::RCP<const Thyra::LinearOpBase<ST> > thyraDiagOp(
    const Teuchos::RCP<const Tpetra::Vector<ST, LO, GO, NT> >& tv,
    const Tpetra::Map<LO, GO, NT>& map, const std::string& lbl = "ANYM");

const Teuchos::RCP<Thyra::LinearOpBase<ST> > thyraDiagOp(
    const Teuchos::RCP<Tpetra::Vector<ST, LO, GO, NT> >& tv, const Tpetra::Map<LO, GO, NT>& map,
    const std::string& lbl = "ANYM");

void identityRowIndices(const Tpetra::Map<LO, GO, NT>& rowMap,
                        const Tpetra::CrsMatrix<ST, LO, GO, NT>& mat, std::vector<GO>& outIndices);

void zeroMultiVectorRowIndices(Tpetra::MultiVector<ST, LO, GO, NT>& mv,
                               const std::vector<GO>& zeroIndices);

bool isTpetraLinearOp(const Teko::LinearOp& op);

Teuchos::RCP<const Tpetra::CrsMatrix<ST, LO, GO, NT> > getTpetraCrsMatrix(const Teko::LinearOp& op,
                                                                          ST* scalar, bool* transp);

#ifdef TEKO_HAVE_EPETRA

Teuchos::RCP<const Tpetra::CrsMatrix<ST, LO, GO, NT> > epetraCrsMatrixToTpetra(
    const Teuchos::RCP<const Epetra_CrsMatrix> A_e,
    const Teuchos::RCP<const Teuchos::Comm<int> > comm);

Teuchos::RCP<Tpetra::CrsMatrix<ST, LO, GO, NT> > nonConstEpetraCrsMatrixToTpetra(
    const Teuchos::RCP<Epetra_CrsMatrix> A_e, const Teuchos::RCP<const Teuchos::Comm<int> > comm);

Teuchos::RCP<const Tpetra::Map<LO, GO, NT> > epetraMapToTpetra(
    const Epetra_Map eMap, const Teuchos::RCP<const Teuchos::Comm<int> > comm);
#endif  // TEKO_HAVE_EPETRA

class ZeroedOperator : public Tpetra::Operator<ST, LO, GO, NT> {
 public:
  ZeroedOperator(const std::vector<GO>& zeroIndices,
                 const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> >& op);



  virtual ~ZeroedOperator() {}

  int SetUseTranspose(bool /* useTranspose */) { return -1; }

  void apply(const Tpetra::MultiVector<ST, LO, GO, NT>& X, Tpetra::MultiVector<ST, LO, GO, NT>& Y,
             Teuchos::ETransp mode = Teuchos::NO_TRANS, ST alpha = Teuchos::ScalarTraits<ST>::one(),
             ST beta = Teuchos::ScalarTraits<ST>::zero()) const;

  void applyInverse(const Tpetra::MultiVector<ST, LO, GO, NT>& /* X */,
                    Tpetra::MultiVector<ST, LO, GO, NT>& /* Y */,
                    Teuchos::ETransp /* mode */ = Teuchos::NO_TRANS,
                    ST /* alpha */              = Teuchos::ScalarTraits<ST>::one(),
                    ST /* beta */               = Teuchos::ScalarTraits<ST>::zero()) const {
    TEUCHOS_TEST_FOR_EXCEPTION(true, std::runtime_error,
                               "Can't call applyInverse on a ZeroedOperator");
  }

  double NormInf() const { return -1.0; }

  bool UseTranspose() const { return false; }

  bool HasNormInf() const { return false; }

  Teuchos::RCP<const Tpetra::Map<LO, GO, NT> > getDomainMap() const {
    return tpetraOp_->getDomainMap();
  }

  Teuchos::RCP<const Tpetra::Map<LO, GO, NT> > getRangeMap() const {
    return tpetraOp_->getRangeMap();
  }


 protected:
  std::vector<GO> zeroIndices_;
  const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> > tpetraOp_;
};

}  // end namespace TpetraHelpers
}  // end namespace Teko

#endif