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

class InvLSCStrategy : public LSCStrategy {
public:

   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() {}



   virtual void buildState(BlockedLinearOp & A,BlockPreconditionerState & state) const;

   virtual LinearOp getInvBQBt(const BlockedLinearOp & A,BlockPreconditionerState & state) const;

   virtual LinearOp getInvBHBt(const BlockedLinearOp & A,BlockPreconditionerState & state) const;

   virtual LinearOp getInvF(const BlockedLinearOp & A,BlockPreconditionerState & state) const;

   // 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; }

   virtual LinearOp getInvMass(const BlockedLinearOp & A,BlockPreconditionerState & state) const;

   virtual LinearOp getHScaling(const BlockedLinearOp & A,BlockPreconditionerState & state) const;

   virtual bool useFullLDU() const { return useFullLDU_; }

   virtual void setSymmetric(bool isSymmetric) 
   { isSymmetric_ = isSymmetric; }

   virtual void initializeFromParameterList(const Teuchos::ParameterList & pl,
                                            const InverseLibrary & invLib); 

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

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

   virtual void setPressureStabMatrix(const Teko::LinearOp & psm)
   { userPresStabMat_ = psm; }

   virtual void initializeState(const BlockedLinearOp & A,LSCPrecondState * state) const;

   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;

   virtual void setEigSolveParam(int sz) { eigSolveParam_ = sz; }

   virtual int getEigSolveParam() { return eigSolveParam_; }

   virtual void setUseFullLDU(bool val) { useFullLDU_ = val; }

   virtual void setRowZeroing(bool val) { rowZeroingNeeded_ = val; }

   virtual void setMassMatrix(const LinearOp & mass) { massMatrix_ = mass; }

   virtual void setHScaling(const LinearOp & hScaling) { hScaling_ = hScaling; }

   virtual void setHScaling(const MultiVector & hScaling) 
   { hScaling_ = buildDiagonal(hScaling,"H"); }

   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