Teko_SIMPLEPreconditionerFactory.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_SIMPLEPreconditionerFactory_hpp__
#define __Teko_SIMPLEPreconditionerFactory_hpp__

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

namespace Teko {
namespace NS {

// Declaration of the preconditioner factory
class SIMPLEPreconditionerFactory : public BlockPreconditionerFactory {
 public:
  // Constructor
  SIMPLEPreconditionerFactory(const Teuchos::RCP<InverseFactory>& inverse, double alpha);

  // Constructor
  SIMPLEPreconditionerFactory(const Teuchos::RCP<InverseFactory>& invVelFactory,
                              const Teuchos::RCP<InverseFactory>& invPrsFactory, double alpha);

  SIMPLEPreconditionerFactory();

  // Function inherited from BlockPreconditionerFactory
  LinearOp buildPreconditionerOperator(BlockedLinearOp& blo, BlockPreconditionerState& state) const;

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

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

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

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

 protected:
  using BlockPreconditionerFactory::buildPreconditionerOperator;

  // class members
  Teuchos::RCP<InverseFactory> customHFactory_;
  Teuchos::RCP<InverseFactory> invVelFactory_;
  Teuchos::RCP<InverseFactory> precVelFactory_;
  Teuchos::RCP<InverseFactory> invPrsFactory_;
  Teuchos::RCP<InverseFactory> precPrsFactory_;
  double alpha_;
  DiagonalType fInverseType_;
  // enum FInverseType {Diagonal,Lumped,AbsRowSum,Custom} fInverseType_;

  bool useMass_;
  Teko::LinearOp massMatrix_;

  // Info for the block-diagonal approximation to H if used.
  mutable Teuchos::ParameterList BlkDiagList_;
};

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

#endif