15#ifndef dealii_la_parallel_vector_h
16#define dealii_la_parallel_vector_h
36#if defined(DEAL_II_WITH_MPI)
54 template <
typename,
typename>
62# ifdef DEAL_II_WITH_PETSC
72# ifdef DEAL_II_WITH_TRILINOS
255 template <
typename Number,
typename MemorySpace = MemorySpace::Host>
271 std::is_same_v<MemorySpace, ::MemorySpace::Host> ||
272 std::is_same_v<MemorySpace, ::MemorySpace::Default>,
273 "MemorySpace should be Host or Default");
276 (!std::is_same_v<MemorySpace, ::MemorySpace::Default>) ||
277 std::is_same_v<Number, float> || std::is_same_v<Number, double>,
278 "Number should be float or double for Default memory space");
344 const std::shared_ptr<const Utilities::MPI::Partitioner> &
partitioner);
368 template <
typename Number2>
371 const bool omit_zeroing_entries =
false);
414 const std::shared_ptr<const Utilities::MPI::Partitioner> &
partitioner,
425 const std::shared_ptr<const Utilities::MPI::Partitioner> &
partitioner,
426 const bool make_ghosted,
520 template <
typename Number2>
653 const unsigned int communication_channel = 0)
const;
705 template <
typename Number2>
719 template <
typename MemorySpace2>
727 template <
typename MemorySpace2>
781 const std::shared_ptr<const Utilities::MPI::CommunicationPatternBase>
782 &communication_pattern = {});
790 std::shared_ptr<const Utilities::MPI::CommunicationPatternBase>
791 communication_pattern = {})
828 add(
const std::vector<size_type> &indices,
829 const std::vector<Number> &values);
932 const unsigned int precision = 3,
933 const bool scientific =
true,
934 const bool across =
true)
const;
960 template <
typename OtherNumber>
962 add(
const std::vector<size_type> &indices,
963 const ::Vector<OtherNumber> &values);
969 template <
typename OtherNumber>
973 const OtherNumber *values);
1138 template <
typename OtherNumber>
1141 std::vector<OtherNumber> &values)
const;
1178 template <
typename ForwardIterator,
typename OutputIterator>
1181 const ForwardIterator indices_end,
1182 OutputIterator values_begin)
const;
1222 const std::shared_ptr<const Utilities::MPI::Partitioner> &
1265 const std::vector<ArrayView<const Number>> &
1284 <<
"Called compress(VectorOperation::insert), but"
1285 <<
" the element received from a remote processor, value "
1286 << std::setprecision(16) << arg1
1287 <<
", does not match with the value "
1288 << std::setprecision(16) << arg2
1289 <<
" on the owner processor " << arg3);
1300 <<
"You tried to access element " << arg1
1301 <<
" of a distributed vector, but this element is not "
1302 <<
"stored on the current processor. Note: The range of "
1303 <<
"locally owned elements is [" << arg2 <<
',' << arg3
1304 <<
"], and there are " << arg4 <<
" ghost elements "
1305 <<
"that this vector can access."
1307 <<
"A common source for this kind of problem is that you "
1308 <<
"are passing a 'fully distributed' vector into a function "
1309 <<
"that needs read access to vector elements that correspond "
1310 <<
"to degrees of freedom on ghost cells (or at least to "
1311 <<
"'locally active' degrees of freedom that are not also "
1312 <<
"'locally owned'). You need to pass a vector that has these "
1313 <<
"elements as ghost entries.");
1335 template <
typename Number2>
1404 mutable ::MemorySpace::MemorySpaceData<Number, MemorySpace>
data;
1410 mutable std::shared_ptr<::parallel::internal::TBBPartitioner>
1417 mutable ::MemorySpace::MemorySpaceData<Number, MemorySpace>
1429#ifdef DEAL_II_WITH_MPI
1476 template <
typename Number2,
typename MemorySpace2>
1480 template <
typename Number2,
typename MemorySpace2>
1490 template <
typename Number,
typename MemorySpace>
1494 return vector_is_ghosted;
1499 template <
typename Number,
typename MemorySpace>
1503 return partitioner->size();
1508 template <
typename Number,
typename MemorySpace>
1512 return partitioner->locally_owned_size();
1517 template <
typename Number,
typename MemorySpace>
1520 const size_type global_index)
const
1522 return partitioner->in_local_range(global_index);
1527 template <
typename Number,
typename MemorySpace>
1531 IndexSet is(size());
1533 is.add_range(partitioner->local_range().first,
1534 partitioner->local_range().second);
1541 template <
typename Number,
typename MemorySpace>
1545 return data.values.data();
1550 template <
typename Number,
typename MemorySpace>
1554 return data.values.data();
1559 template <
typename Number,
typename MemorySpace>
1563 return data.values.data() + partitioner->locally_owned_size();
1568 template <
typename Number,
typename MemorySpace>
1572 return data.values.data() + partitioner->locally_owned_size();
1577 template <
typename Number,
typename MemorySpace>
1578 const std::vector<ArrayView<const Number>> &
1581 return data.values_sm;
1586 template <
typename Number,
typename MemorySpace>
1590 Assert((std::is_same_v<MemorySpace, ::MemorySpace::Host>),
1592 "This function is only implemented for the Host memory space"));
1594 partitioner->in_local_range(global_index) ||
1595 partitioner->ghost_indices().is_element(global_index),
1596 ExcAccessToNonLocalElement(global_index,
1597 partitioner->local_range().first,
1598 partitioner->local_range().second == 0 ?
1600 (partitioner->local_range().second - 1),
1601 partitioner->ghost_indices().n_elements()));
1603 Assert(partitioner->in_local_range(global_index) ||
1604 vector_is_ghosted ==
true,
1605 ExcMessage(
"You tried to read a ghost element of this vector, "
1606 "but it has not imported its ghost values."));
1607 return data.values[partitioner->global_to_local(global_index)];
1612 template <
typename Number,
typename MemorySpace>
1616 Assert((std::is_same_v<MemorySpace, ::MemorySpace::Host>),
1618 "This function is only implemented for the Host memory space"));
1620 partitioner->in_local_range(global_index) ||
1621 partitioner->ghost_indices().is_element(global_index),
1622 ExcAccessToNonLocalElement(global_index,
1623 partitioner->local_range().first,
1624 partitioner->local_range().second == 0 ?
1626 (partitioner->local_range().second - 1),
1627 partitioner->ghost_indices().n_elements()));
1634 return data.values[partitioner->global_to_local(global_index)];
1639 template <
typename Number,
typename MemorySpace>
1643 return operator()(global_index);
1648 template <
typename Number,
typename MemorySpace>
1652 return operator()(global_index);
1657 template <
typename Number,
typename MemorySpace>
1660 const size_type local_index)
const
1662 Assert((std::is_same_v<MemorySpace, ::MemorySpace::Host>),
1664 "This function is only implemented for the Host memory space"));
1666 partitioner->locally_owned_size() +
1667 partitioner->n_ghost_indices());
1669 Assert(local_index < locally_owned_size() || vector_is_ghosted ==
true,
1670 ExcMessage(
"You tried to read a ghost element of this vector, "
1671 "but it has not imported its ghost values."));
1673 return data.values[local_index];
1678 template <
typename Number,
typename MemorySpace>
1682 Assert((std::is_same_v<MemorySpace, ::MemorySpace::Host>),
1684 "This function is only implemented for the Host memory space"));
1687 partitioner->locally_owned_size() +
1688 partitioner->n_ghost_indices());
1690 return data.values[local_index];
1695 template <
typename Number,
typename MemorySpace>
1699 return data.values.data();
1704 template <
typename Number,
typename MemorySpace>
1705 template <
typename OtherNumber>
1708 const std::vector<size_type> &indices,
1709 std::vector<OtherNumber> &values)
const
1711 for (size_type i = 0; i < indices.size(); ++i)
1712 values[i] =
operator()(indices[i]);
1717 template <
typename Number,
typename MemorySpace>
1718 template <
typename ForwardIterator,
typename OutputIterator>
1721 ForwardIterator indices_begin,
1722 const ForwardIterator indices_end,
1723 OutputIterator values_begin)
const
1725 while (indices_begin != indices_end)
1727 *values_begin = operator()(*indices_begin);
1735 template <
typename Number,
typename MemorySpace>
1736 template <
typename OtherNumber>
1739 const std::vector<size_type> &indices,
1740 const ::Vector<OtherNumber> &values)
1743 for (size_type i = 0; i < indices.size(); ++i)
1748 "The given value is not finite but either infinite or Not A Number (NaN)"));
1749 this->operator()(indices[i]) +=
values(i);
1755 template <
typename Number,
typename MemorySpace>
1756 template <
typename OtherNumber>
1759 const size_type *indices,
1760 const OtherNumber *values)
1762 for (size_type i = 0; i < n_elements; ++i, ++indices, ++
values)
1767 "The given value is not finite but either infinite or Not A Number (NaN)"));
1768 this->operator()(*indices) += *
values;
1774 template <
typename Number,
typename MemorySpace>
1778 return partitioner->get_mpi_communicator();
1783 template <
typename Number,
typename MemorySpace>
1784 inline const std::shared_ptr<const Utilities::MPI::Partitioner> &
1792 template <
typename Number,
typename MemorySpace>
1796 vector_is_ghosted = ghosted;
1812template <
typename Number,
typename MemorySpace>
1824template <
typename Number,
typename MemorySpace>
1833 namespace LinearOperatorImplementation
1842 template <
typename Number>
1848 template <
typename T>
1850 decltype(std::declval<T>().get_mpi_communicator());
1852 template <
typename T>
1858 template <
typename T>
1860 decltype(std::declval<T>().locally_owned_domain_indices());
1862 template <
typename T>
1868 template <
typename T>
1870 decltype(std::declval<T>().locally_owned_range_indices());
1872 template <
typename T>
1878 template <
typename T>
1880 decltype(std::declval<T>().initialize_dof_vector(
1883 template <
typename T>
1888 template <
typename MatrixType,
1889#if !defined(__INTEL_COMPILER) || __INTEL_COMPILER >= 1900
1890 std::enable_if_t<has_get_mpi_communicator<MatrixType> &&
1899 MatrixType> * =
nullptr>
1905 vec.
reinit(mat.locally_owned_domain_indices(),
1906 mat.get_mpi_communicator());
1910 template <
typename MatrixType,
1911#if !defined(__INTEL_COMPILER) || __INTEL_COMPILER >= 1900
1912 std::enable_if_t<has_initialize_dof_vector<MatrixType>,
1918 MatrixType> * =
nullptr>
1922 bool omit_zeroing_entries)
1924 mat.initialize_dof_vector(vec);
1925 if (!omit_zeroing_entries)
1930 template <
typename MatrixType,
1931#if !defined(__INTEL_COMPILER) || __INTEL_COMPILER >= 1900
1932 std::enable_if_t<has_get_mpi_communicator<MatrixType> &&
1933 has_locally_owned_range_indices<MatrixType>,
1941 MatrixType> * =
nullptr>
1947 vec.
reinit(mat.locally_owned_range_indices(),
1948 mat.get_mpi_communicator());
1952 template <
typename MatrixType,
1953#if !defined(__INTEL_COMPILER) || __INTEL_COMPILER >= 1900
1954 std::enable_if_t<has_initialize_dof_vector<MatrixType>,
1960 MatrixType> * =
nullptr>
1964 bool omit_zeroing_entries)
1966 mat.initialize_dof_vector(vec);
1967 if (!omit_zeroing_entries)
Number & operator()(const size_type global_index)
void zero_out_ghost_values() const
void assert_no_residual_content_in_ghost_region() const
real_type linfty_norm() const
Number mean_value_local() const
virtual void extract_subvector_to(const ArrayView< const types::global_dof_index > &indices, const ArrayView< Number > &elements) const override
bool partitioners_are_compatible(const Utilities::MPI::Partitioner &part) const
void sadd(const Number s, const Number a, const Vector< Number, MemorySpace > &V)
bool has_ghost_elements() const
const value_type & const_reference
Number local_element(const size_type local_index) const
void reinit(const IndexSet &local_range, const MPI_Comm communicator)
Number add_and_dot_local(const Number a, const Vector< Number, MemorySpace > &V, const Vector< Number, MemorySpace > &W)
Number mean_value() const
real_type linfty_norm_local() const
void compress_finish(VectorOperation::values operation)
Number * get_values() const
void update_ghost_values() const
mutable ::MemorySpace::MemorySpaceData< Number, MemorySpace > import_data
real_type l1_norm_local() const
mutable ::MemorySpace::MemorySpaceData< Number, MemorySpace > data
void equ(const Number a, const Vector< Number, MemorySpace > &V)
types::global_dof_index size_type
Vector< Number, MemorySpace > & operator=(Vector< Number, MemorySpace > &&in_vector)
void sadd_local(const Number s, const Number a, const Vector< Number, MemorySpace > &V)
typename numbers::NumberTraits< Number >::real_type real_type
const_iterator end() const
Vector(const IndexSet &local_range, const MPI_Comm communicator)
Vector(const size_type size)
Vector(Vector< Number, MemorySpace > &&in_vector)
size_type locally_owned_size() const
void reinit(const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner, const MPI_Comm comm_sm=MPI_COMM_SELF)
std::shared_ptr< const Utilities::MPI::Partitioner > partitioner
void add(const size_type n_elements, const size_type *indices, const OtherNumber *values)
void sadd(const Number s, const Vector< Number, MemorySpace > &V)
Vector< Number, MemorySpace > & operator=(const Vector< Number, MemorySpace > &in_vector)
real_type norm_sqr_local() const
void reinit(const IndexSet &local_range, const IndexSet &ghost_indices, const MPI_Comm communicator)
void swap(Vector< Number, MemorySpace > &v) noexcept
const value_type * const_iterator
void clear_mpi_requests()
Number operator[](const size_type global_index) const
Vector(const Vector< Number, MemorySpace > &in_vector)
void add(const Number a, const Vector< Number, MemorySpace > &V)
void set_ghost_state(const bool ghosted) const
void add(const std::vector< size_type > &indices, const std::vector< Number > &values)
::IndexSet locally_owned_elements() const
real_type l2_norm() const
void compress(VectorOperation::values operation)
Vector(const IndexSet &local_range, const IndexSet &ghost_indices, const MPI_Comm communicator)
Vector< Number, MemorySpace > & operator*=(const Number factor)
Vector< Number, MemorySpace > & operator+=(const Vector< Number, MemorySpace > &V)
void add(const std::vector< size_type > &indices, const ::Vector< OtherNumber > &values)
void import_elements(const Vector< Number, MemorySpace2 > &src, VectorOperation::values operation)
Number & operator[](const size_type global_index)
void add(const Number a, const Vector< Number, MemorySpace > &V, const Number b, const Vector< Number, MemorySpace > &W)
const value_type * const_pointer
void reinit(const Vector< Number2, MemorySpace > &in_vector, const bool omit_zeroing_entries=false)
real_type lp_norm(const real_type p) const
bool partitioners_are_globally_compatible(const Utilities::MPI::Partitioner &part) const
const std::shared_ptr< const Utilities::MPI::Partitioner > & get_partitioner() const
virtual size_type size() const override
std::shared_ptr<::parallel::internal::TBBPartitioner > thread_loop_partitioner
Number add_and_dot(const Number a, const Vector< Number, MemorySpace > &V, const Vector< Number, MemorySpace > &W)
std::size_t memory_consumption() const
void update_ghost_values_finish() const
const std::vector< ArrayView< const Number > > & shared_vector_data() const
void update_ghost_values_start(const unsigned int communication_channel=0) const
void import_elements(const LinearAlgebra::ReadWriteVector< Number > &V, const VectorOperation::values operation, const std::shared_ptr< const Utilities::MPI::CommunicationPatternBase > &communication_pattern={})
void copy_locally_owned_data_from(const Vector< Number2, MemorySpace > &src)
Vector< Number, MemorySpace > & operator=(const Vector< Number2, MemorySpace > &in_vector)
Vector< Number, MemorySpace > & operator=(const Number s)
Number operator()(const size_type global_index) const
real_type lp_norm_local(const real_type p) const
Vector< Number, MemorySpace > & operator-=(const Vector< Number, MemorySpace > &V)
void print(std::ostream &out, const unsigned int precision=3, const bool scientific=true, const bool across=true) const
void reinit(const size_type size, const bool omit_zeroing_entries=false)
MPI_Comm get_mpi_communicator() const
void extract_subvector_to(const std::vector< size_type > &indices, std::vector< OtherNumber > &values) const
void compress_start(const unsigned int communication_channel=0, VectorOperation::values operation=VectorOperation::add)
std::vector< MPI_Request > update_ghost_values_requests
void scale(const Vector< Number, MemorySpace > &scaling_factors)
const_iterator begin() const
std::vector< MPI_Request > compress_requests
void add_local(const Number a, const Vector< Number, MemorySpace > &V)
Number operator*(const Vector< Number, MemorySpace > &V) const
bool in_local_range(const size_type global_index) const
Vector< Number, MemorySpace > & operator/=(const Number factor)
void extract_subvector_to(ForwardIterator indices_begin, const ForwardIterator indices_end, OutputIterator values_begin) const
Number inner_product_local(const Vector< Number2, MemorySpace > &V) const
Number & local_element(const size_type local_index)
void reinit(const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner, const bool make_ghosted, const MPI_Comm &comm_sm=MPI_COMM_SELF)
real_type norm_sqr() const
real_type l1_norm() const
void resize_val(const size_type new_allocated_size, const MPI_Comm comm_sm=MPI_COMM_SELF)
void reinit(const types::global_dof_index local_size, const types::global_dof_index ghost_size, const MPI_Comm comm, const MPI_Comm comm_sm=MPI_COMM_SELF)
Vector(const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner)
types::global_dof_index size_type
void swap(LinearAlgebra::distributed::Vector< Number, MemorySpace > &u, LinearAlgebra::distributed::Vector< Number, MemorySpace > &v) noexcept
decltype(std::declval< T >().locally_owned_range_indices()) locally_owned_range_indices_t
static void reinit_range_vector(MatrixType &mat, LinearAlgebra::distributed::Vector< Number > &vec, bool)
decltype(std::declval< T >().locally_owned_domain_indices()) locally_owned_domain_indices_t
static void reinit_range_vector(MatrixType &mat, LinearAlgebra::distributed::Vector< Number > &vec, bool omit_zeroing_entries)
decltype(std::declval< T >().initialize_dof_vector( std::declval< LinearAlgebra::distributed::Vector< Number > & >())) initialize_dof_vector_t
static void reinit_domain_vector(MatrixType &mat, LinearAlgebra::distributed::Vector< Number > &vec, bool omit_zeroing_entries)
decltype(std::declval< T >().get_mpi_communicator()) get_mpi_communicator_t
static constexpr bool has_get_mpi_communicator
static constexpr bool has_locally_owned_domain_indices
static constexpr bool has_initialize_dof_vector
static void reinit_domain_vector(MatrixType &mat, LinearAlgebra::distributed::Vector< Number > &vec, bool)
static constexpr bool has_locally_owned_range_indices
#define DEAL_II_DEPRECATED
#define DEAL_II_NAMESPACE_OPEN
#define DEAL_II_DISABLE_EXTRA_DIAGNOSTICS
#define DEAL_II_NAMESPACE_CLOSE
#define DEAL_II_ENABLE_EXTRA_DIAGNOSTICS
static ::ExceptionBase & ExcAccessToNonLocalElement(size_type arg1, size_type arg2, size_type arg3, size_type arg4)
#define DeclException0(Exception0)
#define DeclException4(Exception4, type1, type2, type3, type4, outsequence)
static ::ExceptionBase & ExcVectorTypeNotCompatible()
static ::ExceptionBase & ExcNonMatchingElements(Number arg1, Number arg2, unsigned int arg3)
#define Assert(cond, exc)
#define AssertDimension(dim1, dim2)
#define AssertIndexRange(index, range)
#define DeclException3(Exception3, type1, type2, type3, outsequence)
static ::ExceptionBase & ExcMessage(std::string arg1)
constexpr bool is_supported_operation
bool is_finite(const double x)
unsigned int global_dof_index
*braid_SplitCommworld & comm