Teko_TpetraOperatorWrapper.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_TpetraOperatorWrapper_hpp__
#define __Teko_TpetraOperatorWrapper_hpp__

#include "Thyra_LinearOpBase.hpp"
#include "Tpetra_Map.hpp"
#include "Tpetra_MultiVector.hpp"
#include "Tpetra_Operator.hpp"
#include "Teko_ConfigDefs.hpp"

#include <string>

namespace Teko {
namespace TpetraHelpers {
using Teuchos::RCP;

class TpetraOperatorWrapper;

class MappingStrategy {
 public:
  virtual ~MappingStrategy() {}

  virtual void copyTpetraIntoThyra(
      const Tpetra::MultiVector<ST, LO, GO, NT>& tpetraX,
      const Teuchos::Ptr<Thyra::MultiVectorBase<ST> >& thyraX) const = 0;
  // const TpetraOperatorWrapper & eow) const = 0;

  virtual void copyThyraIntoTpetra(const RCP<const Thyra::MultiVectorBase<ST> >& thyraX,
                                   Tpetra::MultiVector<ST, LO, GO, NT>& tpetraX) const = 0;
  // const TpetraOperatorWrapper & eow) const = 0;

  virtual const RCP<const Tpetra::Map<LO, GO, NT> > domainMap() const = 0;

  virtual const RCP<const Tpetra::Map<LO, GO, NT> > rangeMap() const = 0;

  virtual std::string toString() const = 0;
};

class InverseMappingStrategy : public MappingStrategy {
 public:
  InverseMappingStrategy(const RCP<const MappingStrategy>& forward) : forwardStrategy_(forward) {}

  virtual ~InverseMappingStrategy() {}

  virtual void copyTpetraIntoThyra(const Tpetra::MultiVector<ST, LO, GO, NT>& tpetraX,
                                   const Teuchos::Ptr<Thyra::MultiVectorBase<ST> >& thyraX) const
  // const TpetraOperatorWrapper & eow) const
  {
    forwardStrategy_->copyTpetraIntoThyra(tpetraX, thyraX);
  }

  virtual void copyThyraIntoTpetra(const RCP<const Thyra::MultiVectorBase<ST> >& thyraX,
                                   Tpetra::MultiVector<ST, LO, GO, NT>& tpetraX) const
  // const TpetraOperatorWrapper & eow) const
  {
    forwardStrategy_->copyThyraIntoTpetra(thyraX, tpetraX);
  }

  virtual const RCP<const Tpetra::Map<LO, GO, NT> > domainMap() const {
    return forwardStrategy_->rangeMap();
  }

  virtual const RCP<const Tpetra::Map<LO, GO, NT> > rangeMap() const {
    return forwardStrategy_->domainMap();
  }

  virtual std::string toString() const {
    return std::string("InverseMapping(") + forwardStrategy_->toString() + std::string(")");
  }

 protected:
  const RCP<const MappingStrategy> forwardStrategy_;

 private:
  InverseMappingStrategy();
  InverseMappingStrategy(const InverseMappingStrategy&);
};

class DefaultMappingStrategy : public MappingStrategy {
 public:
  DefaultMappingStrategy(const RCP<const Thyra::LinearOpBase<ST> >& thyraOp,
                         const Teuchos::Comm<Thyra::Ordinal>& comm);

  virtual ~DefaultMappingStrategy() {}

  virtual void copyTpetraIntoThyra(const Tpetra::MultiVector<ST, LO, GO, NT>& tpetraX,
                                   const Teuchos::Ptr<Thyra::MultiVectorBase<ST> >& thyraX) const;
  // const TpetraOperatorWrapper & eow) const;

  virtual void copyThyraIntoTpetra(const RCP<const Thyra::MultiVectorBase<ST> >& thyraX,
                                   Tpetra::MultiVector<ST, LO, GO, NT>& tpetraX) const;
  // const TpetraOperatorWrapper & eow) const;

  virtual const RCP<const Tpetra::Map<LO, GO, NT> > domainMap() const { return domainMap_; }

  virtual const RCP<const Tpetra::Map<LO, GO, NT> > rangeMap() const { return rangeMap_; }

  virtual std::string toString() const { return std::string("DefaultMappingStrategy"); }

 protected:
  RCP<const Thyra::VectorSpaceBase<ST> > domainSpace_;  
  RCP<const Thyra::VectorSpaceBase<ST> > rangeSpace_;   

  RCP<const Tpetra::Map<LO, GO, NT> > domainMap_;  
  RCP<const Tpetra::Map<LO, GO, NT> > rangeMap_;   
};

class TpetraOperatorWrapper : public Tpetra::Operator<ST, LO, GO, NT> {
 public:
  TpetraOperatorWrapper(const RCP<const Thyra::LinearOpBase<ST> >& thyraOp);
  TpetraOperatorWrapper(const RCP<const Thyra::LinearOpBase<ST> >& thyraOp,
                        const RCP<const MappingStrategy>& mapStrategy);
  TpetraOperatorWrapper(const RCP<const MappingStrategy>& mapStrategy);

  virtual ~TpetraOperatorWrapper() { ; }

  int SetUseTranspose(bool useTranspose) {
    useTranspose_ = useTranspose;
    return 0;
  }

  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;

  double NormInf() const;

  const char* Label() const { return label_.c_str(); }

  bool UseTranspose() const { return useTranspose_; }

  bool HasNormInf() const { return false; }

  const Teuchos::RCP<const Teuchos::Comm<Thyra::Ordinal> >& Comm() const { return comm_; }

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

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

  const RCP<const Thyra::LinearOpBase<ST> > getThyraOp() const { return thyraOp_; }

  const RCP<const MappingStrategy> getMapStrategy() const { return mapStrategy_; }

  virtual int GetBlockRowCount();

  virtual int GetBlockColCount();

  Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> > GetBlock(int i, int j) const;

 protected:
  TpetraOperatorWrapper();

  RCP<const Teuchos::Comm<Thyra::Ordinal> > getThyraComm(const Thyra::LinearOpBase<ST>& inOp) const;

  void SetOperator(const RCP<const Thyra::LinearOpBase<ST> >& thyraOp, bool buildMap = true);

  void SetMapStrategy(const RCP<const MappingStrategy>& mapStrategy) { mapStrategy_ = mapStrategy; }

  RCP<const MappingStrategy> mapStrategy_;

  RCP<const Thyra::LinearOpBase<ST> > thyraOp_;

  bool useTranspose_;

  RCP<const Teuchos::Comm<Thyra::Ordinal> > comm_;

  std::string label_;
};
}  // namespace TpetraHelpers
}  // end namespace Teko

#endif