Teko_LSCStrategy.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_LSCStrategy_hpp__
#define __Teko_LSCStrategy_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 LSCPrecondState;  // forward declaration

class LSCStrategy {
 public:
  virtual ~LSCStrategy() {}

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

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

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

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

#if 0

   virtual LinearOp getInvAlphaD(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
#endif

  virtual LinearOp getOuterStabilization(const BlockedLinearOp& A,
                                         BlockPreconditionerState& state) const = 0;

  virtual LinearOp getInnerStabilization(const BlockedLinearOp& A,
                                         BlockPreconditionerState& state) const = 0;

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

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

  virtual bool useFullLDU() const = 0;

  virtual void setSymmetric(bool isSymmetric) = 0;

  virtual void initializeFromParameterList(const Teuchos::ParameterList& /* pl */,
                                           const InverseLibrary& /* invLib */) {}

  virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const {
    return Teuchos::null;
  }

  virtual bool updateRequestedParameters(const Teuchos::ParameterList& /* pl */) { return true; }

  void setRequestHandler(const Teuchos::RCP<RequestHandler>& rh) { requestHandler_ = rh; }

  Teuchos::RCP<RequestHandler> getRequestHandler() const { return requestHandler_; }

 private:
  Teuchos::RCP<RequestHandler> requestHandler_;
};

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

#endif