Teko_PreconditionerLinearOp.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_PreconditionerLinearOp_hpp__
#define __Teko_PreconditionerLinearOp_hpp__

#include "Teko_PreconditionerLinearOpDecl.hpp"

#include "Thyra_LinearOpBase.hpp"
#include "Thyra_PreconditionerBase.hpp"

namespace Teko {

template <typename ScalarT>
PreconditionerLinearOp<ScalarT>::PreconditionerLinearOp() {}

template <typename ScalarT>
PreconditionerLinearOp<ScalarT>::PreconditionerLinearOp(
    const Teuchos::RCP<Thyra::PreconditionerBase<ScalarT> >& prec) {
  preconditioner_.initialize(prec);
}

template <typename ScalarT>
PreconditionerLinearOp<ScalarT>::PreconditionerLinearOp(
    const Teuchos::RCP<const Thyra::PreconditionerBase<ScalarT> >& prec) {
  preconditioner_.initialize(prec);
}

template <typename ScalarT>
void PreconditionerLinearOp<ScalarT>::initialize(
    const Teuchos::RCP<Thyra::PreconditionerBase<ScalarT> >& prec) {
  uninitialize();
  preconditioner_.initialize(prec);
}

template <typename ScalarT>
void PreconditionerLinearOp<ScalarT>::initialize(
    const Teuchos::RCP<const Thyra::PreconditionerBase<ScalarT> >& prec) {
  uninitialize();
  preconditioner_.initialize(prec);
}

template <typename ScalarT>
void PreconditionerLinearOp<ScalarT>::uninitialize() {
  preconditioner_.uninitialize();
}

template <typename ScalarT>
Teuchos::RCP<const Thyra::VectorSpaceBase<ScalarT> > PreconditionerLinearOp<ScalarT>::range()
    const {
  return getOperator_cnoc()->range();
}

template <typename ScalarT>
Teuchos::RCP<const Thyra::VectorSpaceBase<ScalarT> > PreconditionerLinearOp<ScalarT>::domain()
    const {
  return getOperator_cnoc()->domain();
}

template <typename ScalarT>
bool PreconditionerLinearOp<ScalarT>::opSupportedImpl(const Thyra::EOpTransp M_trans) const {
  return getOperator_cnoc()->opSupported(M_trans);
}

template <typename ScalarT>
void PreconditionerLinearOp<ScalarT>::applyImpl(
    const Thyra::EOpTransp M_trans, const Thyra::MultiVectorBase<ScalarT>& x,
    const Teuchos::Ptr<Thyra::MultiVectorBase<ScalarT> >& y, const ScalarT alpha,
    const ScalarT beta) const {
  getOperator_cnoc()->apply(M_trans, x, y, alpha, beta);
}

template <typename ScalarT>
Teuchos::RCP<Thyra::PreconditionerBase<ScalarT> >
PreconditionerLinearOp<ScalarT>::getNonconstPreconditioner() {
  return preconditioner_.getNonconstObj();
}

template <typename ScalarT>
Teuchos::RCP<const Thyra::PreconditionerBase<ScalarT> >
PreconditionerLinearOp<ScalarT>::getPreconditioner() const {
  return preconditioner_.getConstObj();
}

template <typename ScalarT>
Teuchos::ConstNonconstObjectContainer<Thyra::LinearOpBase<ScalarT> >
PreconditionerLinearOp<ScalarT>::getOperator_cnoc() const {
  Teuchos::ConstNonconstObjectContainer<Thyra::LinearOpBase<ScalarT> > oper;
  oper.initialize(preconditioner_.getConstObj()->getUnspecifiedPrecOp());

  return oper;
}

template <typename ScalarT>
Teuchos::ConstNonconstObjectContainer<Thyra::LinearOpBase<ScalarT> >
PreconditionerLinearOp<ScalarT>::getOperator_cnoc() {
  Teuchos::ConstNonconstObjectContainer<Thyra::LinearOpBase<ScalarT> > oper;
  oper.initialize(preconditioner_.getNonconstObj()->getNonconstUnspecifiedPrecOp());

  return oper;
}

template <typename ScalarT>
void PreconditionerLinearOp<ScalarT>::describe(Teuchos::FancyOStream& out_arg,
                                               const Teuchos::EVerbosityLevel verbLevel) const {
  using Teuchos::OSTab;

  Teuchos::RCP<Teuchos::FancyOStream> out = rcp(&out_arg, false);
  OSTab tab0(out);
  switch (verbLevel) {
    case Teuchos::VERB_DEFAULT:
    case Teuchos::VERB_LOW:
      *out << this->description() << " ( [Operator] = " << getOperator_cnoc()->description() << " )"
           << std::endl;
      break;
    case Teuchos::VERB_MEDIUM:
    case Teuchos::VERB_HIGH:
    case Teuchos::VERB_EXTREME: {
      *out << Teuchos::Describable::description() << "{"
           << "rangeDim=" << this->range()->dim() << ",domainDim=" << this->domain()->dim()
           << "}\n";
      {
        OSTab tab1(out);
        *out << "[Operator] = ";
        *out << Teuchos::describe(*getOperator_cnoc(), verbLevel);
      }
      break;
    }
    default: TEUCHOS_TEST_FOR_EXCEPT(true);  // Should never get here!
  }
}

inline Teko::LinearOp extractOperatorFromPrecOp(const Teko::LinearOp& lo) {
  Teuchos::RCP<const Teko::PreconditionerLinearOp<double> > plo =
      Teuchos::rcp_dynamic_cast<const Teko::PreconditionerLinearOp<double> >(lo);
  if (plo != Teuchos::null)
    return plo->getOperator();
  else
    return lo;
}

}  // end namespace Teko

#endif