MueLu_SteepestDescentSolver_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//        MueLu: A package for multigrid based preconditioning
//
// Copyright 2012 NTESS and the MueLu contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef MUELU_STEEPESTDESCENTSOLVER_DECL_HPP
#define MUELU_STEEPESTDESCENTSOLVER_DECL_HPP
 
#include <Xpetra_Matrix_fwd.hpp>
#include <Xpetra_CrsMatrixWrap_fwd.hpp>
#include <Xpetra_CrsMatrixFactory_fwd.hpp>
 
#include "MueLu_ConfigDefs.hpp"
#include "MueLu_Utilities_fwd.hpp"
#include "MueLu_SolverBase.hpp"
#include "MueLu_Constraint_fwd.hpp"
 
namespace MueLu {

 
template <class Scalar        = DefaultScalar,
          class LocalOrdinal  = DefaultLocalOrdinal,
          class GlobalOrdinal = DefaultGlobalOrdinal,
          class Node          = DefaultNode>
class SteepestDescentSolver : public SolverBase<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
#undef MUELU_STEEPESTDESCENTSOLVER_SHORT
#include "MueLu_UseShortNames.hpp"
 
 public:


  SteepestDescentSolver(size_t Its, SC StepLength = Teuchos::ScalarTraits<Scalar>::one());




  void Iterate(const Matrix& A, const Constraint& C, const Matrix& P0, RCP<Matrix>& P) const;

 
 private:
  size_t nIts_;    
  SC stepLength_;  
};
 
}  // namespace MueLu
 
#define MUELU_STEEPESTDESCENTSOLVER_SHORT
#endif  // MUELU_STEEPESTDESCENTSOLVER_DECL_HPP