Thyra_LinearOpWithSolveFactoryBase.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_LINEAR_OP_WITH_SOLVE_FACTORY_BASE_DECL_HPP
#define THYRA_LINEAR_OP_WITH_SOLVE_FACTORY_BASE_DECL_HPP

#include "Thyra_LinearOpWithSolveBaseDecl.hpp"
#include "Thyra_PreconditionerFactoryBase.hpp"
#include "Teuchos_ParameterListAcceptor.hpp"
#include "Teuchos_VerboseObject.hpp"

namespace Thyra {

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


  virtual bool acceptsPreconditionerFactory() const;

  virtual void setPreconditionerFactory(
    const Teuchos::RCP<PreconditionerFactoryBase<RangeScalar,DomainScalar> >  &precFactory
    ,const std::string                                                                &precFactoryName
    );

  virtual Teuchos::RCP<PreconditionerFactoryBase<RangeScalar,DomainScalar> > getPreconditionerFactory() const;

  virtual void unsetPreconditionerFactory(
    Teuchos::RCP<PreconditionerFactoryBase<RangeScalar,DomainScalar> >  *precFactory      = NULL
    ,std::string                                                                *precFactoryName  = NULL
    );



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

  virtual Teuchos::RCP<LinearOpWithSolveBase<RangeScalar,DomainScalar> > createOp() const = 0;

  virtual void initializeOp(
    const Teuchos::RCP<const LinearOpSourceBase<RangeScalar,DomainScalar> >    &fwdOpSrc
    ,LinearOpWithSolveBase<RangeScalar,DomainScalar>                                   *Op
    ,const ESupportSolveUse                                                            supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
    ) const = 0;

  virtual void initializeAndReuseOp(
    const Teuchos::RCP<const LinearOpSourceBase<RangeScalar,DomainScalar> >    &fwdOpSrc
    ,LinearOpWithSolveBase<RangeScalar,DomainScalar>                                   *Op
    ) const;

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


  virtual bool supportsPreconditionerInputType(const EPreconditionerInputType precOpType) const;

  virtual void initializePreconditionedOp(
    const Teuchos::RCP<const LinearOpSourceBase<RangeScalar,DomainScalar> >       &fwdOpSrc
    ,const Teuchos::RCP<const PreconditionerBase<RangeScalar,DomainScalar> >      &prec
    ,LinearOpWithSolveBase<RangeScalar,DomainScalar>                                      *Op
    ,const ESupportSolveUse                                                               supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
    ) const;

  virtual void initializeApproxPreconditionedOp(
    const Teuchos::RCP<const LinearOpSourceBase<RangeScalar,DomainScalar> >       &fwdOpSrc
    ,const Teuchos::RCP<const LinearOpSourceBase<RangeScalar,DomainScalar> >      &approxFwdOpSrc
    ,LinearOpWithSolveBase<RangeScalar,DomainScalar>                                      *Op
    ,const ESupportSolveUse                                                               supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
    ) const;


};

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

template<class RangeScalar, class DomainScalar>
bool LinearOpWithSolveFactoryBase<RangeScalar,DomainScalar>::acceptsPreconditionerFactory() const
{
  return false;
}

template<class RangeScalar, class DomainScalar>
void LinearOpWithSolveFactoryBase<RangeScalar,DomainScalar>::setPreconditionerFactory(
  const Teuchos::RCP<PreconditionerFactoryBase<RangeScalar,DomainScalar> >  &precFactory
  ,const std::string                                                                &precFactoryName
  )
{
  TEST_FOR_EXCEPTION(
    true,std::logic_error
    ,"Error, the concrete implementation described as \'"<<this->description()<<"\' did not override this "
    "setPreconditionerFactory(...) function and the default implementation throws this exception!"
    );
}

template<class RangeScalar, class DomainScalar>
Teuchos::RCP<PreconditionerFactoryBase<RangeScalar,DomainScalar> >
LinearOpWithSolveFactoryBase<RangeScalar,DomainScalar>::getPreconditionerFactory() const
{
  return Teuchos::null;
}

template<class RangeScalar, class DomainScalar>
void LinearOpWithSolveFactoryBase<RangeScalar,DomainScalar>::unsetPreconditionerFactory(
  Teuchos::RCP<PreconditionerFactoryBase<RangeScalar,DomainScalar> >  *precFactory
  ,std::string                                                                *precFactoryName
  )
{
  if(precFactory) *precFactory = Teuchos::null;
  if(precFactoryName) *precFactoryName = "";
}

template<class RangeScalar, class DomainScalar>
void LinearOpWithSolveFactoryBase<RangeScalar,DomainScalar>::initializeAndReuseOp(
  const Teuchos::RCP<const LinearOpSourceBase<RangeScalar,DomainScalar> >    &fwdOpSrc
  ,LinearOpWithSolveBase<RangeScalar,DomainScalar>                                   *Op
  ) const
{
  this->initializeOp(fwdOpSrc,Op);
}

template<class RangeScalar, class DomainScalar>
bool LinearOpWithSolveFactoryBase<RangeScalar,DomainScalar>::supportsPreconditionerInputType(
  const EPreconditionerInputType precOpType
  ) const
{
  return false;
}

template<class RangeScalar, class DomainScalar>
void LinearOpWithSolveFactoryBase<RangeScalar,DomainScalar>::initializePreconditionedOp(
  const Teuchos::RCP<const LinearOpSourceBase<RangeScalar,DomainScalar> >       &fwdOpSrc
  ,const Teuchos::RCP<const PreconditionerBase<RangeScalar,DomainScalar> >      &prec
  ,LinearOpWithSolveBase<RangeScalar,DomainScalar>                                      *Op
  ,const ESupportSolveUse                                                               supportSolveUse
  ) const
{
  TEST_FOR_EXCEPTION(
    true,std::logic_error
    ,"Error, the concrete implementation described as \'"<<this->description()<<"\' did not override this "
    "initializePreconditionedOp(...) function and the default implementation throws this exception!"
    );
}

template<class RangeScalar, class DomainScalar>
void LinearOpWithSolveFactoryBase<RangeScalar,DomainScalar>::initializeApproxPreconditionedOp(
  const Teuchos::RCP<const LinearOpSourceBase<RangeScalar,DomainScalar> >       &fwdOpSrc
  ,const Teuchos::RCP<const LinearOpSourceBase<RangeScalar,DomainScalar> >      &approxFwdOpSrc
  ,LinearOpWithSolveBase<RangeScalar,DomainScalar>                                      *Op
  ,const ESupportSolveUse                                                               supportSolveUse
  ) const
{
  TEST_FOR_EXCEPTION(
    true,std::logic_error
    ,"Error, the concrete implementation described as \'"<<this->description()<<"\' did not override this "
    "initializePreconditionedOp(...) function and the default implementation throws this exception!"
    );
}

} // namespace Thyra

#endif // THYRA_LINEAR_OP_WITH_SOLVE_FACTORY_BASE_DECL_HPP

---