From: heister Date: Mon, 17 Jun 2013 03:06:27 +0000 (+0000) Subject: documentation improvements (thanks Oleh Krehel) X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=41b8cc6ea3c1daff4475716c5111bedd30f8b207;p=dealii-svn.git documentation improvements (thanks Oleh Krehel) git-svn-id: https://svn.dealii.org/trunk@29833 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/examples/step-3/doc/results.dox b/deal.II/examples/step-3/doc/results.dox index 4f8b502688..c5d2e96c05 100644 --- a/deal.II/examples/step-3/doc/results.dox +++ b/deal.II/examples/step-3/doc/results.dox @@ -187,7 +187,7 @@ suggestions: LaplaceProblem::LaplaceProblem.
  • Convergence of the mean: A different way to see that the solution - actually converges (to something &mdash we can't tell whether it's really + actually converges (to something — we can't tell whether it's really the correct value!) is to compute the mean of the solution. To this end, add the following code to LaplaceProblem::output_results: @code diff --git a/deal.II/examples/step-3/step-3.cc b/deal.II/examples/step-3/step-3.cc index ce7a9305fa..2585c561fe 100644 --- a/deal.II/examples/step-3/step-3.cc +++ b/deal.II/examples/step-3/step-3.cc @@ -265,7 +265,7 @@ void Step3::assemble_system () // mentioned, we use the implied Q1 mapping, rather than specifying one // ourselves explicitly. Finally, we have to tell it what we want it to // compute on each cell: we need the values of the shape functions at the - // quadrature points (for the right hand side $(\varphi,f)$), their + // quadrature points (for the right hand side $(\varphi_i,f)$), their // gradients (for the matrix entries $(\nabla \varphi_i, \nabla // \varphi_j)$), and also the weights of the quadrature points and the // determinants of the Jacobian transformations from the reference cell to @@ -286,12 +286,12 @@ void Step3::assemble_system () update_values | update_gradients | update_JxW_values); // The advantage of this approach is that we can specify what kind of // information we actually need on each cell. It is easily understandable - // that this approach can significant speed up finite element computations, + // that this approach can significantly speed up finite element computations, // compared to approaches where everything, including second derivatives, - // normal vectors to cells, etc are computed on each cell, regardless + // normal vectors to cells, etc are computed on each cell, regardless of // whether they are needed or not. - // For use further down below, we define two short cuts for values that will + // For use further down below, we define two shortcuts for values that will // be used very frequently. First, an abbreviation for the number of degrees // of freedom on each cell (since we are in 2D and degrees of freedom are // associated with vertices only, this number is four, but we rather want to @@ -302,7 +302,7 @@ void Step3::assemble_system () // // Secondly, we also define an abbreviation for the number of quadrature // points (here that should be four). In general, it is a good idea to use - // their symbolic names instead of hard-coding these number even if you know + // their symbolic names instead of hard-coding these numbers even if you know // them, since you may want to change the quadrature formula and/or finite // element at some time; the program will just work with these changes, // without the need to change anything in this function.