Teko_EpetraOperatorWrapper.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_EpetraOperatorWrapper_hpp__
#define __Teko_EpetraOperatorWrapper_hpp__

#include "Thyra_LinearOpBase.hpp"
#include "Epetra_Map.h"
#include "Epetra_Comm.h"
#include "Epetra_MultiVector.h"
#include "Epetra_Operator.h"

#include <string>

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

class EpetraOperatorWrapper;

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

  virtual void copyEpetraIntoThyra(
      const Epetra_MultiVector& epetraX,
      const Teuchos::Ptr<Thyra::MultiVectorBase<double> >& thyraX) const = 0;
  // const EpetraOperatorWrapper & eow) const = 0;

  virtual void copyThyraIntoEpetra(const RCP<const Thyra::MultiVectorBase<double> >& thyraX,
                                   Epetra_MultiVector& epetraX) const = 0;
  // const EpetraOperatorWrapper & eow) const = 0;

  virtual const RCP<const Epetra_Map> domainMap() const = 0;

  virtual const RCP<const Epetra_Map> 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 copyEpetraIntoThyra(
      const Epetra_MultiVector& epetraX,
      const Teuchos::Ptr<Thyra::MultiVectorBase<double> >& thyraX) const
  // const EpetraOperatorWrapper & eow) const
  {
    forwardStrategy_->copyEpetraIntoThyra(epetraX, thyraX);
  }

  virtual void copyThyraIntoEpetra(const RCP<const Thyra::MultiVectorBase<double> >& thyraX,
                                   Epetra_MultiVector& epetraX) const
  // const EpetraOperatorWrapper & eow) const
  {
    forwardStrategy_->copyThyraIntoEpetra(thyraX, epetraX);
  }

  virtual const RCP<const Epetra_Map> domainMap() const { return forwardStrategy_->rangeMap(); }

  virtual const RCP<const Epetra_Map> 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<double> >& thyraOp,
                         const Epetra_Comm& comm);

  virtual ~DefaultMappingStrategy() {}

  virtual void copyEpetraIntoThyra(
      const Epetra_MultiVector& epetraX,
      const Teuchos::Ptr<Thyra::MultiVectorBase<double> >& thyraX) const;
  // const EpetraOperatorWrapper & eow) const;

  virtual void copyThyraIntoEpetra(const RCP<const Thyra::MultiVectorBase<double> >& thyraX,
                                   Epetra_MultiVector& epetraX) const;
  // const EpetraOperatorWrapper & eow) const;

  virtual const RCP<const Epetra_Map> domainMap() const { return domainMap_; }

  virtual const RCP<const Epetra_Map> rangeMap() const { return rangeMap_; }

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

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

  RCP<const Epetra_Map> domainMap_;  
  RCP<const Epetra_Map> rangeMap_;   
};

class EpetraOperatorWrapper : public Epetra_Operator {
 public:
  EpetraOperatorWrapper(const RCP<const Thyra::LinearOpBase<double> >& thyraOp);
  EpetraOperatorWrapper(const RCP<const Thyra::LinearOpBase<double> >& thyraOp,
                        const RCP<const MappingStrategy>& mapStrategy);
  EpetraOperatorWrapper(const RCP<const MappingStrategy>& mapStrategy);

  virtual ~EpetraOperatorWrapper() { ; }

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

  int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;

  int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;

  double NormInf() const;

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

  bool UseTranspose() const { return useTranspose_; }

  bool HasNormInf() const { return false; }

  const Epetra_Comm& Comm() const { return *comm_; }

  const Epetra_Map& OperatorDomainMap() const { return *mapStrategy_->domainMap(); }

  const Epetra_Map& OperatorRangeMap() const { return *mapStrategy_->rangeMap(); }

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

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

  virtual int GetBlockRowCount();

  virtual int GetBlockColCount();

  Teuchos::RCP<const Epetra_Operator> GetBlock(int i, int j) const;

 protected:
  EpetraOperatorWrapper();

  RCP<const Epetra_Comm> getEpetraComm(const Thyra::LinearOpBase<double>& inOp) const;

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

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

  RCP<const MappingStrategy> mapStrategy_;

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

  bool useTranspose_;

  RCP<const Epetra_Comm> comm_;

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

#endif