MueLu_Constraint_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_CONSTRAINT_DECL_HPP
#define MUELU_CONSTRAINT_DECL_HPP
 
#include "Teuchos_ScalarTraits.hpp"
 
#include <Xpetra_MultiVector_fwd.hpp>
#include <Xpetra_MultiVectorFactory.hpp>
#include <Xpetra_Matrix.hpp>
#include <Xpetra_CrsGraph_fwd.hpp>
#include <Xpetra_MatrixFactory_fwd.hpp>
 
#include "MueLu_ConfigDefs.hpp"
#include "MueLu_BaseClass.hpp"
#include "MueLu_ProductOperator_fwd.hpp"
 
#ifdef HAVE_MUELU_BELOS
#include <BelosLinearProblem.hpp>
#include <BelosSolverFactory.hpp>
#include <BelosXpetraAdapter.hpp>
#endif
 
namespace MueLu {
 
 
template <class Scalar        = DefaultScalar,
          class LocalOrdinal  = DefaultLocalOrdinal,
          class GlobalOrdinal = DefaultGlobalOrdinal,
          class Node          = DefaultNode>
class Constraint
  : public Xpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node>,
    public BaseClass {
#undef MUELU_CONSTRAINT_SHORT
#include "MueLu_UseShortNames.hpp"
 public:
  using MagnitudeType = typename Teuchos::ScalarTraits<Scalar>::magnitudeType;
 
  Constraint() = default;
 
  virtual MagnitudeType ResidualNorm(const RCP<const Matrix> P) const = 0;
 
  virtual const RCP<const Map> getDomainMap() const;
 
  virtual const RCP<const Map> getRangeMap() const;
 
 
 
  virtual void apply(const MultiVector& P,
                     MultiVector& Projected,
                     Teuchos::ETransp mode = Teuchos::NO_TRANS,
                     Scalar alpha          = Teuchos::ScalarTraits<Scalar>::one(),
                     Scalar beta           = Teuchos::ScalarTraits<Scalar>::zero()) const;
 
  void residual(const MultiVector& X,
                const MultiVector& B,
                MultiVector& R) const;
 
 
  RCP<const CrsGraph> GetPattern() const;
 
  void SetPattern(RCP<const CrsGraph>& Ppattern);
 
  void SetConstraintsMatrix(RCP<Matrix>& X);
 
  RCP<Matrix> GetConstraintMatrix();
 
  virtual typename CrsGraph::local_graph_type FindBlocks(RCP<const CrsGraph>& XXt);
 
  void AssignMatrixEntriesToVector(const Matrix& P, const RCP<const CrsGraph>& pattern, MultiVector& vecP) const;
 
  void AssignMatrixEntriesToVector(const Matrix& P, MultiVector& vecP) const;
 
  RCP<Matrix> GetMatrixWithEntriesFromVector(MultiVector& vecP) const;
 
  void LeastSquaresSolve(const MultiVector& B, MultiVector& C) const;
 
 protected:
  void PrepareLeastSquaresSolve(const std::string& solverType, bool detect_singular_blocks = false);
 
 private:
  RCP<Matrix> X_;
 
  RCP<const CrsGraph> Ppattern_;
 
  std::string solverType_;
 
#ifdef HAVE_MUELU_BELOS
  using MV = Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>;
  using OP = Belos::OperatorT<MV>;
  RCP<Belos::LinearProblem<Scalar, MV, OP>> problem_;
  RCP<Belos::SolverManager<Scalar, MV, OP>> solver_;
#endif
 
  void PrepareLeastSquaresSolveBelos(bool detect_singular_blocks);
 
  void LeastSquaresSolveBelos(const MultiVector& B, MultiVector& C) const;
 
  RCP<Matrix> invXXt_;
 
  void PrepareLeastSquaresSolveDirect(bool detect_singular_blocks);
 
  void LeastSquaresSolveDirect(const MultiVector& B, MultiVector& C) const;
 
  // temporary memory
  RCP<MultiVector> temp1_, temp2_, temp3_;
};
 
}  // namespace MueLu
 
#define MUELU_CONSTRAINT_SHORT
#endif