]> https://gitweb.dealii.org/ - dealii.git/commit
step-9: Improve the documentation and typography.
authorDavid Wells <drwells@email.unc.edu>
Sun, 15 Jul 2018 16:45:34 +0000 (12:45 -0400)
committerDavid Wells <drwells@email.unc.edu>
Fri, 3 Aug 2018 02:39:05 +0000 (22:39 -0400)
commit7a1cb4ea6d19cc7f24253373f5cd05bba04d9300
treea14ab6df409aff30c5eb269bcf1c448564f4da61
parenta4700f3cae6e69111bf1b1d607b1774e979660ff
step-9: Improve the documentation and typography.

1. Remove an inaccurate remark on SUPG: The gradient of test functions scales
   like 1/h, so scaling it by h makes the term O(1), not O(h).
2. General improvements: Reword some sentences and fix some typos.
3. Remark on the choice of diffusion coefficient.
4. Notate floating point numbers as, e.g., '0.'.
5. Clarify text on TensorFunction. AFAIK this class never returned anything but
   Tensors so this documentation was incorrect.
6. Use face_n instead of face or face_no to indicate the face number.
7. Move the Tensor projected_gradient closer to where it is actually used and
   remove a remark about allocating it.
8. Mark an unchanged Tensor (gradient) as const.
9. Prefer p.norm() to std::sqrt(p.norm_square()).
10. Add 'using namespace dealii;' to improve the doxygen result. Since we strip
   all preceding dealii namespace qualifiers this prevents doxygen from writing

       ::MultithreadInfo::set_thread_limit();

   which looks odd.
11. Clarify that Assert aborts (it does not terminate).
examples/step-9/doc/intro.dox
examples/step-9/step-9.cc

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.