From 60a7f3825997b3c159128cb28e83c2bf4885e77d Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Mon, 6 May 2019 18:05:09 -0400 Subject: [PATCH] tutorials: add keywords 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 | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/doc/doxygen/tutorial/tutorial.h.in b/doc/doxygen/tutorial/tutorial.h.in index a3a187f2fa..d74594e023 100644 --- a/doc/doxygen/tutorial/tutorial.h.in +++ b/doc/doxygen/tutorial/tutorial.h.in @@ -86,6 +86,7 @@ * * step-1 * Creating a grid. A simple way to write it to a file. + *
keywords: Triangulation, GridGenerator::hyper_cube, GridGenerator::hyper_shell, GridOut, Triangulation::execute_coarsening_and_refinement * * * @@ -95,6 +96,7 @@ * matrices. Show that renumbering reduces the bandwidth of * matrices significantly, i.e. clusters nonzero entries around the * diagonal. + *
keywords: FE_Q, DynamicSparsityPattern, DoFTools::make_sparsity_pattern, DoFHandler::distribute_dofs, DoFRenumbering, SparsityPattern * * * @@ -102,6 +104,7 @@ * Actually solve Laplace's * problem. Object-orientation. Assembling matrices and * vectors. Boundary values. + *
keywords: FEValues, VectorTools::interpolate_boundary_values, MatrixTools::apply_boundary_values, SolverCG, Vector, SparseMatrix, DataOut * * * @@ -111,6 +114,7 @@ * 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. + *
keywords: VectorTools::point_value, VectorTools::compute_mean_value * * * @@ -121,6 +125,7 @@ * the elliptic operator (yielding the extended Poisson * equation). Preconditioning the CG solver for the * linear system of equations. + *
keywords: PreconditionSSOR, GridIn, SphericalManifold * * * @@ -128,6 +133,7 @@ * Adaptive local * refinement. Handling of hanging nodes. Higher order elements. * Catching exceptions in the main; function. + *
keywords: DoFTools::make_hanging_node_constraints, AffineConstraints::distribute_local_to_global, KellyErrorEstimator, GridRefinement::refine_and_coarsen_fixed_number * * * @@ -137,6 +143,7 @@ * 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. + *
keywords: FEFaceValues, VectorTools::integrate_difference, VectorTools::compute_global_error, TableHandler * * * @@ -145,6 +152,7 @@ * 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. + *
keywords: FESystem * * * @@ -153,6 +161,8 @@ * the system of equations in parallel using multi-threading, * implementing a refinement criterion based on a finite difference * approximation of the gradient. + *
keywords: TensorFunction, WorkStream::run, SolverGMRES + * * * * step-10 @@ -270,12 +280,14 @@ * * * step-27 - * hp finite element methods + * The hp finite element method. + * * * * step-28 * Multiple grids for solving a multigroup diffusion equation - * in nuclear physics simulating a nuclear reactor core + * in nuclear physics simulating a nuclear reactor core. + * * * * step-29 @@ -437,6 +449,7 @@ * 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. + * * * * step-60 -- 2.39.5