]> https://gitweb.dealii.org/ - dealii.git/commitdiff
tutorials: add keywords
authorTimo Heister <timo.heister@gmail.com>
Mon, 6 May 2019 22:05:09 +0000 (18:05 -0400)
committerTimo Heister <timo.heister@gmail.com>
Mon, 6 May 2019 22:05:09 +0000 (18:05 -0400)
I am often searching on the tutorial overview page in the browser. It is
helpful to have additional keywords available to know where a feature is
used/introduced. Right now I am only adding this for the first few steps
(and only class/function names).

I can follow up on this later for the other tutorials if we agree this
makes sense.

doc/doxygen/tutorial/tutorial.h.in

index a3a187f2faa6e11abb24b50752eadeb06729b4f5..d74594e023a408ed61874bc9e5482956bdcb309f 100644 (file)
@@ -86,6 +86,7 @@
  *   <tr valign="top">
  *       <td width="100px">step-1</td>
  *       <td> Creating a grid. A simple way to write it to a file.
+ *       <br/> keywords: Triangulation, GridGenerator::hyper_cube, GridGenerator::hyper_shell, GridOut, Triangulation::execute_coarsening_and_refinement
  *       </td></tr>
  *
  *   <tr valign="top">
@@ -95,6 +96,7 @@
  *       matrices. Show that renumbering reduces the bandwidth of
  *       matrices significantly, i.e. clusters nonzero entries around the
  *       diagonal.
+ *       <br/> keywords: FE_Q, DynamicSparsityPattern, DoFTools::make_sparsity_pattern, DoFHandler::distribute_dofs, DoFRenumbering, SparsityPattern
  *       </td></tr>
  *
  *   <tr valign="top">
  *       <td> Actually solve Laplace's
  *       problem. Object-orientation. Assembling matrices and
  *       vectors. Boundary values.
+ *       <br/> keywords: FEValues, VectorTools::interpolate_boundary_values, MatrixTools::apply_boundary_values, SolverCG, Vector<double>, SparseMatrix<double>, DataOut
  *       </td></tr>
  *
  *   <tr valign="top">
  *       solve Laplace's equation; we will solve the equation in 2D and
  *       3D, although the program is exactly the same. Non-constant right
  *       hand side function. Non-homogeneous boundary values.
+ *       <br/> keywords: VectorTools::point_value, VectorTools::compute_mean_value
  *       </td></tr>
  *
  *   <tr valign="top">
  *       the elliptic operator (yielding the extended Poisson
  *       equation). Preconditioning the CG solver for the
  *       linear system of equations.
+ *       <br/> keywords: PreconditionSSOR, GridIn, SphericalManifold
  *       </td></tr>
  *
  *   <tr valign="top">
  *       <td> Adaptive local
  *       refinement. Handling of hanging nodes. Higher order elements.
  *       Catching exceptions in the <code>main</code>; function.
+ *       <br/> keywords: DoFTools::make_hanging_node_constraints, AffineConstraints::distribute_local_to_global,  KellyErrorEstimator, GridRefinement::refine_and_coarsen_fixed_number
  *       </td></tr>
  *
  *   <tr valign="top">
  *       boundary integrals. Verification of correctness of computed
  *       solutions. Computing the error between exact and numerical
  *       solution and output of the data in tables. Using counted pointers.
+ *       <br/> keywords: FEFaceValues, VectorTools::integrate_difference,  VectorTools::compute_global_error, TableHandler
  *       </td></tr>
  *
  *   <tr valign="top">
  *       solved instead of Laplace's equation. The solution is
  *       vector-valued and the equations form a system with as many
  *       equations as the dimension of the space in which it is posed.
+ *       <br/> keywords: FESystem
  *       </td></tr>
  *
  *   <tr valign="top">
  *       the system of equations in parallel using multi-threading,
  *       implementing a refinement criterion based on a finite difference
  *       approximation of the gradient.
+ *       <br/> keywords: TensorFunction, WorkStream::run, SolverGMRES
+ *       </td></tr>
  *
  *   <tr valign="top">
  *       <td>step-10</td>
  *
  *   <tr valign="top">
  *       <td>step-27</td>
- *       <td> hp finite element methods  </td></tr>
+ *       <td> The hp finite element method.
+ *       </td></tr>
  *
  *   <tr valign="top">
  *       <td>step-28</td>
  *       <td> Multiple grids for solving a multigroup diffusion equation
- *       in nuclear physics simulating a nuclear reactor core  </td></tr>
+ *       in nuclear physics simulating a nuclear reactor core.
+ *       </td></tr>
  *
  *   <tr valign="top">
  *       <td>step-29</td>
  *       <td> Solving a Poisson problem discretized with an interior penalty DG
  *       method and a multilevel preconditioner in a matrix-free fashion using
  *       a massively parallel implementation.
+ *       </td></tr>
  *
  *   <tr valign="top">
  *       <td>step-60</td>

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.