Ifpack2_ContainerFactory_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//       Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
//
// Copyright 2009 NTESS and the Ifpack2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef IFPACK2_CONTAINERFACTORY_DECL_H
#define IFPACK2_CONTAINERFACTORY_DECL_H

#include "Ifpack2_Container.hpp"
#include "Ifpack2_Partitioner.hpp"
#ifdef HAVE_IFPACK2_AMESOS2
#include "Ifpack2_Details_Amesos2Wrapper.hpp"
#endif
#include "Tpetra_RowMatrix.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_Ptr.hpp"
#include <string>
#include <map>


namespace Ifpack2 {
namespace Details {

// The default container type names:
//
// Dense
// SparseILUT
// SparseAmesos, alias SparseAmesos2
// TriDi
// Banded

template <typename MatrixType>
struct ContainerFactoryEntryBase {
  virtual Teuchos::RCP<Ifpack2::Container<MatrixType>> build(
      const Teuchos::RCP<const MatrixType>& A,
      const Teuchos::Array<Teuchos::Array<typename MatrixType::local_ordinal_type>>& partitions,
      const Teuchos::RCP<const Tpetra::Import<
          typename MatrixType::local_ordinal_type,
          typename MatrixType::global_ordinal_type,
          typename MatrixType::node_type>>
          importer,
      bool pointIndexed) = 0;
  virtual ~ContainerFactoryEntryBase() {}
};

template <typename MatrixType, typename ContainerType>
struct ContainerFactoryEntry : public ContainerFactoryEntryBase<MatrixType> {
  Teuchos::RCP<Ifpack2::Container<MatrixType>> build(
      const Teuchos::RCP<const MatrixType>& A,
      const Teuchos::Array<Teuchos::Array<typename MatrixType::local_ordinal_type>>& partitions,
      const Teuchos::RCP<const Tpetra::Import<
          typename MatrixType::local_ordinal_type,
          typename MatrixType::global_ordinal_type,
          typename MatrixType::node_type>>
          importer,
      bool pointIndexed) {
    return Teuchos::rcp(new ContainerType(A, partitions, importer, pointIndexed));
  }
  ~ContainerFactoryEntry() {}
};

}  // namespace Details


template <typename MatrixType>
struct ContainerFactory {


  typedef typename MatrixType::scalar_type scalar_type;
  typedef typename MatrixType::local_ordinal_type local_ordinal_type;
  typedef typename MatrixType::global_ordinal_type global_ordinal_type;
  typedef typename MatrixType::node_type node_type;

  typedef Tpetra::RowMatrix<scalar_type, local_ordinal_type, global_ordinal_type, node_type> row_matrix_type;
  typedef Tpetra::Import<local_ordinal_type, global_ordinal_type, node_type> import_type;
  typedef Ifpack2::Container<MatrixType> BaseContainer;

  static_assert(std::is_same<typename std::decay<MatrixType>::type, row_matrix_type>::value,
                "MatrixType must be a Tpetra::RowMatrix specialization.");

  // \name Functions

  template <typename ContainerType>
  static void registerContainer(std::string containerType);


  static Teuchos::RCP<BaseContainer> build(std::string containerType, const Teuchos::RCP<const MatrixType>& A,
                                           const Teuchos::Array<Teuchos::Array<local_ordinal_type>>& partitions, const Teuchos::RCP<const import_type> importer, bool pointIndexed);


  static void deregisterContainer(std::string containerType);

 private:
  static std::map<std::string, Teuchos::RCP<Details::ContainerFactoryEntryBase<MatrixType>>> table;
  static bool registeredDefaults;  // this will initially be false
  static void registerDefaults();
};

}  // namespace Ifpack2

#endif  // IFPACK2_DETAILS_CONTAINERFACTORY_H