MueLu_Maxwell1_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_MAXWELL1_DECL_HPP
#define MUELU_MAXWELL1_DECL_HPP
 
#include "MueLu_ConfigDefs.hpp"
#include "MueLu_VerboseObject.hpp"
 
#include "MueLu_ReitzingerPFactory_fwd.hpp"
 
#include "MueLu_Utilities_fwd.hpp"
#include "MueLu_Level_fwd.hpp"
#include "MueLu_Hierarchy_fwd.hpp"
#include "MueLu_RAPFactory_fwd.hpp"
#include "MueLu_RebalanceAcFactory_fwd.hpp"
#include "MueLu_RebalanceTransferFactory_fwd.hpp"
#include "MueLu_PerfUtils_fwd.hpp"
#include "MueLu_SmootherBase_fwd.hpp"
 
#include "Xpetra_Operator.hpp"
#include "Xpetra_Map_fwd.hpp"
#include "Xpetra_Matrix_fwd.hpp"
#include "Xpetra_MatrixFactory_fwd.hpp"
#include "Xpetra_MultiVectorFactory_fwd.hpp"
#include "Xpetra_VectorFactory_fwd.hpp"
#include "Xpetra_CrsMatrixWrap_fwd.hpp"
 
namespace MueLu {
 
template <class Scalar,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node>
class Maxwell1 : public VerboseObject, public Xpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
#undef MUELU_MAXWELL1_SHORT
#include "MueLu_UseShortNames.hpp"
 
 public:
  using magnitudeType         = typename Teuchos::ScalarTraits<Scalar>::magnitudeType;
  using coordinateType        = typename Teuchos::ScalarTraits<Scalar>::coordinateType;
  using RealValuedMultiVector = typename Xpetra::MultiVector<coordinateType, LO, GO, NO>;
 
  Maxwell1()
    : Hierarchy11_(Teuchos::null)
    , Hierarchy22_(Teuchos::null)
    , HierarchyGmhd_(Teuchos::null)
    , mode_(MODE_STANDARD) {
  }
 
  Maxwell1(Teuchos::RCP<Hierarchy> H11, Teuchos::RCP<Hierarchy> H22)
    : Hierarchy11_(H11)
    , Hierarchy22_(H22)
    , HierarchyGmhd_(Teuchos::null)
    , mode_(MODE_STANDARD) {
  }
 
  Maxwell1(const Teuchos::RCP<Matrix>& SM_Matrix,
           const Teuchos::RCP<Matrix>& D0_Matrix,
           const Teuchos::RCP<MultiVector>& Nullspace,
           const Teuchos::RCP<RealValuedMultiVector>& Coords,
           Teuchos::ParameterList& List,
           bool ComputePrec = true)
    : mode_(MODE_STANDARD) {
    RCP<Matrix> Kn_Matrix       = Teuchos::null;
    RCP<Matrix> CurlCurl_Matrix = Teuchos::null;
    RCP<MultiVector> Material   = Teuchos::null;
    initialize(D0_Matrix, Kn_Matrix, Nullspace, Coords, CurlCurl_Matrix, Material, List);
    resetMatrix(SM_Matrix, ComputePrec);
  }
 
  Maxwell1(const Teuchos::RCP<Matrix>& SM_Matrix,
           const Teuchos::RCP<Matrix>& D0_Matrix,
           const Teuchos::RCP<Matrix>& Kn_Matrix,
           const Teuchos::RCP<MultiVector>& Nullspace,
           const Teuchos::RCP<RealValuedMultiVector>& Coords,
           Teuchos::ParameterList& List,
           bool ComputePrec = true)
    : mode_(MODE_STANDARD) {
    RCP<Matrix> CurlCurl_Matrix = Teuchos::null;
    RCP<MultiVector> Material   = Teuchos::null;
    initialize(D0_Matrix, Kn_Matrix, Nullspace, Coords, CurlCurl_Matrix, Material, List);
    resetMatrix(SM_Matrix, ComputePrec);
  }
 
  Maxwell1(const Teuchos::RCP<Matrix>& SM_Matrix,
           const Teuchos::RCP<Matrix>& D0_Matrix,
           const Teuchos::RCP<Matrix>& Kn_Matrix,
           const Teuchos::RCP<MultiVector>& Nullspace,
           const Teuchos::RCP<RealValuedMultiVector>& Coords,
           const Teuchos::RCP<MultiVector>& Material,
           Teuchos::ParameterList& List,
           bool ComputePrec = true)
    : mode_(MODE_STANDARD) {
    RCP<Matrix> CurlCurl_Matrix = Teuchos::null;
    initialize(D0_Matrix, Kn_Matrix, Nullspace, Coords, CurlCurl_Matrix, Material, List);
    resetMatrix(SM_Matrix, ComputePrec);
  }
 
