Thyra_DefaultPreconditioner_decl.hpp

Go to the documentation of this file.

// @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_DECL_HPP
#define THYRA_DEFUALT_PRECONDITIONER_DECL_HPP

#include "Thyra_PreconditionerBase.hpp"
#include "Teuchos_ConstNonconstObjectContainer.hpp"


namespace Thyra {


template <class Scalar>
class DefaultPreconditioner : virtual public PreconditionerBase<Scalar>
{
public:


  DefaultPreconditioner();

  DefaultPreconditioner(
    const Teuchos::RCP<LinearOpBase<Scalar> > &leftPrecOp,
    const Teuchos::RCP<LinearOpBase<Scalar> > &rightPrecOp
    );

  DefaultPreconditioner(
    const Teuchos::RCP<const LinearOpBase<Scalar> > &leftPrecOp,
    const Teuchos::RCP<const LinearOpBase<Scalar> > &rightPrecOp
    );

  DefaultPreconditioner(
    const Teuchos::RCP<LinearOpBase<Scalar> > &unspecifiedPrecOp
    );

  DefaultPreconditioner(
    const Teuchos::RCP<const LinearOpBase<Scalar> > &unspecifiedPrecOp
    );

  void initializeLeft(
    const Teuchos::RCP<LinearOpBase<Scalar> > &leftPrecOp
    );

  void initializeLeft(
    const Teuchos::RCP<const LinearOpBase<Scalar> > &leftPrecOp
    );

  void initializeRight(
    const Teuchos::RCP<LinearOpBase<Scalar> > &rightPrecOp
    );

  void initializeRight(
    const Teuchos::RCP<const LinearOpBase<Scalar> > &rightPrecOp
    );

  void initializeLeftRight(
    const Teuchos::RCP<LinearOpBase<Scalar> > &leftPrecOp
    ,const Teuchos::RCP<LinearOpBase<Scalar> > &rightPrecOp
    );

  void initializeLeftRight(
    const Teuchos::RCP<const LinearOpBase<Scalar> > &leftPrecOp
    ,const Teuchos::RCP<const LinearOpBase<Scalar> > &rightPrecOp
    );

  void initializeUnspecified(
    const Teuchos::RCP<LinearOpBase<Scalar> > &unspecifiedPrecOp
    );

  void initializeUnspecified(
    const Teuchos::RCP<const LinearOpBase<Scalar> > &unspecifiedPrecOp
    );

  void uninitialize();


  std::string description() const;
  void describe(
    Teuchos::FancyOStream &out,
    const Teuchos::EVerbosityLevel verbLevel
    ) const;

  bool isLeftPrecOpConst() const;
  Teuchos::RCP<LinearOpBase<Scalar> > getNonconstLeftPrecOp();
  Teuchos::RCP<const LinearOpBase<Scalar> > getLeftPrecOp() const;
  bool isRightPrecOpConst() const;
  Teuchos::RCP<LinearOpBase<Scalar> > getNonconstRightPrecOp();
  Teuchos::RCP<const LinearOpBase<Scalar> > getRightPrecOp() const;
  bool isUnspecifiedPrecOpConst() const;
  Teuchos::RCP<LinearOpBase<Scalar> > getNonconstUnspecifiedPrecOp();
  Teuchos::RCP<const LinearOpBase<Scalar> > getUnspecifiedPrecOp() const;
  
private:
  
  Teuchos::ConstNonconstObjectContainer<LinearOpBase<Scalar> > leftPrecOp_;
  Teuchos::ConstNonconstObjectContainer<LinearOpBase<Scalar> > rightPrecOp_;
  Teuchos::ConstNonconstObjectContainer<LinearOpBase<Scalar> > unspecifiedPrecOp_;
  
};

// ///////////////////////
// Related functions

template <class Scalar>
Teuchos::RCP<const DefaultPreconditioner<Scalar> >
unspecifiedPrec(
  const Teuchos::RCP<const LinearOpBase<Scalar> > &unspecifiedPrecOp
  )
{
  return Teuchos::rcp(new DefaultPreconditioner<Scalar>(unspecifiedPrecOp));
}

template <class Scalar>
Teuchos::RCP<const DefaultPreconditioner<Scalar> >
leftPrec(
  const Teuchos::RCP<const LinearOpBase<Scalar> > &leftPrecOp
  )
{
  return Teuchos::rcp(new DefaultPreconditioner<Scalar>(leftPrecOp,Teuchos::null));
}

template <class Scalar>
Teuchos::RCP<const DefaultPreconditioner<Scalar> >
rightPrec(
  const Teuchos::RCP<const LinearOpBase<Scalar> > &rightPrecOp
  )
{
  return Teuchos::rcp(new DefaultPreconditioner<Scalar>(Teuchos::null,rightPrecOp));
}

template <class Scalar>
Teuchos::RCP<const DefaultPreconditioner<Scalar> >
splitPrec(
  const Teuchos::RCP<const LinearOpBase<Scalar> > &leftPrecOp
  ,const Teuchos::RCP<const LinearOpBase<Scalar> > &rightPrecOp
  )
{
  return Teuchos::rcp(new DefaultPreconditioner<Scalar>(leftPrecOp,rightPrecOp));
}


} // namespace Thyra


#endif // THYRA_DEFUALT_PRECONDITIONER_DECL_HPP