]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix some LinearOperator typos.
authorDavid Wells <wellsd2@rpi.edu>
Sat, 28 Oct 2017 21:35:25 +0000 (17:35 -0400)
committerDavid Wells <wellsd2@rpi.edu>
Sun, 29 Oct 2017 19:29:12 +0000 (15:29 -0400)
include/deal.II/lac/block_linear_operator.h
include/deal.II/lac/linear_operator.h

index b3a67fee9468d79fab39a0d8c7bc81cf2fef6ddd..ccb43b12a2f3ce4004230016d651404bc9d24f52 100644 (file)
@@ -123,12 +123,12 @@ block_back_substitution(const BlockLinearOperator<Range, Domain, BlockPayload> &
  * @endcode
  *
  * A BlockLinearOperator can be sliced to a LinearOperator at any time. This
- * removes all information about the underlying block structure (beacuse above
+ * removes all information about the underlying block structure (because above
  * <code>std::function</code> objects are no longer available) - the linear
  * operator interface, however, remains intact.
  *
  * @note This class makes heavy use of <code>std::function</code> objects and
- * lambda functions. This flexibiliy comes with a run-time penalty. Only use
+ * lambda functions. This flexibility comes with a run-time penalty. Only use
  * this object to encapsulate object with medium to large individual block
  * sizes, and small block structure (as a rule of thumb, matrix blocks greater
  * than $1000\times1000$).
@@ -378,9 +378,9 @@ namespace internal
      * subblocks.
      *
      * This is the Payload class typically associated with deal.II's native
-     * BlockSparseMatrix. To use Trilinos and PETSc BlockSparseMatrices it is
-     * necessary to initialize a BlockLinearOperator with their associated
-     * BlockPayload.
+     * BlockSparseMatrix. To use either TrilinosWrappers::BlockSparseMatrix or
+     * PETScWrappers::BlockSparseMatrix one must initialize a
+     * BlockLinearOperator with their associated BlockPayload.
      *
      * @author Jean-Paul Pelteret, Matthias Maier, 2016
      *
@@ -472,7 +472,7 @@ block_operator(const BlockMatrixType &block_matrix)
  *
  * A variant of above function that encapsulates a given collection @p ops of
  * LinearOperators into a block structure. Here, it is assumed that Range and
- * Domain are blockvectors, i.e., derived from
+ * Domain are block vectors, i.e., derived from
  * @ref BlockVectorBase.
  * The individual linear operators in @p ops must act on the underlying vector
  * type of the block vectors, i.e., on Domain::BlockType yielding a result in
index a897d037dcf323df4f47ffef08225e89ec514cc3..48a10c819227da7eb94c452b83d41842b2c1fb6d 100644 (file)
@@ -140,7 +140,7 @@ null_operator(const LinearOperator<Range, Domain, Payload> &);
  *
  * @note To ensure that the correct payload is provided, wrapper functions
  * for linear operators have been provided within the respective
- * TrilinosWrappers (and, in the future, PetscWrappers) namespaces.
+ * TrilinosWrappers (and, in the future, PETScWrappers) namespaces.
  *
  * @author Luca Heltai, Matthias Maier, 2015; Jean-Paul Pelteret, 2016
  *
@@ -782,7 +782,7 @@ identity_operator(const std::function<void(Range &, bool)> &reinit_vector)
  * Return a LinearOperator that is the identity of the vector space @p Range.
  *
  * The function takes a LinearOperator @p op and uses its range initializer
- * to create an identiy operator. In contrast to the function above, this
+ * to create an identity operator. In contrast to the function above, this
  * function also ensures that the underlying Payload matches that of the
  * input @p op.
  *
@@ -913,8 +913,8 @@ namespace internal
      * facilitate the operations of the matrix.
      *
      * This is the Payload class typically associated with deal.II's native
-     * SparseMatrix. To use Trilinos and PETSc SparseMatrices it is necessary
-     * to initialize a LinearOperator with their associated Payload.
+     * SparseMatrix. To use Trilinos and PETSc sparse matrix classes it is
+     * necessary to initialize a LinearOperator with their associated Payload.
      *
      * @author Jean-Paul Pelteret, Matthias Maier, 2016
      *

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.