  Maxwell1(const Teuchos::RCP<Matrix>& SM_Matrix,
           const Teuchos::RCP<Matrix>& D0_Matrix,
           const Teuchos::RCP<Matrix>& Kn_Matrix,
           const Teuchos::RCP<MultiVector>& Nullspace,
           const Teuchos::RCP<RealValuedMultiVector>& Coords,
           const Teuchos::RCP<Matrix>& CurlCurl_Matrix,
           const Teuchos::RCP<MultiVector>& Material,
           Teuchos::ParameterList& List,
           bool ComputePrec = true)
    : mode_(MODE_STANDARD) {
    initialize(D0_Matrix, Kn_Matrix, Nullspace, Coords, CurlCurl_Matrix, Material, List);
    resetMatrix(SM_Matrix, ComputePrec);
  }
 
  Maxwell1(const Teuchos::RCP<Matrix>& SM_Matrix,
           const Teuchos::RCP<Matrix>& D0_Matrix,
           const Teuchos::RCP<Matrix>& Kn_Matrix,
           const Teuchos::RCP<MultiVector>& Nullspace,
           const Teuchos::RCP<RealValuedMultiVector>& Coords,
           Teuchos::ParameterList& List, const Teuchos::RCP<Matrix>& GmhdA_Matrix,
           bool ComputePrec = true)
    : mode_(MODE_GMHD_STANDARD) {
    RCP<Matrix> CurlCurl_Matrix = Teuchos::null;
    RCP<MultiVector> Material   = Teuchos::null;
    initialize(D0_Matrix, Kn_Matrix, Nullspace, Coords, CurlCurl_Matrix, Material, List);
    resetMatrix(SM_Matrix, ComputePrec);
    GmhdA_Matrix_  = GmhdA_Matrix;
    HierarchyGmhd_ = rcp(new Hierarchy("HierarchyGmhd"));
    GMHDSetupHierarchy(List);
  }
 
  Maxwell1(const Teuchos::RCP<Matrix>& SM_Matrix,
           Teuchos::ParameterList& List,
           bool ComputePrec = true)
    : mode_(MODE_STANDARD) {
    auto& userData = List.sublist("user data");
 
#define MUELU_MAXWELL1_GET_USER_DATA(TYPE, NAME, VAR) \
  RCP<TYPE> VAR;                                      \
  if (List.isType<RCP<TYPE>>(NAME))                   \
    VAR = List.get<RCP<TYPE>>(NAME, Teuchos::null);   \
  if (userData.isType<RCP<TYPE>>(NAME))               \
    VAR = userData.get<RCP<TYPE>>(NAME, Teuchos::null);
 
    MUELU_MAXWELL1_GET_USER_DATA(MultiVector, "Nullspace", Nullspace);
    MUELU_MAXWELL1_GET_USER_DATA(RealValuedMultiVector, "Coordinates", Coords);
    MUELU_MAXWELL1_GET_USER_DATA(MultiVector, "Material", Material);
    MUELU_MAXWELL1_GET_USER_DATA(Matrix, "D0", D0_Matrix);
    MUELU_MAXWELL1_GET_USER_DATA(Matrix, "Kn", Kn_Matrix);
    MUELU_MAXWELL1_GET_USER_DATA(Matrix, "CurlCurl", CurlCurl_Matrix);
 
    initialize(D0_Matrix, Kn_Matrix, Nullspace, Coords, CurlCurl_Matrix, Material, List);
 
    if (SM_Matrix != Teuchos::null)
      resetMatrix(SM_Matrix, ComputePrec);
 
    MUELU_MAXWELL1_GET_USER_DATA(Matrix, "GmhdA", GmhdA_Matrix);
 
#undef MUELU_MAXWELL1_GET_USER_DATA
 
    if (!GmhdA_Matrix.is_null()) {
      mode_          = MODE_GMHD_STANDARD;
      GmhdA_Matrix_  = GmhdA_Matrix;
      HierarchyGmhd_ = rcp(new Hierarchy("HierarchyGmhd"));
      GMHDSetupHierarchy(List);
    }
  }
 
  virtual ~Maxwell1() = default;
 
