Teko_InvModALStrategy.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

/*
 * Author: Zhen Wang
 * Email: wangz@ornl.gov
 *        zhen.wang@alum.emory.edu
 */

#ifndef __Teko_ModALStrategy_hpp__
#define __Teko_ModALStrategy_hpp__

#include "Teuchos_RCP.hpp"

#include "Thyra_LinearOpBase.hpp"

#include "Teko_Utilities.hpp"
#include "Teko_InverseFactory.hpp"
#include "Teko_BlockPreconditionerFactory.hpp"

namespace Teko {

namespace NS {

class ModALPrecondState;

class InvModALStrategy {
 public:
  InvModALStrategy();

  InvModALStrategy(const Teuchos::RCP<InverseFactory>& factory);

  InvModALStrategy(const Teuchos::RCP<InverseFactory>& factory, LinearOp& pressureMassMatrix);

  InvModALStrategy(const Teuchos::RCP<InverseFactory>& invFactA,
                   const Teuchos::RCP<InverseFactory>& invFactS);

  InvModALStrategy(const Teuchos::RCP<InverseFactory>& invFactA,
                   const Teuchos::RCP<InverseFactory>& invFactS, LinearOp& pressureMassMatrix);

  virtual ~InvModALStrategy() {}

  virtual LinearOp getInvA11p(BlockPreconditionerState& state) const;

  virtual LinearOp getInvA22p(BlockPreconditionerState& state) const;

  virtual LinearOp getInvA33p(BlockPreconditionerState& state) const;

  virtual LinearOp getInvS(BlockPreconditionerState& state) const;

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

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

  virtual void computeInverses(const BlockedLinearOp& A, ModALPrecondState* state) const;

  void setPressureMassMatrix(const LinearOp& pressureMassMatrix);

  void setGamma(double gamma);

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

 protected:
  // In the modified AL preconditioner, we need to two methods,
  // one for solving \f$ A_{ii}, i = 1, 2(, 3) \f$,
  // the other for solving \f$ S \f$.
  Teuchos::RCP<InverseFactory> invFactoryA_;
  Teuchos::RCP<InverseFactory> invFactoryS_;
  LinearOp pressureMassMatrix_;
  double gamma_;

  DiagonalType scaleType_;
  bool isSymmetric_;
  int dim_;
};

}  // end namespace NS

}  // end namespace Teko

#endif /* __Teko_ModALStrategy_hpp__ */