Thyra_PreconditionerFactoryBase.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_PRECONDITIONER_FACTORY_BASE_DECL_HPP
#define THYRA_PRECONDITIONER_FACTORY_BASE_DECL_HPP

#include "Thyra_SolveSupportTypes.hpp"
#include "Thyra_LinearOpSourceBase.hpp"
#include "Thyra_PreconditionerBase.hpp"
#include "Teuchos_Describable.hpp"
#include "Teuchos_ParameterListAcceptor.hpp"
#include "Teuchos_VerboseObject.hpp"

namespace Thyra {

template <class RangeScalar, class DomainScalar = RangeScalar>
class PreconditionerFactoryBase
  : virtual public Teuchos::Describable
  , virtual public Teuchos::ParameterListAcceptor
  , virtual public Teuchos::VerboseObject<PreconditionerFactoryBase<RangeScalar,DomainScalar> >
{
public:


  virtual bool isCompatible( const LinearOpSourceBase<RangeScalar,DomainScalar> &fwdOpSrc ) const = 0;

  virtual Teuchos::RCP<PreconditionerBase<DomainScalar,RangeScalar> > createPrec() const = 0;

  virtual void initializePrec(
    const Teuchos::RCP<const LinearOpSourceBase<RangeScalar,DomainScalar> >   &fwdOpSrc
    ,PreconditionerBase<DomainScalar,RangeScalar>                                     *precOp
    ,const ESupportSolveUse                                                           supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
    ) const = 0;

  virtual void uninitializePrec(
    PreconditionerBase<DomainScalar,RangeScalar>                                *prec
    ,Teuchos::RCP<const LinearOpSourceBase<RangeScalar,DomainScalar> >  *fwdOpSrc        = NULL
    ,ESupportSolveUse                                                           *supportSolveUse = NULL
    ) const = 0;
  


  virtual bool applySupportsConj(EConj conj) const;

  virtual bool applyTransposeSupportsConj(EConj conj) const;


};

// ////////////////////////////////////
// Nonmember helper functions


// /////////////////////////////////////
// Implementations

template <class RangeScalar, class DomainScalar>
bool PreconditionerFactoryBase<RangeScalar,DomainScalar>::applySupportsConj(EConj conj) const
{
  return true;
}

template <class RangeScalar, class DomainScalar>
bool PreconditionerFactoryBase<RangeScalar,DomainScalar>::applyTransposeSupportsConj(EConj conj) const
{
  return false;
}

} // namespace Thyra

#endif // THYRA_PRECONDITIONER_FACTORY_BASE_DECL_HPP

---