Teko_InverseFactory.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_InverseFactory_hpp__
#define __Teko_InverseFactory_hpp__

// Teuchos includes
#include "Teuchos_RCP.hpp"

// Thyra includes
#include "Thyra_LinearOpWithSolveFactoryBase.hpp"
#include "Thyra_PreconditionerFactoryBase.hpp"

#include "Teko_Config.h"
#include "Teko_Utilities.hpp"
#include "Teko_PreconditionerState.hpp"
#include "Teko_RequestHandler.hpp"
#include "Teko_RequestHandlerContainer.hpp"

namespace Teko {

class InverseFactory : public RequestHandlerContainer {
 public:
  virtual ~InverseFactory() {}

  virtual InverseLinearOp buildInverse(const LinearOp& linearOp) const = 0;

  virtual InverseLinearOp buildInverse(const LinearOp& linearOp,
                                       const LinearOp& /* precOp */) const {
    return buildInverse(linearOp);
  }

#if 0

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

   virtual InverseLinearOp buildInverse(const LinearOp & linearOp, const LinearOp & precOp, const PreconditionerState & parentState) const
   { return buildInverse(linearOp,precOp); }
#endif

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

  virtual void rebuildInverse(const LinearOp& source, const LinearOp& /* precOp */,
                              InverseLinearOp& dest) const {
    rebuildInverse(source, dest);
  }

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

  virtual std::string toString() const = 0;

  virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const {
    return Teuchos::null;
  }

  virtual bool updateRequestedParameters(const Teuchos::ParameterList& /* pl */) { return true; }

  void setRequestHandler(const Teuchos::RCP<RequestHandler>& rh) { callbackHandler_ = rh; }

  Teuchos::RCP<RequestHandler> getRequestHandler() const { return callbackHandler_; }

 protected:
  Teuchos::RCP<RequestHandler> callbackHandler_;
};

class StaticOpInverseFactory : public InverseFactory {
 public:


  StaticOpInverseFactory(const LinearOp inv) : inverse_(inv) {}

  StaticOpInverseFactory(const StaticOpInverseFactory& saFactory) : inverse_(saFactory.inverse_) {}

  virtual ~StaticOpInverseFactory() {}

  using InverseFactory::buildInverse;
  using InverseFactory::rebuildInverse;

  virtual InverseLinearOp buildInverse(const LinearOp& /* linearOp */) const {
    return Teuchos::rcp_const_cast<Thyra::LinearOpBase<double> >(this->inverse_);
  }

  virtual void rebuildInverse(const LinearOp& /* source */, InverseLinearOp& /* dest */) const {}

  virtual Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const {
    return Teuchos::null;
  }

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

 protected:
  Teko::LinearOp inverse_;

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



InverseLinearOp buildInverse(const InverseFactory& factory, const LinearOp& A);

InverseLinearOp buildInverse(const InverseFactory& factory, const LinearOp& A,
                             const LinearOp& precOp);

void rebuildInverse(const InverseFactory& factory, const LinearOp& A, InverseLinearOp& invA);

void rebuildInverse(const InverseFactory& factory, const LinearOp& A, const LinearOp& precOp,
                    InverseLinearOp& invA);

Teuchos::RCP<InverseFactory> invFactoryFromParamList(const Teuchos::ParameterList& list,
                                                     const std::string& type);

Teuchos::RCP<const Teuchos::ParameterList> invFactoryValidParameters();


}  // end namespace Teko

#endif