]> https://gitweb.dealii.org/ - dealii.git/commitdiff
document LA and distributed namespaces
authorTimo Heister <timo.heister@gmail.com>
Thu, 13 Sep 2018 01:41:06 +0000 (21:41 -0400)
committerTimo Heister <timo.heister@gmail.com>
Thu, 13 Sep 2018 01:46:39 +0000 (21:46 -0400)
otherwise they are not clickable in doxygen

include/deal.II/lac/la_parallel_vector.h
include/deal.II/lac/la_vector.h
include/deal.II/lac/trilinos_epetra_vector.h

index b7ea75208542a157c697f7c86d77beb5968f1b1d..af8f759df8fd82b149f5390ac8e6887aa09eb392 100644 (file)
@@ -35,6 +35,9 @@ DEAL_II_NAMESPACE_OPEN
 
 namespace LinearAlgebra
 {
+  /**
+   * A namespace for parallel implementations of vectors.
+   */
   namespace distributed
   {
     template <typename>
index c5299acb4b8bb86a258cd17cc152d9437255eb39..be07fcaa1055aba2b5615aab73184f8ea2d43912 100644 (file)
 
 DEAL_II_NAMESPACE_OPEN
 
+/**
+ * A namespace for vector classes.
+ *
+ * This namespace contains various classes that provide wrappers to vector
+ * classes from different external libraries like Trilinos (EPetra) or PETSc
+ * and native implementations like LinearAlgebra::distributed::Vector.
+ *
+ * The different vector classes are derived from VectorSpaceVector to provide
+ * a joint interface for vector space operations, are derived from
+ * ReadWriteVector (or ReadWriteVector itself), or both. The separation of
+ * vector space operations (like norms or vector additions) through
+ * VectorSpaceVector and element access through ReadWriteVector are by design
+ * and improve performance.
+ */
 namespace LinearAlgebra
 {
   /*! @addtogroup Vectors
index b6a4bfd5c4cd5927c5371e124c630f0082ba7b5f..5e8ab4358c35077f350d5632d02a1f08f472be38 100644 (file)
@@ -42,6 +42,9 @@ namespace LinearAlgebra
   template <typename Number>
   class ReadWriteVector;
 
+  /**
+   * A namespace for classes that provide wrappers for Epetra from Trilinos.
+   */
   namespace EpetraWrappers
   {
     /**

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.