libtrilinos-teko-dev 12.12.1-5 / usr / include / trilinos / Teko_InvLSCStrategy.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_InvLSCStrategy_hpp__
#define __Teko_InvLSCStrategy_hpp__

#include "Teko_LSCStrategy.hpp"

namespace Teko {
namespace NS {

class LSCPrecondState; // forward declration

/** \brief A strategy that takes a single inverse factory and
  *        uses that for all inverses. If no mass matrix is 
  *        passed in the diagonal of the 1,1 block is used.
  *
  * A strategy that takes a single inverse factory and uses that
  * for all inverses. Optionally the mass matrix can be passed
  * in, if it is the diagonal is extracted and that is used to
  * form the inverse approximation.
  */
class InvLSCStrategy : public LSCStrategy {
public:
   //! \name Constructors
   //@{
   InvLSCStrategy();
   InvLSCStrategy(const Teuchos::RCP<InverseFactory> & factory,
                  bool rzn=false);
   InvLSCStrategy(const Teuchos::RCP<InverseFactory> & factory,
                  LinearOp & mass,bool rzn=false);
   InvLSCStrategy(const Teuchos::RCP<InverseFactory> & invFactF,
                  const Teuchos::RCP<InverseFactory> & invFactS,
                  bool rzn=false);
   InvLSCStrategy(const Teuchos::RCP<InverseFactory> & invFactF,
                  const Teuchos::RCP<InverseFactory> & invFactS,
                  LinearOp & mass,bool rzn=false);
   //@}

   virtual ~InvLSCStrategy() {}

   //! Functions inherited from LSCStrategy
   //@{

   /** This informs the strategy object to build the state associated
     * with this operator.
     *
     * \param[in] A The linear operator to be preconditioned by LSC.
     * \param[in] state State object for storying reusable information about
     *                  the operator A.
     */
   virtual void buildState(BlockedLinearOp & A,BlockPreconditionerState & state) const;

   /** Get the inverse of \f$B Q_u^{-1} B^T\f$. 
     *
     * \param[in] A The linear operator to be preconditioned by LSC.
     * \param[in] state State object for storying reusable information about
     *                  the operator A.
     *
     * \returns An (approximate) inverse of \f$B Q_u^{-1} B^T\f$.
     */
   virtual LinearOp getInvBQBt(const BlockedLinearOp & A,BlockPreconditionerState & state) const;

   /** Get the inverse of \f$B H B^T - \gamma C\f$. 
     *
     * \param[in] A The linear operator to be preconditioned by LSC.
     * \param[in] state State object for storying reusable information about
     *                  the operator A.
     *
     * \returns An (approximate) inverse of \f$B H B^T - \gamma C\f$.
     */
   virtual LinearOp getInvBHBt(const BlockedLinearOp & A,BlockPreconditionerState & state) const;

   /** Get the inverse of the \f$F\f$ block.
     *
     * \param[in] A The linear operator to be preconditioned by LSC.
     * \param[in] state State object for storying reusable information about
     *                  the operator A.
     *
     * \returns An (approximate) inverse of \f$F\f$.
     */
   virtual LinearOp getInvF(const BlockedLinearOp & A,BlockPreconditionerState & state) const;

