Teko_PreconditionerInverseFactory.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_PreconditionerInverseFactory_hpp__
#define __Teko_PreconditionerInverseFactory_hpp__

#include "Teko_InverseFactory.hpp"

namespace Teko {

class PreconditionerInverseFactory : public InverseFactory {
 public:
  using InverseFactory::buildInverse;
  using InverseFactory::rebuildInverse;



  PreconditionerInverseFactory(
      const Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> >& precFactory,
      const Teuchos::RCP<Teko::RequestHandler>& rh);

  PreconditionerInverseFactory(
      const Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> >& precFactory,
      const Teuchos::RCP<const Teuchos::ParameterList>& xtraParam,
      const Teuchos::RCP<Teko::RequestHandler>& rh);

  PreconditionerInverseFactory(const PreconditionerInverseFactory& pFactory);

  virtual ~PreconditionerInverseFactory() {}

  virtual InverseLinearOp buildInverse(const LinearOp& linearOp) const;

  virtual InverseLinearOp buildInverse(const LinearOp& linearOp,
                                       const PreconditionerState& parentState) const;

  virtual void rebuildInverse(const LinearOp& source, InverseLinearOp& dest) const;

  virtual Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;

  virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;

  virtual bool updateRequestedParameters(const Teuchos::ParameterList& pl);

  virtual std::string toString() const { return precFactory_->description(); }

  Teuchos::RCP<const Thyra::PreconditionerFactoryBase<double> > getPrecFactory() const {
    return precFactory_;
  }

  Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> > getPrecFactory() { return precFactory_; }

  void setupParameterListFromRequestHandler();

 protected:
  Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> > precFactory_;
  Teuchos::RCP<Teuchos::ParameterList> extraParams_;

 private:
  // hide me!
  PreconditionerInverseFactory();
};

}  // namespace Teko

#endif