Teko_PCDStrategy.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_PCDStrategy_hpp__
#define __Teko_PCDStrategy_hpp__

#include "Teko_LU2x2Strategy.hpp"

// Teuchos includes
#include "Teuchos_Time.hpp"

namespace Teko {
namespace NS {

class PCDStrategy : public LU2x2Strategy {
 public:
  PCDStrategy();

  PCDStrategy(const Teuchos::RCP<InverseFactory>& invFA, const Teuchos::RCP<InverseFactory>& invS);

  virtual ~PCDStrategy() {}

  virtual const Teko::LinearOp getHatInvA00(const Teko::BlockedLinearOp& A,
                                            BlockPreconditionerState& state) const;

  virtual const Teko::LinearOp getTildeInvA00(const Teko::BlockedLinearOp& A,
                                              BlockPreconditionerState& state) const;

  virtual const Teko::LinearOp getInvS(const Teko::BlockedLinearOp& A,
                                       BlockPreconditionerState& state) const;

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

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

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

 protected:
  static void buildTimers();

  void initializeState(const Teko::BlockedLinearOp& A, BlockPreconditionerState& state) const;

  // how to invert the matrices
  Teuchos::RCP<InverseFactory> invFactoryF_;  // for \tilde{A_00}\f$
  Teuchos::RCP<InverseFactory> invFactoryS_;

  DiagonalType massInverseType_;

  Teuchos::RCP<Teuchos::ParameterList> lapParams_;

  Teuchos::RCP<Teuchos::ParameterList> pcdParams_;

  bool schurCompOrdering_;

  static Teuchos::RCP<Teuchos::Time> initTimer_;
  static Teuchos::RCP<Teuchos::Time> invSTimer_;
  static Teuchos::RCP<Teuchos::Time> invFTimer_;
  static Teuchos::RCP<Teuchos::Time> opsTimer_;

 public:
  // some static functions for determining strings

  static std::string getPCDString() { return "PCD Operator"; }
  static std::string getPressureLaplaceString() { return "Pressure Laplace Operator"; }
  static std::string getPressureMassString() { return "Pressure Mass Matrix"; }
};

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

#endif