Teko_InvLSCStrategy.hpp

// @HEADER
// *****************************************************************************
//      Teko: A package for block and physics based preconditioning
//
// Copyright 2010 NTESS and the Teko contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @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