]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add a conceptual note on usage of PETScWrappers::VectorBase. 4279/head
authorDavid Wells <wellsd2@rpi.edu>
Sat, 29 Apr 2017 17:18:43 +0000 (13:18 -0400)
committerDavid Wells <wellsd2@rpi.edu>
Thu, 4 May 2017 01:45:42 +0000 (21:45 -0400)
include/deal.II/lac/petsc_vector_base.h

index e52dd26678e06861be0d04c5791b41383b5e7e76..5039e4e2ec48da77bb296bcfcc981ef7c8a0705c 100644 (file)
@@ -209,8 +209,10 @@ namespace PETScWrappers
    * parallel ones) are built by filling the contents of an abstract object
    * that is only referenced through a pointer of a type that is independent
    * of the actual vector type, we can implement almost all functionality of
-   * vectors in this base class. Derived classes will then only have to
-   * provide the functionality to create one or the other kind of vector.
+   * vectors in this base class. As such, this class can also be used as a
+   * deal.II-compatible wrapper for a PETSc <code>Vec</code> object of any
+   * type. Derived classes will then only have to provide the functionality to
+   * create one or the other kind of vector.
    *
    * The interface of this class is modeled after the existing Vector class in
    * deal.II. It has almost the same member functions, and is often

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.