From: Matthias Maier Date: Sun, 26 Apr 2015 12:06:05 +0000 (+0200) Subject: Update documentation X-Git-Tag: v8.3.0-rc1~208^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1bb15adc69191daf18eaf6854fde2eecb249470c;p=dealii.git Update documentation --- diff --git a/doc/doxygen/headers/laoperators.h b/doc/doxygen/headers/laoperators.h index 85b8176087..049035160f 100644 --- a/doc/doxygen/headers/laoperators.h +++ b/doc/doxygen/headers/laoperators.h @@ -46,8 +46,8 @@ * applied on a vector, one can write: * @code * dealii::SparseMatrix A, B, C; + * double k; * // Setup and assembly... - * const double k = ...; * * const auto op_a = linear_operator(A); * const auto op_b = linear_operator(B); @@ -65,7 +65,26 @@ * * For objects of type LinearOperator, all vector space operations, i.e., * addition and subtraction, scalar multiplication and composition (of - * compatible linear operators) are implemented. + * compatible linear operators) are implemented: + * @code + * dealii::LinearOperator op_a, op_b; + * double k; + * + * // vector space addition, subtraction and scalar multiplication + * op_a + op_b; + * op_a - op_b; + * k * op_a; + * op_a * k; + * + * // in-place variants + * op_a += op_b; + * op_a -= op_b; + * op_a *= k; + * + * // operator composition + * op_a * op_b; + * op_a *= op_b; // If op_b is an endomorphism of the domain space of op_a + * @endcode * * block_operator() and block_diagonal_operator() provide further * encapsulation of individual linear operators into blocked linear diff --git a/include/deal.II/lac/linear_operator.h b/include/deal.II/lac/linear_operator.h index 0366e35205..bc7bf3b04a 100644 --- a/include/deal.II/lac/linear_operator.h +++ b/include/deal.II/lac/linear_operator.h @@ -248,8 +248,8 @@ public: } /** - * Concatenation of the LinearOperator with an endomorphism @p second_op - * on the @p Domain space. + * Composition of the LinearOperator with an endomorphism @p second_op + * of the @p Domain space. */ LinearOperator & operator*=(const LinearOperator &second_op) @@ -276,8 +276,8 @@ public: /** * \relates LinearOperator * - * Addition of two linear operators @p first_op and @p second_op given - * by $(\text{first\_op}+\text{second\_op})x:=\text{first\_op}(x)+\text{second\_op}(x)$ + * Addition of two linear operators @p first_op and @p second_op given by + * $(\text{first\_op}+\text{second\_op})x:=\text{first\_op}(x)+\text{second\_op}(x)$ * * @ingroup LAOperators */ @@ -325,8 +325,8 @@ operator+(const LinearOperator &first_op, /** * \relates LinearOperator * - * Subtraction of two linear operators @p first_op and @p second_op given - * by $(\text{first\_op}-\text{second\_op})x:=\text{first\_op}(x)-\text{second\_op}(x)$ + * Subtraction of two linear operators @p first_op and @p second_op given by + * $(\text{first\_op}-\text{second\_op})x:=\text{first\_op}(x)-\text{second\_op}(x)$ * * @ingroup LAOperators */ @@ -343,8 +343,8 @@ operator-(const LinearOperator &first_op, /** * \relates LinearOperator * - * Concatenation of two linear operators @p first_op and @p second_op given - * by $(\text{first\_op}*\text{second\_op})x:=\text{first\_op}(\text{second\_op}(x))$ + * Composition of two linear operators @p first_op and @p second_op given by + * $(\text{first\_op}*\text{second\_op})x:=\text{first\_op}(\text{second\_op}(x))$ * * @ingroup LAOperators */ diff --git a/include/deal.II/lac/pointer_matrix.h b/include/deal.II/lac/pointer_matrix.h index c95f3f4c7e..e05cb07bf1 100644 --- a/include/deal.II/lac/pointer_matrix.h +++ b/include/deal.II/lac/pointer_matrix.h @@ -1,6 +1,6 @@ // --------------------------------------------------------------------- // -// Copyright (C) 2002 - 2014 by the deal.II authors +// Copyright (C) 2002 - 2015 by the deal.II authors // // This file is part of the deal.II library. // diff --git a/include/deal.II/lac/schur_matrix.h b/include/deal.II/lac/schur_matrix.h index c780595614..01201eb300 100644 --- a/include/deal.II/lac/schur_matrix.h +++ b/include/deal.II/lac/schur_matrix.h @@ -1,6 +1,6 @@ // --------------------------------------------------------------------- // -// Copyright (C) 2001 - 2014 by the deal.II authors +// Copyright (C) 2001 - 2015 by the deal.II authors // // This file is part of the deal.II library. //