]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
If available, use a doxygen intro and result file
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 21 Mar 2006 23:09:11 +0000 (23:09 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 21 Mar 2006 23:09:11 +0000 (23:09 +0000)
git-svn-id: https://svn.dealii.org/trunk@12652 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/doc/tutorial/chapter-2.step-by-step/Makefile
deal.II/doc/tutorial/chapter-2.step-by-step/step-1.data/intro.dox [moved from deal.II/doc/tutorial/chapter-2.step-by-step/step-1.data/intro.html with 98% similarity]
deal.II/doc/tutorial/chapter-2.step-by-step/step-1.data/results.dox [moved from deal.II/doc/tutorial/chapter-2.step-by-step/step-1.data/results.html with 97% similarity]
deal.II/doc/tutorial/chapter-2.step-by-step/step-2.data/intro.dox [moved from deal.II/doc/tutorial/chapter-2.step-by-step/step-2.data/intro.html with 98% similarity]
deal.II/doc/tutorial/chapter-2.step-by-step/step-2.data/results.dox [moved from deal.II/doc/tutorial/chapter-2.step-by-step/step-2.data/results.html with 96% similarity]
deal.II/doc/tutorial/chapter-2.step-by-step/step-3.data/intro.dox [moved from deal.II/doc/tutorial/chapter-2.step-by-step/step-3.data/intro.html with 98% similarity]
deal.II/doc/tutorial/chapter-2.step-by-step/step-3.data/results.dox [moved from deal.II/doc/tutorial/chapter-2.step-by-step/step-3.data/results.html with 97% similarity]

index d47c23cda295ef78928de01953b6f9687454d5ad..e1cab1da8f2ef46918c471ea20f55b8125d37a51 100644 (file)
@@ -132,14 +132,24 @@ $(example-doxygen):
                        The $(call get_basename,$@) tutorial program" >> $@
        @echo "@htmlonly" >> $@
        @cat generated/$(call get_basename, $@)_toc.combined >> $@
-       @cat $(call get_basename, $@).data/intro.html | \
-         $(PERL) -pi -e 's#(src|SRC|href|HREF)=\"([-a-zA-Z0-9]+.data)#\1=\"../../tutorial/chapter-2.step-by-step/\2#g; s/(href|HREF)=.step-(\d+)/href=\"step_\2/g;' >> $@
        @echo "@endhtmlonly" >> $@
+       @if test -f $(call get_basename, $@).data/intro.dox ; then \
+           cat $(call get_basename, $@).data/intro.dox ; \
+        else \
+           echo "@htmlonly" ; \
+           cat $(call get_basename, $@).data/intro.html ; \
+           echo "@endhtmlonly" ; \
+         fi | \
+         $(PERL) -pi -e 's#(src|SRC|href|HREF)=\"([-a-zA-Z0-9]+.data)#\1=\"../../tutorial/chapter-2.step-by-step/\2#g; s/(href|HREF)=.step-(\d+)/href=\"step_\2/g;' >> $@
        @cat generated/$(call get_basename, $@)_prog.dox >> $@
-       @echo "@htmlonly" >> $@
-       @cat $(call get_basename, $@).data/results.html | \
+       @if test -f $(call get_basename, $@).data/results.dox ; then \
+           cat $(call get_basename, $@).data/results.dox ; \
+        else \
+           echo "@htmlonly" ; \
+           cat $(call get_basename, $@).data/results.html ; \
+           echo "@endhtmlonly" ; \
+         fi | \
          $(PERL) -pi -e 's#(src|SRC|href|HREF)=\"([-a-zA-Z0-9]+.data)#\1=\"../../tutorial/chapter-2.step-by-step/\2#g; s/(href|HREF)=.step-(\d+)/href=\"step_\2/g;' >> $@
-       @echo "@endhtmlonly" >> $@
        @cat generated/$(call get_basename, $@)_plain.dox >> $@
        @echo " */" >> $@
 
similarity index 98%
rename from deal.II/doc/tutorial/chapter-2.step-by-step/step-1.data/intro.html
rename to deal.II/doc/tutorial/chapter-2.step-by-step/step-1.data/intro.dox
index 3846e170481a528e68e421488bb594a18cd945bc..9faf332d1c3593bbc1d8553f70ff99764cb66dfd 100644 (file)
@@ -1,7 +1,6 @@
 <a name="Intro"></a>
 <h1>Introduction</h1>
 
-<p>
 In this first example, we don't actually do very much, but show two
 techniques: what is the syntax to generate triangulation objects, and
 some elements of simple loops over all cells. We create two grids, one
@@ -10,9 +9,8 @@ starting grid for some problems), and one more geometric attempt: a
 ring-shaped domain, which is refined towards the inner edge. The
 latter is certainly not very useful and is probably only rarely used
 in numerical analysis for PDEs (although, to everyone's surprise, it
-has actually found its way into the literature, see the paper by M. My
+has actually found its way into the literature, see the paper by M. Mu
 titled "PDE.MART: A network-based problem-solving environment", ACM
 Trans. Math. Software, vol. 31, pp. 508-531, 2005 :-), but looks nice
 and illustrates how loops over cells are written and some of the
 things you can do with cells.
