]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Improve LinearAlgebra::parallel::Vector documentation 15014/head
authorDaniel Arndt <arndtd@ornl.gov>
Mon, 3 Apr 2023 20:43:56 +0000 (16:43 -0400)
committerDaniel Arndt <arndtd@ornl.gov>
Mon, 3 Apr 2023 20:43:56 +0000 (16:43 -0400)
include/deal.II/lac/la_parallel_vector.h

index cb2d74d36c23136b9f766c6c3a1a9eed5a5cb54d..afd9a24bcdf34fffad98cd3376670bcfc3f7c5d2 100644 (file)
@@ -188,14 +188,13 @@ namespace LinearAlgebra
      * <h4>GPU support</h4>
      *
      * This vector class supports two different memory spaces: Host and Default.
-     * By default, the memory space is Host and all the data is allocated on the
-     * CPU. When the memory space is Default, all the data is allocated on
-     * Kokkos' default memory space. That means that if Kokkos was configured
-     * with a GPU backend, the data is allocated on a GPU. The operations on the
-     * vector are performed on the chosen memory space. From the host, there are
-     * two methods to access the elements of the Vector when using the Default
-     * memory space:
-     * <ul>
+     * If the MemorySpace template argument is not specified, the memory space
+     * is Host and all the data is allocated on the CPU. When the memory space
+     * is Default, all the data is allocated on Kokkos' default memory space.
+     * That means that if Kokkos was configured with a GPU backend, the data is
+     * allocated on a GPU. The operations on the vector are performed on the
+     * chosen memory space. From the host, there are two methods to access the
+     * elements of the Vector when using the Default memory space: <ul>
      * <li> use get_values():
      * @code
      * Vector<double, MemorySpace::Default> vector(local_range, comm);

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.