   /** Get the inverse for stabilizing the whole schur complement approximation.
     *
     * \param[in] A The linear operator to be preconditioned by LSC.
     * \param[in] state State object for storying reusable information about
     *                  the operator A.
     *
     * \returns The operator to stabilize the whole Schur complement.
     */
   // virtual LinearOp getInvAlphaD(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
   virtual LinearOp getOuterStabilization(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
   virtual LinearOp getInnerStabilization(const BlockedLinearOp & A,BlockPreconditionerState & state) const
   { return Teuchos::null; }

   /** Get the inverse mass matrix.
     *
     * \param[in] A The linear operator to be preconditioned by LSC.
     * \param[in] state State object for storying reusable information about
     *                  the operator A.
     *
     * \returns The inverse of the mass matrix \f$Q_u\f$.
     */
   virtual LinearOp getInvMass(const BlockedLinearOp & A,BlockPreconditionerState & state) const;

   /** Get the \f$H\f$ scaling matrix.
     *
     * \param[in] A The linear operator to be preconditioned by LSC.
     * \param[in] state State object for storying reusable information about
     *                  the operator A.
     *
     * \returns The \f$H\f$ scaling matrix.
     */
   virtual LinearOp getHScaling(const BlockedLinearOp & A,BlockPreconditionerState & state) const;

   /** Should the approximation of the inverse use a full LDU decomposition, or
     * is a upper triangular approximation sufficient.
     *
     * \returns True if the full LDU decomposition should be used, otherwise
     *          only an upper triangular version is used.
     */
   virtual bool useFullLDU() const { return useFullLDU_; }

   /** Tell strategy that this operator is supposed to be symmetric.
     * Behavior of LSC is slightly different for non-symmetric case.
     *
     * \param[in] isSymmetric Is this operator symmetric?
     */
   virtual void setSymmetric(bool isSymmetric) 
   { isSymmetric_ = isSymmetric; }

   //! Initialize from a parameter list
   virtual void initializeFromParameterList(const Teuchos::ParameterList & pl,
                                            const InverseLibrary & invLib); 

   //! For assiting in construction of the preconditioner
   virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;

   //! For assiting in construction of the preconditioner
   virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl);
   //@}

   //! When computing the Schur complement, use the passed in matrix instead
   //! of \f$C\f$ to stabilize the gradient operator.
   virtual void setPressureStabMatrix(const Teko::LinearOp & psm)
   { userPresStabMat_ = psm; }

   //! Initialize the state object using this blocked linear operator
   virtual void initializeState(const BlockedLinearOp & A,LSCPrecondState * state) const;

   /** Compute the inverses required for the LSC Schur complement
     *
     * \note This method assumes that the BQBt and BHBt operators have
     *       been constructed.
     */
   void computeInverses(const BlockedLinearOp & A,LSCPrecondState * state) const;

   // //! Initialize the state object using this blocked linear operator
   // virtual void reinitializeState(const BlockedLinearOp & A,LSCPrecondState * state) const;

   //! Set the number of power series iterations to use when finding the spectral radius
   virtual void setEigSolveParam(int sz) { eigSolveParam_ = sz; }

   //! Return the number of power series iterations to use when finding the spectral radius
   virtual int getEigSolveParam() { return eigSolveParam_; }

   //! Set to true to use the Full LDU decomposition, false otherwise
   virtual void setUseFullLDU(bool val) { useFullLDU_ = val; }

   //! Set to true to zero the rows of F when computing the spectral radius
   virtual void setRowZeroing(bool val) { rowZeroingNeeded_ = val; }

   //! set the mass matrix to use in computing the scaling
   virtual void setMassMatrix(const LinearOp & mass) { massMatrix_ = mass; }

   /** Set the \f$H\f$-Scaling operator used in \f$B H B^T\f$. It is expected
     * that this will be a diagonal matrix.
     */
   virtual void setHScaling(const LinearOp & hScaling) { hScaling_ = hScaling; }

   /** Set the \f$H\f$-Scaling operator used in \f$B H B^T\f$. This method
     * takes a vector and constructs the diagonal matrix.
     */
   virtual void setHScaling(const MultiVector & hScaling) 
   { hScaling_ = buildDiagonal(hScaling,"H"); }

   /** Set the \f$W\f$-Scaling vector used in \f$B H B^T\f$. This method
     * takes a vector.
     */
   virtual void setWScaling(const MultiVector & wScaling) 
   { wScaling_ = wScaling; }

protected:
   LinearOp massMatrix_;

   // how to invert the matrices
   Teuchos::RCP<InverseFactory> invFactoryF_;
   Teuchos::RCP<InverseFactory> invFactoryS_;

   // number of power iterations when computing spectral radius
   int eigSolveParam_;

   // flags for handling various options
   bool rowZeroingNeeded_;
   bool useFullLDU_;
   bool useMass_;
   bool useLumping_;
   bool useWScaling_;
   DiagonalType scaleType_; 
   bool isSymmetric_;
   bool assumeStable_;

   // operators requested, to be filled by user
   LinearOp userPresStabMat_;
   mutable LinearOp hScaling_;
   MultiVector wScaling_;

private:
   InvLSCStrategy(const InvLSCStrategy &);
};

} // end namespace NS
} // end namespace Teko

#endif