-</p>
similarity index 97%
rename from deal.II/doc/tutorial/chapter-2.step-by-step/step-1.data/results.html
rename to deal.II/doc/tutorial/chapter-2.step-by-step/step-1.data/results.dox
index eae4f724908d53e0964b0bab2a8efbbf2e25a495..ccee9a44a030b1556144fdc0cc6e54a12fd146d9 100644 (file)
@@ -1,7 +1,6 @@
 <a name="Results"></a>
 <h1>Results</h1>
 
-<p>
 The program has, after having been run, produced two grids, which look
 like this:
 
@@ -18,4 +17,4 @@ like this:
 
 The left one, well, is not very exciting. The right one is &mdash; at least
 &mdash; unconventional.
-</p>
+
similarity index 98%
rename from deal.II/doc/tutorial/chapter-2.step-by-step/step-2.data/intro.html
rename to deal.II/doc/tutorial/chapter-2.step-by-step/step-2.data/intro.dox
index 299842def5bb672b5f5f63f940692fd7fb0a7a47..b9dd70b6e066611bf15a1d36a05eae1c46ff2984 100644 (file)
@@ -1,7 +1,6 @@
 <a name="Intro"></a>
 <h1>Introduction</h1>
 
-<p>
 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 (Q1) finite elements, for which the degrees
@@ -9,13 +8,10 @@ of freedom are associated with the vertices of the mesh. Later
 examples will demonstrate higher order elements where degrees of freedom are
 not necessarily associated with vertices any more, but can be associated
 with edges, faces, or cells.
-</p>
 
-<p>
 Defining degrees of freedom ("DoF"s in short) on a mesh is a rather
 simple task, since the library does all the work for you. However, for
 some algorithms, especially for some linear solvers, it is
 advantageous to have the degrees of freedom numbered in a certain
 order, and we will use the algorithm of Cuthill and McKee to do
 so. The results are written to a file and visualized using GNUPLOT.
-</p>
similarity index 96%
rename from deal.II/doc/tutorial/chapter-2.step-by-step/step-2.data/results.html
rename to deal.II/doc/tutorial/chapter-2.step-by-step/step-2.data/results.dox
index 99773755a5f3c70c02928036fb91d8abc3675c22..94e251e7aa8bf0654c0c59ef531e700c8f509f0e 100644 (file)
@@ -1,10 +1,9 @@
 <a name="Results"></a>
 <h1>Results</h1>
 
-<p>
 The program has, after having been run, produced two sparsity
 patterns. We can visualize them using GNUPLOT:
-<pre><code>
+@code
 examples/step-2> gnuplot
 
         G N U P L O T
@@ -26,10 +25,8 @@ examples/step-2> gnuplot
 Terminal type set to 'x11'
 gnuplot> set data style points
 gnuplot> plot "sparsity_pattern.1"
-</code></pre>
-</p>
+@endcode
 
