Teko_TpetraHelpers.hpp

// @HEADER
// *****************************************************************************
//      Teko: A package for block and physics based preconditioning
//
// Copyright 2010 NTESS and the Teko contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef __Teko_TpetraHelpers_hpp__
#define __Teko_TpetraHelpers_hpp__
 
// stl includes
#include <string>
 
#include "Teko_ConfigDefs.hpp"
 
// Teuchos includes
#include "Teuchos_RCP.hpp"
 
// Thyra includes
#include "Thyra_LinearOpBase.hpp"
#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<ST> > LinearOp;
typedef Teuchos::RCP<Thyra::LinearOpBase<ST> > ModifiableLinearOp;
 
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);
 
Teuchos::RCP<Tpetra::CrsMatrix<ST, LO, GO, NT> > materializeTpetraCrsMatrix(
    const Teko::LinearOp& op);
 
Teko::ModifiableLinearOp materializeTpetraLinearOp(const Teko::LinearOp& op,
                                                   const Teko::ModifiableLinearOp& destOp);
 
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