  const Teuchos::RCP<const Map> getDomainMap() const;
 
  const Teuchos::RCP<const Map> getRangeMap() const;
 
  const Teuchos::RCP<Matrix>& getJacobian() const {
    return SM_Matrix_;
  }
 
  void setParameters(Teuchos::ParameterList& list);
 
  void compute(bool reuse = false);
 
  void resetMatrix(Teuchos::RCP<Matrix> SM_Matrix_new, bool ComputePrec = true);
 
  void apply(const MultiVector& RHS, MultiVector& X,
             Teuchos::ETransp mode = Teuchos::NO_TRANS,
             Scalar alpha          = Teuchos::ScalarTraits<Scalar>::one(),
             Scalar beta           = Teuchos::ScalarTraits<Scalar>::zero()) const;
 
  bool hasTransposeApply() const;
 
  static std::pair<std::set<std::string>, std::set<std::string>> requiredAndOptionalUserData(const Teuchos::ParameterList& params);
 
  void describe(Teuchos::FancyOStream& out, const Teuchos::EVerbosityLevel verbLevel = Teuchos::VERB_HIGH) const;
 
  void residual(const MultiVector& X,
                const MultiVector& B,
                MultiVector& R) const {
    using STS = Teuchos::ScalarTraits<Scalar>;
    R.update(STS::one(), B, STS::zero());
    this->apply(X, R, Teuchos::NO_TRANS, -STS::one(), STS::one());
  }
 
 private:
  Teuchos::RCP<Matrix> generate_kn() const;
 
  void GMHDSetupHierarchy(Teuchos::ParameterList& List) const;
 
  void initialize(const Teuchos::RCP<Matrix>& D0_Matrix,
                  const Teuchos::RCP<Matrix>& Kn_Matrix,
                  const Teuchos::RCP<MultiVector>& Nullspace,
                  const Teuchos::RCP<RealValuedMultiVector>& Coords,
                  const Teuchos::RCP<Matrix>& CurlCurl_Matrix,
                  const Teuchos::RCP<MultiVector>& Material,
                  Teuchos::ParameterList& List);
 
  void applyInverseRefMaxwellAdditive(const MultiVector& RHS, MultiVector& X) const;
 
  void applyInverseStandard(const MultiVector& RHS, MultiVector& X) const;
 
  void allocateMemory(int numVectors) const;
 
  void dump(const Matrix& A, std::string name) const;
 
  void dump(const MultiVector& X, std::string name) const;
 
  void dumpCoords(const RealValuedMultiVector& X, std::string name) const;
 
  void dump(const Teuchos::ArrayRCP<bool>& v, std::string name) const;
 
  void dump(const Kokkos::View<bool*, typename Node::device_type>& v, std::string name) const;
 
  Teuchos::RCP<Teuchos::TimeMonitor> getTimer(std::string name, RCP<const Teuchos::Comm<int>> comm = Teuchos::null) const;
 
  mutable Teuchos::ParameterList parameterList_, precList11_, precList22_;
 
  Teuchos::RCP<Hierarchy> Hierarchy11_, Hierarchy22_, HierarchyGmhd_;
 
  Teuchos::RCP<Matrix> SM_Matrix_, D0_Matrix_, Kn_Matrix_, GmhdA_Matrix_;
 
  Kokkos::View<bool*, typename Node::device_type::memory_space> BCrowsKokkos_, BCcolsKokkos_, BCdomainKokkos_;
  int BCedges_, BCnodes_;
  Teuchos::ArrayRCP<bool> BCrows_, BCcols_, BCdomain_;
  Teuchos::RCP<MultiVector> Nullspace_;
  Teuchos::RCP<RealValuedMultiVector> Coords_;
  Teuchos::RCP<MultiVector> Material_;
  bool useKokkos_, allEdgesBoundary_, allNodesBoundary_, dump_matrices_, check_D0_scaling_, enable_reuse_, syncTimers_;
  bool applyBCsTo22_;
 
  typedef enum { MODE_STANDARD = 0,
                 MODE_REFMAXWELL,
                 MODE_EDGE_ONLY,
                 MODE_GMHD_STANDARD } mode_type;
  mode_type mode_;
 
  RCP<Matrix> P11_;
  mutable Teuchos::RCP<MultiVector> residualFine_, residual11c_, residual22_, update11c_, update22_;
};
 
}  // namespace MueLu
 
#define MUELU_MAXWELL1_SHORT
#endif  // MUELU_MAXWELL1_DECL_HPP