Tpetra_FEMultiVector_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_FEMULTIVECTOR_DECL_HPP
#define TPETRA_FEMULTIVECTOR_DECL_HPP


#include "Tpetra_FEMultiVector_fwd.hpp"
#include "Tpetra_MultiVector_decl.hpp"

namespace Tpetra {

template <class Scalar,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node>
class FEMultiVector : public MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
 private:
  using base_type = ::Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>;
  friend base_type;

  void beginFill();

  void endFill();

 public:


  using scalar_type = Scalar;
  using local_ordinal_type = LocalOrdinal;
  using global_ordinal_type = GlobalOrdinal;

  using device_type = typename base_type::device_type;

  using execution_space = typename base_type::execution_space;

  using node_type = Node;

  using dual_view_type = typename base_type::dual_view_type;

  using map_type = typename base_type::map_type;

  using impl_scalar_type = typename base_type::impl_scalar_type;

  using dot_type = typename base_type::dot_type;

  using mag_type = typename base_type::mag_type;



  FEMultiVector() = delete;

  FEMultiVector(const Teuchos::RCP<const map_type>& map,
                const Teuchos::RCP<const Import<local_ordinal_type, global_ordinal_type, node_type>>& importer,
                const size_t numVecs,
                const bool zeroOut = true);

  FEMultiVector(const FEMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&) = delete;

  FEMultiVector(FEMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&&) = delete;

  FEMultiVector&
  operator=(const FEMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&) = delete;

  FEMultiVector&
  operator=(FEMultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&&) = delete;

  virtual ~FEMultiVector() = default;



  void beginAssembly();

  void endAssembly();

  void beginModify();
  void endModify();

  void globalAssemble();

  void doOwnedPlusSharedToOwned(const CombineMode CM = Tpetra::ADD);

  void doOwnedToOwnedPlusShared(const CombineMode CM = Tpetra::ADD);

  void switchActiveMultiVector();

 protected:
  void replaceMap(const Teuchos::RCP<const map_type>& map);

  Teuchos::RCP<FE::FillState> fillState_;

  Teuchos::RCP<base_type> inactiveMultiVector_;

  Teuchos::RCP<FE::WhichActive> activeMultiVector_;

  Teuchos::RCP<const Import<local_ordinal_type, global_ordinal_type, node_type>> importer_;
};

}  // namespace Tpetra

#endif  // TPETRA_FEMULTIVECTOR_DECL_HPP