type_traits.h

Go to the documentation of this file.

// ------------------------------------------------------------------------
//
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2019 - 2024 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Part of the source code is dual licensed under Apache-2.0 WITH
// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
// governing the source code and code contributions can be found in
// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
//
// ------------------------------------------------------------------------
 
 
#ifndef dealii_matrix_free_type_traits_h
#define dealii_matrix_free_type_traits_h
 
// various type-traits used exclusively within the matrix-free framework
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/partitioner.h>
 
#include <deal.II/lac/vector_type_traits.h>
 
 
DEAL_II_NAMESPACE_OPEN
 
#ifndef DOXYGEN
 
namespace internal
{
  //
  // type traits for FEEvaluation
  //
 
  // a helper type-trait leveraging SFINAE to figure out if type T has
  // ... T::local_element() const
  template <typename T>
  using local_element_t = decltype(std::declval<const T>().local_element(0));
 
  template <typename T>
  constexpr bool has_local_element = is_supported_operation<local_element_t, T>;
 
 
 
  // a helper type-trait leveraging SFINAE to figure out if type T has
  // void T::add_local_element(const uint, const typename T::value_type)
  template <typename T>
  using add_local_element_t =
    decltype(std::declval<T>().add_local_element(0, typename T::value_type()));
 
  template <typename T>
  constexpr bool has_add_local_element =
    is_supported_operation<add_local_element_t, T>;
 
 
 
  // a helper type-trait leveraging SFINAE to figure out if type T has
  // void T::set_local_element(const uint, const typename T::value_type)
  template <typename T>
  using set_local_element_t =
    decltype(std::declval<T>().set_local_element(0, typename T::value_type()));
 
  template <typename T>
  constexpr bool has_set_local_element =
    is_supported_operation<set_local_element_t, T>;
 
 
  // same as above to check
  // bool T::partitioners_are_compatible(const Utilities::MPI::Partitioner &)
  // const
  template <typename T>
  using partitioners_are_compatible_t =
    decltype(std::declval<const T>().partitioners_are_compatible(
      std::declval<Utilities::MPI::Partitioner>()));
 
  template <typename T>
  constexpr bool has_partitioners_are_compatible =
    is_supported_operation<partitioners_are_compatible_t, T>;
 
 
 
  // same as above to check
  // ... T::begin() const
  template <typename T>
  using begin_t = decltype(std::declval<const T>().begin());
 
  template <typename T>
  constexpr bool has_begin = is_supported_operation<begin_t, T>;
 
 
 
  // same as above to check
  // ... T::shared_vector_data() const
  template <typename T>
  using shared_vector_data_t =
    decltype(std::declval<const T>().shared_vector_data());
 
  template <typename T>
  constexpr bool has_shared_vector_data =
    is_supported_operation<shared_vector_data_t, T>;
 
 
  //
  // type-traits for Matrix-Free
  //
  // similar to type traits in FEEvaluation, below we add type-traits
  // to distinguish between vectors that provide different interface for
  // operations like update_ghost_values(), compress(), etc.
  // see internal::has_local_element in fe_evaluation.h that documents
  // how those type traits work.
 
  // a helper type-trait that leverage SFINAE to figure out if type T has
  // void T::update_ghost_values_start(const uint) const
  template <typename T>
  using update_ghost_values_start_t =
    decltype(std::declval<const T>().update_ghost_values_start(0));
 
  template <typename T>
  constexpr bool has_update_ghost_values_start =
    is_supported_operation<update_ghost_values_start_t, T>;
 
 
 
  // a helper type-trait that leverage SFINAE to figure out if type T has
  // void T::   compress_start(const uint, VectorOperation::values)
  template <typename T>
  using compress_start_t =
    decltype(std::declval<T>().compress_start(0, VectorOperation::add));
 
  template <typename T>
  constexpr bool has_compress_start =
    is_supported_operation<compress_start_t, T>;
 
 
 
  // type trait for vector T to see if
  // we do a custom data exchange route.
  // We assume that if both begin() and local_element()
  // exist, then begin() + offset == local_element(offset)
  template <typename T>
  constexpr bool has_exchange_on_subset =
    has_begin<T> && has_local_element<T> && has_partitioners_are_compatible<T>;
 
 
 
  // a helper type-trait that leverage SFINAE to figure out if type T has
  // T::communication_block_size
  template <typename T>
  using communication_block_size_t = decltype(T::communication_block_size);
 
  template <typename T>
  constexpr bool has_communication_block_size =
    is_supported_operation<communication_block_size_t, T>;
 
  template <typename VectorType>
  using is_vector_type = decltype(is_serial_vector<VectorType>::value);
 
  template <typename VectorType>
  using is_serial_vector_type =
    decltype(std::enable_if_t<is_serial_vector<VectorType>::value, int>());
 
  template <typename VectorType>
  constexpr bool is_not_parallel_vector =
    (is_supported_operation<is_vector_type, VectorType> == false) ||
    (is_supported_operation<is_serial_vector_type, VectorType> == true);
 
 
 
  template <typename VectorType>
  struct is_serial_vector_or_array
  {
    static const bool value =
      is_supported_operation<is_serial_vector_type, VectorType>;
  };
 
  template <typename Number>
  struct is_serial_vector_or_array<::ArrayView<Number>>
  {
    static const bool value = true;
  };
 
  // We need to have a separate declaration for static const members
  template <typename VectorType>
  const bool is_serial_vector_or_array<VectorType>::value;
 
 
 
  // type trait for vector T and Number to see if
  // we can do vectorized load/save.
  // for VectorReader and VectorDistributorLocalToGlobal we assume that
  // if both begin() and local_element()
  // exist, then begin() + offset == local_element(offset)
  template <typename T, typename Number>
  struct is_vectorizable
  {
    static const bool value =
      has_begin<T> &&
      (has_local_element<T> || is_serial_vector_or_array<T>::value) &&
      std::is_same_v<typename T::value_type, Number>;
  };
 
  // We need to have a separate declaration for static const members
  template <typename T, typename Number>
  const bool is_vectorizable<T, Number>::value;
 
} // namespace internal
#endif
 
DEAL_II_NAMESPACE_CLOSE
 
#endif