Teko_MultPreconditionerFactory.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_MultiPreconditionerFactory_hpp__
#define __Teko_MultiPreconditionerFactory_hpp__
 
#include "Teko_BlockPreconditionerFactory.hpp"
#include "Teko_Utilities.hpp"
#include "Teko_BlockImplicitLinearOp.hpp"
 
namespace Teko {

class MultPrecondState : public Teko::BlockPreconditionerState {
public:
   MultPrecondState() {}
 
   Teuchos::RCP<BlockPreconditionerState> StateOne_;
   Teuchos::RCP<BlockPreconditionerState> StateTwo_;
};

class MultPrecsLinearOp : public Teko::BlockImplicitLinearOp {
public:

   MultPrecsLinearOp(const Teko::LinearOp &A, const Teko::LinearOp &M1, 
            const Teko::LinearOp &M2): A_(A), M1_(M1), M2_(M2) { }
 
   virtual Teko::VectorSpace  range() const { return M1_->range(); }
   virtual Teko::VectorSpace domain() const { return M1_->domain();}
   virtual void implicitApply(const Teko::BlockedMultiVector & r, Teko::BlockedMultiVector & y,
             const double alpha = 1.0, const double beta = 0.0) const;
 
protected:
   using Teko::BlockImplicitLinearOp::implicitApply;
 
   Teko::LinearOp A_, M1_, M2_;
 
private:
   // hide me!
   MultPrecsLinearOp();
   MultPrecsLinearOp(const MultPrecsLinearOp &);
};

class MultPreconditionerFactory
   : public Teko::BlockPreconditionerFactory {
public:
   MultPreconditionerFactory(const Teuchos::RCP<const Teko::BlockPreconditionerFactory> & FirstFactory,
                             const Teuchos::RCP<const Teko::BlockPreconditionerFactory> & SecondFactory);
 
   MultPreconditionerFactory();

   Teko::LinearOp buildPreconditionerOperator(Teko::BlockedLinearOp & blo,
                                            Teko::BlockPreconditionerState & state) const;
    
   virtual Teuchos::RCP<Teko::PreconditionerState> buildPreconditionerState() const;
 
protected:
   using Teko::BlockPreconditionerFactory::buildPreconditionerOperator;
 
   // class members
   Teuchos::RCP<const Teko::BlockPreconditionerFactory> FirstFactory_;
   Teuchos::RCP<const Teko::BlockPreconditionerFactory> SecondFactory_;
   
   virtual void initializeFromParameterList(const Teuchos::ParameterList & pl);
};
 
} // end namespace Teko
 
#endif