]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Annotate some of the programs with links to the video lectures.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 11 Jul 2014 22:17:53 +0000 (22:17 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 11 Jul 2014 22:17:53 +0000 (22:17 +0000)
git-svn-id: https://svn.dealii.org/trunk@33140 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/doc/doxygen/options.dox.in
deal.II/doc/doxygen/scripts/filter
deal.II/examples/step-1/doc/intro.dox
deal.II/examples/step-2/doc/intro.dox
deal.II/examples/step-20/doc/intro.dox
deal.II/examples/step-26/doc/intro.dox
deal.II/examples/step-3/doc/intro.dox
deal.II/examples/step-4/doc/intro.dox
deal.II/examples/step-40/doc/intro.dox
deal.II/examples/step-5/doc/intro.dox
deal.II/examples/step-6/doc/intro.dox

index c63fbace812a4c4a03d87034d92745183d03e1da..00a5dad15fa7864f87ec4057091237c2be153478 100644 (file)
@@ -72,6 +72,10 @@ IMAGE_PATH             =
 INPUT_FILTER           = ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/filter
 FILTER_SOURCE_FILES    = YES
 
+# Have some user defined commands that we can use in the documentation
+# and that expands to specific text. For some more transformations, see
+# the scripts/filter perl script that is run over the header files before
+# doxygen sees it and that can expand more complex expressions.
 ALIASES += dealiiRequiresUpdateFlags{1}="@note For this function to work properly, the underlying FEValues, FEFaceValues, or FESubfaceValues object on which you call it must have computed the information you are requesting. To do so, the <code>\1</code> flag must be an element of the list of UpdateFlags that you passed to the constructor of this object. See @ref UpdateFlagsEssay for more information."
 
 ALIASES += dealiiOperationIsMultithreaded="@note If deal.II is configured with threads, this operation will run multi-threaded by splitting the work into smaller chunks (assuming there is enough work to make this worthwhile)."
index 98b0f2b25aeabbfeca59d0f3460b90416d8fac73..35aabcc66a3f668f3fb2e525b5c029a93d2a840c 100755 (executable)
@@ -2,7 +2,7 @@
 ## ---------------------------------------------------------------------
 ## $Id$
 ##
-## Copyright (C) 2007 - 2013 by the deal.II authors
+## Copyright (C) 2007 - 2014 by the deal.II authors
 ##
 ## This file is part of the deal.II library.
 ##
@@ -66,3 +66,32 @@ s#(static dealii::ExceptionBase\&)#\n//\! \@ingroup Exceptions\n \1#g;
 # by replacing a "file:" at the end of a line with the text
 # "file :", which doxygen doesn't recognize:
 s#file:[ \t]*$#file :#g;
+
+
+
+# Handle commands such as @dealiiVideoLecture{20.5,33} by expanding it
+# into a note with some text
+if (m/(\@dealiiVideoLecture\{([0-9\.]+)(, *[0-9\.]+ *)*\})/)
+{
+    $substext = $1;
+
+    $text = "\@note The material presented here is also discussed in ";
+
+    # add links to the individual lectures
+    $text = $text . "<a href=\"http://www.math.tamu.edu/~bangerth/videos.676.$2.html\">video lecture $2</a>";
+    
+    if (length($3) > 0)
+    {
+       $x = $3;
+       $x =~ s/^, *//g;
+       @otherlectures = split (',', "$x");
+
+       foreach $lecture (@otherlectures)
+       {
+           $text = $text . ", <a href=\"http://www.math.tamu.edu/~bangerth/videos.676.$lecture.html\">video lecture $lecture</a>";
+       }
+    }
+
+    $text = $text . ". (All video lectures are also available <a href=\"http://www.math.tamu.edu/~bangerth/videos.html\">here</a>.)";
+    s/(\@dealiiVideoLecture\{([0-9\.]+)(, *[0-9\.]+ *)*\})/$text/;
+}
index d4b8e8a85cc660bbdf33f087b39ce5a2a3f94b8e..22eee684e92ec0179320a50e61eab2306463726e 100644 (file)
@@ -140,7 +140,9 @@ library; in the context of deal.II, the @ref Iterators module talks
 about them).
 
 The program is otherwise small enough that it doesn't need a whole lot
