From d5739bc30ab0bd523d365d35e994fe993bc0cb34 Mon Sep 17 00:00:00 2001 From: Matthias Maier Date: Thu, 4 Feb 2021 14:48:26 -0600 Subject: [PATCH] Documentation: Advertise Let's add some pointers to linear_operator_tools.h for the reader. Maybe this helps to clarify the situation. --- doc/doxygen/headers/laoperators.h | 13 ++++++++++++- include/deal.II/lac/linear_operator.h | 11 +++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/doc/doxygen/headers/laoperators.h b/doc/doxygen/headers/laoperators.h index 0e09e31a0b..d88a81437b 100644 --- a/doc/doxygen/headers/laoperators.h +++ b/doc/doxygen/headers/laoperators.h @@ -44,6 +44,8 @@ * LinearOperator op that performs above computation when * applied on a vector, one can write: * @code + * #include + * * dealii::SparseMatrix A, B, C; * double k; * // Setup and assembly... @@ -116,6 +118,8 @@ * * As an example consider the addition of multiple vectors: * @code + * #include + * * dealii::Vector a, b, c, d; * // .. * dealii::Vector result = a + b - c + d; @@ -178,9 +182,16 @@ * Vector residual = b - op_a * x; // computes the residual at this point * @endcode * - * The step-20 tutorial program has a detailed usage example of the + * @note The step-20 tutorial program has a detailed usage example of the * PackagedOperation class. * + * @note Many use cases of LinearOperator lead to intermediate expressions + * requiring a PackagedOperation. In order to include all necessary header + * files in one go consider using + * @code + * #include + * @endcode + * * * @ingroup LAC * @ingroup MATRICES diff --git a/include/deal.II/lac/linear_operator.h b/include/deal.II/lac/linear_operator.h index 726ac02564..8e45ec6684 100644 --- a/include/deal.II/lac/linear_operator.h +++ b/include/deal.II/lac/linear_operator.h @@ -113,6 +113,8 @@ identity_operator(const LinearOperator &); * one can write: * * @code + * #include + * * dealii::SparseMatrix A, B, C; * const double k = ...; * @@ -154,6 +156,15 @@ identity_operator(const LinearOperator &); * an interface that produces the result of this composite operation that is * compatible with Trilinos operator used by Trilinos solvers. * + * @note Many use cases of LinearOperator lead to intermediate expressions + * requiring a PackagedOperation. In order to include all necessary header + * files in one go consider using + * @code + * #include + * @endcode + * + * In order to use the full LinearOperator and PackagedOperation + * * @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. -- 2.39.5