Tpetra_FECrsMatrix_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//          Tpetra: Templated Linear Algebra Services Package
//
// Copyright 2008 NTESS and the Tpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef TPETRA_FECRSMATRIX_DECL_HPP
#define TPETRA_FECRSMATRIX_DECL_HPP
 
 
#include "Tpetra_ConfigDefs.hpp"
#include "Tpetra_CrsMatrix_decl.hpp"
#include "Tpetra_FECrsGraph.hpp"
 
namespace Tpetra {
 
template <class Scalar        = ::Tpetra::Details::DefaultTypes::scalar_type,
          class LocalOrdinal  = ::Tpetra::Details::DefaultTypes::local_ordinal_type,
          class GlobalOrdinal = ::Tpetra::Details::DefaultTypes::global_ordinal_type,
          class Node          = ::Tpetra::Details::DefaultTypes::node_type>
class FECrsMatrix : public CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
  friend class CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>;
 
 public:
 
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::scalar_type scalar_type;
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::impl_scalar_type impl_scalar_type;
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::local_ordinal_type local_ordinal_type;
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::global_ordinal_type global_ordinal_type;
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::node_type node_type;
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::device_type device_type;
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::execution_space execution_space;
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::mag_type mag_type;
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::map_type map_type;
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::import_type import_type;
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::export_type export_type;
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::crs_graph_type crs_graph_type;
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::local_graph_device_type local_graph_device_type;
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::local_matrix_device_type local_matrix_device_type;
 
  typedef typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::local_matrix_host_type local_matrix_host_type;
 
  typedef CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> crs_matrix_type;
 
  typedef FECrsGraph<LocalOrdinal, GlobalOrdinal, Node> fe_crs_graph_type;
 
 
 
  explicit FECrsMatrix(const Teuchos::RCP<const fe_crs_graph_type>& graph,
                       const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
 
  FECrsMatrix(const FECrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>&) = delete;
 
  FECrsMatrix(FECrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>&&) = delete;
 
  FECrsMatrix&
  operator=(const FECrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>&) = delete;
  FECrsMatrix&
  operator=(FECrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>&&) = delete;
 
  virtual ~FECrsMatrix() = default;
 
 
 
  void globalAssemble() { endFill(); }
 
  void endAssembly();
 
  void beginAssembly();
 
  void endModify();
 
  void beginModify();
 
 private:
  void endFill();
  void beginFill();
 
  static const bool useAtomicUpdatesByDefault =
#ifdef KOKKOS_ENABLE_SERIAL
      !std::is_same<execution_space, Kokkos::Serial>::value;
#else
      true;
#endif  // KOKKOS_ENABLE_SERIAL
 
 protected:
  LocalOrdinal
  replaceGlobalValuesImpl(impl_scalar_type rowVals[],
                          const crs_graph_type& graph,
                          const RowInfo& rowInfo,
                          const GlobalOrdinal inds[],
                          const impl_scalar_type newVals[],
                          const LocalOrdinal numElts);
 
  LocalOrdinal
  replaceLocalValuesImpl(impl_scalar_type rowVals[],
                         const crs_graph_type& graph,
                         const RowInfo& rowInfo,
                         const LocalOrdinal inds[],
                         const impl_scalar_type newVals[],
                         const LocalOrdinal numElts);
 
  LocalOrdinal
  sumIntoGlobalValuesImpl(impl_scalar_type rowVals[],
                          const crs_graph_type& graph,
                          const RowInfo& rowInfo,
                          const GlobalOrdinal inds[],
                          const impl_scalar_type newVals[],
                          const LocalOrdinal numElts,
                          const bool atomic = useAtomicUpdatesByDefault);
 
  LocalOrdinal
  sumIntoLocalValuesImpl(impl_scalar_type rowVals[],
                         const crs_graph_type& graph,
                         const RowInfo& rowInfo,
                         const LocalOrdinal inds[],
                         const impl_scalar_type newVals[],
                         const LocalOrdinal numElts,
                         const bool atomic = useAtomicUpdatesByDefault);
 
  void
  insertGlobalValuesImpl(crs_graph_type& graph,
                         RowInfo& rowInfo,
                         const GlobalOrdinal gblColInds[],
                         const impl_scalar_type vals[],
                         const size_t numInputEnt);
 
 protected:
  void doOwnedPlusSharedToOwned(const CombineMode CM = Tpetra::ADD);
 
  void doOwnedToOwnedPlusShared(const CombineMode CM = Tpetra::ADD);
 
  void switchActiveCrsMatrix();
 
 private:
  // The FECrsGraph from construction time
  Teuchos::RCP<const FECrsGraph<LocalOrdinal, GlobalOrdinal, Node> > feGraph_;
 
  // This is whichever multivector isn't currently active
  Teuchos::RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > inactiveCrsMatrix_;
  // This is in RCP to make shallow copies of the FECrsMatrix work correctly
  Teuchos::RCP<FE::WhichActive> activeCrsMatrix_;
 
  Teuchos::RCP<FE::FillState> fillState_;
 
};  // end class FECrsMatrix
 
}  // end namespace Tpetra
 
#endif  // TPETRA_FECRSMATRIX_DECL_HPP