Thyra_DefaultPreconditioner.hpp

// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_DEFUALT_PRECONDITIONER_HPP
#define THYRA_DEFUALT_PRECONDITIONER_HPP

#include "Thyra_DefaultPreconditionerDecl.hpp"

namespace Thyra {

// Constructors/initializers/accessors

template <class RangeScalar, class DomainScalar>
DefaultPreconditioner<RangeScalar,DomainScalar>::DefaultPreconditioner()
{}

template <class RangeScalar, class DomainScalar>
DefaultPreconditioner<RangeScalar,DomainScalar>::DefaultPreconditioner(
  const Teuchos::RCP<LinearOpBase<RangeScalar,DomainScalar> >    &leftPrecOp
  ,const Teuchos::RCP<LinearOpBase<RangeScalar,DomainScalar> >   &rightPrecOp
  )
{
#ifdef TEUCHOS_DEBUG
  TEST_FOR_EXCEPT( leftPrecOp.get()==NULL && rightPrecOp.get()==NULL ); 
#endif
  if(leftPrecOp.get()) leftPrecOp_.initialize(leftPrecOp);
  if(rightPrecOp.get()) rightPrecOp_.initialize(rightPrecOp);
}

template <class RangeScalar, class DomainScalar>
DefaultPreconditioner<RangeScalar,DomainScalar>::DefaultPreconditioner(
  const Teuchos::RCP<const LinearOpBase<RangeScalar,DomainScalar> >    &leftPrecOp
  ,const Teuchos::RCP<const LinearOpBase<RangeScalar,DomainScalar> >   &rightPrecOp
  )
{
#ifdef TEUCHOS_DEBUG
  TEST_FOR_EXCEPT( leftPrecOp.get()==NULL && rightPrecOp.get()==NULL ); 
#endif
  if(leftPrecOp.get())
    leftPrecOp_.initialize(leftPrecOp);
  if(rightPrecOp.get())
    rightPrecOp_.initialize(rightPrecOp);
}

template <class RangeScalar, class DomainScalar>
DefaultPreconditioner<RangeScalar,DomainScalar>::DefaultPreconditioner(
  const Teuchos::RCP<LinearOpBase<RangeScalar,DomainScalar> >    &unspecifiedPrecOp
  )
{
  unspecifiedPrecOp_.initialize(unspecifiedPrecOp);
}

template <class RangeScalar, class DomainScalar>
DefaultPreconditioner<RangeScalar,DomainScalar>::DefaultPreconditioner(
  const Teuchos::RCP<const LinearOpBase<RangeScalar,DomainScalar> >    &unspecifiedPrecOp
  )
{
  unspecifiedPrecOp_.initialize(unspecifiedPrecOp);
}

template <class RangeScalar, class DomainScalar>
void DefaultPreconditioner<RangeScalar,DomainScalar>::initializeLeft(
  const Teuchos::RCP<LinearOpBase<RangeScalar,DomainScalar> >    &leftPrecOp
  )
{
  uninitialize();
  leftPrecOp_.initialize(leftPrecOp);
}

template <class RangeScalar, class DomainScalar>
void DefaultPreconditioner<RangeScalar,DomainScalar>::initializeLeft(
  const Teuchos::RCP<const LinearOpBase<RangeScalar,DomainScalar> >    &leftPrecOp
  )
{
  uninitialize();
  leftPrecOp_.initialize(leftPrecOp);
}

template <class RangeScalar, class DomainScalar>
void DefaultPreconditioner<RangeScalar,DomainScalar>::initializeRight(
  const Teuchos::RCP<LinearOpBase<RangeScalar,DomainScalar> >    &rightPrecOp
  )
{
  uninitialize();
  rightPrecOp_.initialize(rightPrecOp);
}

template <class RangeScalar, class DomainScalar>
void DefaultPreconditioner<RangeScalar,DomainScalar>::initializeRight(
  const Teuchos::RCP<const LinearOpBase<RangeScalar,DomainScalar> >    &rightPrecOp
  )
{
  uninitialize();
  rightPrecOp_.initialize(rightPrecOp);
}

template <class RangeScalar, class DomainScalar>
void DefaultPreconditioner<RangeScalar,DomainScalar>::initializeLeftRight(
  const Teuchos::RCP<LinearOpBase<RangeScalar,DomainScalar> >    &leftPrecOp
  ,const Teuchos::RCP<LinearOpBase<RangeScalar,DomainScalar> >   &rightPrecOp
  )
{
  uninitialize();
  rightPrecOp_.initialize(rightPrecOp);
  leftPrecOp_.initialize(leftPrecOp);
}

template <class RangeScalar, class DomainScalar>
void DefaultPreconditioner<RangeScalar,DomainScalar>::initializeLeftRight(
  const Teuchos::RCP<const LinearOpBase<RangeScalar,DomainScalar> >    &leftPrecOp
  ,const Teuchos::RCP<const LinearOpBase<RangeScalar,DomainScalar> >   &rightPrecOp
  )
{
  uninitialize();
  rightPrecOp_.initialize(rightPrecOp);
  leftPrecOp_.initialize(leftPrecOp);
}

template <class RangeScalar, class DomainScalar>
void DefaultPreconditioner<RangeScalar,DomainScalar>::initializeUnspecified(
  const Teuchos::RCP<LinearOpBase<RangeScalar,DomainScalar> >    &unspecifiedPrecOp
  )
{
  uninitialize();
  unspecifiedPrecOp_.initialize(unspecifiedPrecOp);
}

template <class RangeScalar, class DomainScalar>
void DefaultPreconditioner<RangeScalar,DomainScalar>::initializeUnspecified(
  const Teuchos::RCP<const LinearOpBase<RangeScalar,DomainScalar> >    &unspecifiedPrecOp
  )
{
  uninitialize();
  unspecifiedPrecOp_.initialize(unspecifiedPrecOp);
}

template <class RangeScalar, class DomainScalar>
void DefaultPreconditioner<RangeScalar,DomainScalar>::uninitialize()
{
  leftPrecOp_.uninitialize();
  rightPrecOp_.uninitialize();
  unspecifiedPrecOp_.uninitialize();
}

// Overridden from PreconditionerBase

template <class RangeScalar, class DomainScalar>
bool DefaultPreconditioner<RangeScalar,DomainScalar>::isLeftPrecOpConst() const
{
  return leftPrecOp_.isConst();
}

template <class RangeScalar, class DomainScalar>
Teuchos::RCP<LinearOpBase<RangeScalar,DomainScalar> >
DefaultPreconditioner<RangeScalar,DomainScalar>::getNonconstLeftPrecOp()
{
  return leftPrecOp_.getNonconstObj();
}

template <class RangeScalar, class DomainScalar>
Teuchos::RCP<const LinearOpBase<RangeScalar,DomainScalar> >
DefaultPreconditioner<RangeScalar,DomainScalar>::getLeftPrecOp() const
{
  return leftPrecOp_.getConstObj();
}

template <class RangeScalar, class DomainScalar>
bool DefaultPreconditioner<RangeScalar,DomainScalar>::isRightPrecOpConst() const
{
  return rightPrecOp_.isConst();
}

template <class RangeScalar, class DomainScalar>
Teuchos::RCP<LinearOpBase<RangeScalar,DomainScalar> >
DefaultPreconditioner<RangeScalar,DomainScalar>::getNonconstRightPrecOp()
{
  return rightPrecOp_.getNonconstObj();
}

template <class RangeScalar, class DomainScalar>
Teuchos::RCP<const LinearOpBase<RangeScalar,DomainScalar> >
DefaultPreconditioner<RangeScalar,DomainScalar>::getRightPrecOp() const
{
  return rightPrecOp_.getConstObj();
}

template <class RangeScalar, class DomainScalar>
bool DefaultPreconditioner<RangeScalar,DomainScalar>::isUnspecifiedPrecOpConst() const
{
  return unspecifiedPrecOp_.isConst();
}

template <class RangeScalar, class DomainScalar>
Teuchos::RCP<LinearOpBase<RangeScalar,DomainScalar> >
DefaultPreconditioner<RangeScalar,DomainScalar>::getNonconstUnspecifiedPrecOp()
{
  return unspecifiedPrecOp_.getNonconstObj();
}

template <class RangeScalar, class DomainScalar>
Teuchos::RCP<const LinearOpBase<RangeScalar,DomainScalar> >
DefaultPreconditioner<RangeScalar,DomainScalar>::getUnspecifiedPrecOp() const
{
  return unspecifiedPrecOp_.getConstObj();
}


// Overridden from Teuchos::Describable

                                                
template <class RangeScalar, class DomainScalar>
std::string DefaultPreconditioner<RangeScalar,DomainScalar>::description() const
{
  std::ostringstream oss;
  oss << Teuchos::Describable::description() << "{";
  bool wroteOne = false;
  if(!is_null(leftPrecOp_.getConstObj())) {
    if(wroteOne) oss << ",";
    oss << "leftPrecOp=" << leftPrecOp_.getConstObj()->description();
    wroteOne = true;
  }
  if(!is_null(rightPrecOp_.getConstObj())) {
    if(wroteOne) oss << ",";
    oss << "rightPrecOp=" << rightPrecOp_.getConstObj()->description();
    wroteOne = true;
  }
  if(!is_null(unspecifiedPrecOp_.getConstObj())) {
    if(wroteOne) oss << ",";
    oss << "unspecifiedPrecOp=" << unspecifiedPrecOp_.getConstObj()->description();
    wroteOne = true;
  }
  oss << "}";
  return oss.str();
}

template <class RangeScalar, class DomainScalar>
void DefaultPreconditioner<RangeScalar,DomainScalar>::describe(
  Teuchos::FancyOStream                &out
  ,const Teuchos::EVerbosityLevel      verbLevel
  ) const
{
  using Teuchos::FancyOStream;
  using Teuchos::OSTab;
  using Teuchos::describe;
  OSTab tab(out);
  switch(verbLevel) {
    case Teuchos::VERB_DEFAULT:
    case Teuchos::VERB_LOW:
      out << Teuchos::Describable::description() << std::endl;
      break;
    case Teuchos::VERB_MEDIUM:
    case Teuchos::VERB_HIGH:
    case Teuchos::VERB_EXTREME:
    {
      out
        << Teuchos::typeName(*this) << "\n";
      OSTab tab(out);
      if(!is_null(leftPrecOp_.getConstObj()))
        out << "leftPrecOp=" << describe(*leftPrecOp_.getConstObj(),verbLevel);
      if(!is_null(rightPrecOp_.getConstObj()))
        out << "rig htPrecOp=" << describe(*rightPrecOp_.getConstObj(),verbLevel);
      if(!is_null(unspecifiedPrecOp_.getConstObj()))
        out << "unspecifiedPrecOp=" << describe(*unspecifiedPrecOp_.getConstObj(),verbLevel);
      break;
    }
    default:
      TEST_FOR_EXCEPT(true); // Should never get here!
  }
}


} // namespace Thyra

#endif // THYRA_DEFUALT_PRECONDITIONER_HPP

---