Teko_GaussSeidelPreconditionerFactory.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_GaussSeidelPreconditionerFactory_hpp__
#define __Teko_GaussSeidelPreconditionerFactory_hpp__

#include "Teuchos_RCP.hpp"

#include "Teko_BlockPreconditionerFactory.hpp"
#include "Teko_BlockInvDiagonalStrategy.hpp"
#include "Teko_Utilities.hpp"

namespace Teko {

typedef enum { GS_UseLowerTriangle, GS_UseUpperTriangle } TriSolveType;

class GaussSeidelPreconditionerFactory : public BlockPreconditionerFactory {
 public:


  GaussSeidelPreconditionerFactory(TriSolveType solveType, const LinearOp& invD0,
                                   const LinearOp& invD1);

  GaussSeidelPreconditionerFactory(TriSolveType solveType,
                                   const RCP<const BlockInvDiagonalStrategy>& strategy);

  GaussSeidelPreconditionerFactory();


  LinearOp buildPreconditionerOperator(BlockedLinearOp& blo, BlockPreconditionerState& state) const;

 protected:
  using BlockPreconditionerFactory::buildPreconditionerOperator;

  Teuchos::RCP<const BlockInvDiagonalStrategy> invOpsStrategy_;
  TriSolveType solveType_;

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

}  // end namespace Teko

#endif