-<p>
 The results then look like this (every cross denotes an entry which
 might be nonzero; of course the fact whether the entry actually is
 zero or not depends on the equation under consideration, but the
@@ -52,19 +49,15 @@ WIDTH="300">
 </td>
 </tr>
 </table>
-</p>
 
-<p>
 The different regions in the left picture represent the degrees of
 freedom on the different refinement levels of the triangulation.  As
 can be seen in the right picture, the sparsity pattern is much better
 clustered around the main diagonal of the matrix after
 renumbering. Although this might not be apparent, the number of
 nonzero entries is the same in both pictures, of course.
-</p>
 
-<p>
 A common observation is that the more refined the grid is, the better
 the clustering around the diagonal will get.
-</p>
+
 
similarity index 98%
rename from deal.II/doc/tutorial/chapter-2.step-by-step/step-3.data/intro.html
rename to deal.II/doc/tutorial/chapter-2.step-by-step/step-3.data/intro.dox
index 0588c6fd37a0d285babc8afb2b81f04730b9fbf4..222a263a565497a32048a75680fecc8ae0bf3a8d 100644 (file)
@@ -1,7 +1,7 @@
 <a name="Intro"></a>
 <h1>Introduction</h1>
 
-<p>
+
 This is the first example where we actually use finite elements to compute
 something. We 
 will solve a simple version of Laplace's equation with zero boundary
@@ -14,4 +14,3 @@ element programs, which are along the following lines:
   <li> Solving the linear system of equations;
   <li> Writing results to disk.
 </ul>
-</p>
similarity index 97%
rename from deal.II/doc/tutorial/chapter-2.step-by-step/step-3.data/results.html
rename to deal.II/doc/tutorial/chapter-2.step-by-step/step-3.data/results.dox
index f5f17b202d4bda5de8c7d4effbab6c9c4c0e4308..3f420a9797131092c156103ce203429e058eb695 100644 (file)
@@ -1,15 +1,14 @@
 <a name="Results"></a>
 <h1>Results</h1>
 
-<p>
 The output of the program looks as follows:
-<pre><code>
+@code
 Number of active cells: 1024
 Total number of cells: 1365
 Number of degrees of freedom: 1089
 DEAL:cg::Starting value 0.121094
 DEAL:cg::Convergence step 48 value 5.33692e-13
-</code></pre>
+@endcode
 
 The first three lines is what we wrote to <code>cout</code>. The last
 two lines were generated without our intervention by the CG
@@ -20,14 +19,12 @@ the threshold 1e-12 which we have set in the `solve' function. We will
 show in the next program how to suppress this output, which is
 sometimes useful for debugging purposes, but often clutters up the
 screen display.
-</p>
 
-<p>
 Apart from the output shown above, the program generated the file
 <code>solution.gpl</code>, which is in GNUPLOT format. It can be
 viewed as follows: invoke GNUPLOT and enter the following sequence of
 commands at its prompt:
-<pre><code>
+@code
 examples/step-3> gnuplot
 
         G N U P L O T
@@ -49,16 +46,14 @@ examples/step-3> gnuplot
 Terminal type set to 'x11'
 gnuplot> set data style lines
 gnuplot> splot "solution.gpl"
-</code></pre>
+@endcode
 This produces the picture of the solution below left. Alternatively,
 you can order GNUPLOT to do some hidden line removal by the command
-<pre><code>
+@code
 gnuplot> set hidden3d
-</code></pre>
+@endcode
 to get the result at the right:
-</p>
 
-<p>
 <TABLE WIDTH="100%">
 <tr>
 <td>
@@ -69,13 +64,12 @@ to get the result at the right:
 </td>
 </tr>
 </table>
-</p>
+
 
 
 <a name="extensions"></a>
 <h3>Possibilities for extensions</h3>
 
-<p>
 If you want to play around a little bit with this program, here are a few
 suggestions:
 </p>
@@ -133,12 +127,12 @@ suggestions:
   values as above, but then use a different boundary value function for
   boundary indicator one. In practice, what you have to do is to add a second
   call to <code>interpolate_boundary_values</code> for boundary indicator one:
-  <code><pre>
+  @code
   VectorTools::interpolate_boundary_values (dof_handler,
                                            1,
                                            ConstantFunction<2>(1.),
                                            boundary_values);    
-  </pre></code>
+  @endcode
   If you have this call immediately after the first one to this function, then
   it will interpolate boundary values on faces with boundary indicator 1 to the
   unit value, and merge these interpolated values with those previously

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.