-of introduction. Let us just continue with its commented source.
+of introduction.
+
+@dealiiVideoLecture{5,6}
 
 
 <h3> About scientific computing in general </h3>
index 61b5a33244acb250022cb79b6b2a8c86c49f4522..2d89d08c0d4dd7f37cabe024a9a7cf2958745abb 100644 (file)
@@ -1,6 +1,8 @@
 <a name="Intro"></a>
 <h1>Introduction</h1>
 
+@dealiiVideoLecture{9}
+
 After we have created a grid in the previous example, we now show how
 to define degrees of freedom on this mesh. For this example, we
 will use the lowest order ($Q_1$) finite elements, for which the degrees
index 13476bc2015c1e15361cceba3713a80212c96def..3453818676017349685a3f005bda3e45aa0e4c89 100644 (file)
@@ -1,6 +1,8 @@
 <a name="Intro"></a>
 <h1>Introduction</h1>
 
+@dealiiVideoLecture{19,20,21}
+
 This program is devoted to two aspects: the use of mixed finite elements -- in
 particular Raviart-Thomas elements -- and using block matrices to define
 solvers, preconditioners, and nested versions of those that use the
index 11e9fe0e42a7869983469578915d8de0a99f1fb4..289aff53ebb118121e1f716ef0137b5ebcceb594 100644 (file)
@@ -1,6 +1,9 @@
 <a name="Intro"></a>
 <h1>Introduction</h1>
 
+@dealiiVideoLecture{29,30}
+
+
 This program implements the heat equation
 @f{align*}
   \frac{\partial u(\mathbf x, t)}{\partial t}
index 741e2e2d8582e5145e06a8662b7ac87adba35a97..ce011b2101bcc8f641ac71e22a88edc9c635aa37 100644 (file)
@@ -1,6 +1,7 @@
 <a name="Intro"></a>
 <h1>Introduction</h1>
 
+@dealiiVideoLecture{10}
 
 <h3>The basic functioning of finite elements</h3>
 
index 2b2467a38317490d5944d77cc1193b4fde83aa5a..f8eadbcdf35aa1a072b1f144c98fabd5ee6c2921 100644 (file)
@@ -1,6 +1,7 @@
 <a name="Intro"></a>
 <h1>Introduction</h1>
 
+@dealiiVideoLecture{12,13}
 
 deal.II has a unique feature which we call
 ``dimension independent programming''. You may have noticed in the
index dcc07c9b98bed0f3c92b998c9f96a167af616e7e..3e3a3c6799fc6e91ecc59a04b5a7583b7f2af83b 100644 (file)
@@ -26,6 +26,8 @@ instructions for PETSc.
 <a name="Intro"></a>
 <h1>Introduction</h1>
 
+@dealiiVideoLecture{41.5}
+
 Given today's computers, most finite element computations can be done on
 a single machine. The majority of previous tutorial programs therefore
 shows only this, possibly splitting up work among a number of
index 7102702df49e44ca3f2881506e44fb1c25d350bc..532befb4b227fe88c9425daf9adcf5a348b781c2 100644 (file)
@@ -1,6 +1,7 @@
 <a name="Intro"></a>
 <h1>Introduction</h1>
 
+@dealiiVideoLecture{14}
 
 This example does not show revolutionary new things, but it shows many
 small improvements over the previous examples, and also many small
index 0fc9752982c68c63b0fc54650d57a7fbbd09895a..7cf7b167ccd1a3dfc83024dcd8f46268c3e21c2d 100644 (file)
@@ -1,6 +1,7 @@
 <a name="Intro"></a>
 <h1>Introduction</h1>
 
+@dealiiVideoLecture{15,16,17}
 
 The main emphasis in this example is the handling of locally refined
 grids. The approach to adaptivity chosen in deal.II is to use grids in which
@@ -68,4 +69,4 @@ Because boundary conditions can be treated in the same way, we will
 incorporate the them as constraints in the same ConstraintMatrix object.
 This way, we don't need to apply the boundary conditions after assembly 
 (like we did in the earlier steps).
\ No newline at end of file

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.