]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Various edits around the tutorial programs.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Sun, 24 Feb 2013 19:14:30 +0000 (19:14 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Sun, 24 Feb 2013 19:14:30 +0000 (19:14 +0000)
git-svn-id: https://svn.dealii.org/trunk@28539 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/doc/doxygen/tutorial/toc-list.html
deal.II/doc/doxygen/tutorial/toc-topics.html
deal.II/examples/step-1/doc/results.dox
deal.II/examples/step-1/doc/tooltip
deal.II/examples/step-49/doc/intro.dox
deal.II/examples/step-49/doc/tooltip

index 71095b6c91a7315b5156129f9a08607b226ea346..e5b0b8c62702eefe91c73b6cdc0f75f6ad8ada93 100644 (file)
@@ -15,9 +15,9 @@
 
 <h3>Tutorial programs listed by number</h3>
 
-<table align="center" width="80%">
+<table align="center" width="90%">
   <tr valign="top">
-      <td><a href="../../doxygen/deal.II/step_1.html">Step-1</a></td>
+      <td width="10%"><a href="../../doxygen/deal.II/step_1.html">Step-1</a></td>
       <td> Creating a grid. A simple way to write it to a file.
       </td></tr>
 
index 11617f66cb1c854ee2332f17772411a5620a72fa..ca8b5a6bea683708fd8db44e37c57cc08383969b 100644 (file)
@@ -4,7 +4,7 @@
 <head>
 <title>Step-by-Step</title>
   <meta name="author" content="the deal.II authors <authors@dealii.org>">
-  <meta name="copyright" content="Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2007, 2008, 2009, 2010, 2011, 2012 by the deal.II authors">
+  <meta name="copyright" content="Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2007, 2008, 2009, 2010, 2011, 2012, 2013 by the deal.II authors">
   <meta name="date" content="$Date$">
   <meta name="svn_id" content="$Id$">
   <meta name="keywords" content="deal.II,deal.II tutorial,deal II">
@@ -16,7 +16,7 @@
 
 <h3>Tutorial programs grouped by topics</h3>
 
-<table align="center" width="80%">
+<table align="center" width="90%">
   <tr valign="top">
     <td><b>Basic techniques</b></td>
     <td><a href="../../doxygen/deal.II/step_1.html">Step-1</a></td>
index fcbf4f4ff0a3057fdf7bc9a6a930a7fa555d2b0f..751a3910b82e71a2c93ac748c1eae4c7cf67c6ef 100644 (file)
@@ -57,6 +57,10 @@ geometries for which deal.II can create meshes using the functions in the
 GridGenerator namespace. Take a look at what it provides and see how it could
 be used in a program like this.
 
+We also discuss a variety of other ways to create and manipulate meshes to
+step-49.
+
+
 <h4> Comments about programming and debugging </h4>
 
 We close with a comment about modifying or writing programs with deal.II in
index 71927bda1d205b14a9eefaf87856f1ed81aff624..ae43afaffdfd703d9fb78ba855b13551fe18f37a 100644 (file)
@@ -1 +1 @@
-Creating a grid. Refining it. Writing it to a file
+Creating a mesh. Refining it. Writing it to a file.
index 8b61de71f3eaad357963c850f02c5f39a4807864..2947b26d8e0aa0fa28e6ac5bee7eabb42175f3b4 100644 (file)
@@ -1,18 +1,22 @@
-<i>This program was made by Timo Heister.</i>
+<i>This program was contributed by Timo Heister.</i>
 
 <a name="Intro"></a>
 <h1> Introduction </h1>
 This tutorial is an extension to step-1 and demonstrates several ways to
-obtain more involved meshes.
+obtain more involved meshes than the ones shown there.
 
-Generating complex geometries is a challenging task, especially in 3 space
+Generating complex geometries is a challenging task, especially in three space
 dimensions. We will discuss several ways to do this, but this list is not
 exhaustive. Additionally, there is not one approach that fits all problems.
 
-The example program shows some of ways to create and modify meshes for
-computations and outputs them as .eps files. No other computations or adaptive
-refinements are done. Please note that the example program does not show all
-the ways to generate meshes that are discussed in this text.
+This example program shows some of ways to create and modify meshes for
+computations and outputs them as <code>.eps</code> files in much the same way
+as we do in step-1. No other computations or adaptive
+refinements are done; the idea is that you can use the techniques used here as
+building blocks in other, more involved simulators. Please note that the
+example program does not show all the ways to generate meshes that are
+discussed in this introduction.
+
 
 <h3>General concerns about meshes</h3>
 
@@ -27,6 +31,7 @@ in the initial mesh.
 
 That said, your mesh needs to capture the given geometry adequately.
 
+
 <h3>How to create meshes</h3>
 
 There are several ways to create an initial mesh. Meshes can be modified or
@@ -34,48 +39,53 @@ combined in many ways as discussed later on.
 
 <h4>Using GridGenerator</h4>
 
-The easiest way to generate meshes is to use the GridGenerator, which is
-already discussed in step-1.  There are many different helper functions
+The easiest way to generate meshes is to use the functions in namespace
+GridGenerator, as already discussed in step-1.  There are many different
+helper functions
 available, including GridGenerator::hyper_cube(),
 GridGenerator::hyper_shell(), GridGenerator::hyper_ball(),
 GridGenerator::hyper_cube_with_cylindrical_hole(), ...
 
+
 <h4>Constructing your own mesh programmatically</h4>
 
-If the is no good fit in the GridGenerator class, you can always create a
+If there is no good fit in the GridGenerator namespace for what you want to
+do, you can always create a
 Triangulation in your program "by hand". For that, you need a list of vertices
 with their coordinates and a list of cells referencing those vertices. You can
-find an example in the function create_coarse_grid in step-14. Additionally,
-all the functions in GridGenerator are implemented in this fashion.
+find an example in the function create_coarse_grid in step-14.
+All the functions in GridGenerator are implemented in this fashion.
 
- We are happy to accept more functions to be added to GridGenerator. So, if
+We are happy to accept more functions to be added to GridGenerator. So, if
 you end up writing a function that might be useful for a larger audience,
 please contribute it.
 
+
 <h4>Importing from external programs</h4>
 
 The class GridIn can read many different mesh formats from a file from
 disk. How this is done is explained in step-5 and can be seen in the function
-grid_1 in this example.
+<code>grid_1</code> in this example, see the code below.
 
 Meshes can be generated from different tools like <a
-href="http://geuz.org/gmsh/" rel="nofollow">gmsh</a>, <a
-href="https://lagrit.lanl.gov/" rel="nofollow">lagrit</a> and <a
-href="http://cubit.sandia.gov/" rel="nofollow">cubit</a>. See the
+href="http://geuz.org/gmsh/" target="_top">gmsh</a>, <a
+href="https://lagrit.lanl.gov/" target="_top">lagrit</a> and <a
+href="http://cubit.sandia.gov/" target="_top">cubit</a>. See the
 documentation of GridIn for more information. The problem is that deal.II
 needs meshes that only consist of quads and hexas -- tetrahedral meshes won't
 work (this means tools like tetgen can not be used directly).
 
 We will describe a possible workflow using Gmsh. Gmsh is the smallest and
-quickest to set up open source tool, that we know of. It can generate
-unstructured 2d quad based meshes, but in 3d it can only extrude 2d meshes to
-get hexahedral meshes. 3D meshing of unstructured geometry into hexas is not
-supported at the time of writing.
-
-A mesh is described in a text based .geo file, that can be edited by hand and
-can contain computations, loops, variables, etc.. It is very flexible. The
+most quickly set up open source tool we are aware of. It can generate
+unstructured 2d quad meshes, but in 3d it can only extrude 2d meshes to
+get hexahedral meshes. 3D meshing of unstructured geometry into hexahedra is not
+supported at the time of writing this tutorial (early 2013).
+
+In gmsh, a mesh is described in a text based .geo file, that can be edited by
+hand and
+can contain computations, loops, variables, etc. It is very flexible. The
 mesh is generated from a surface representation, which is build from a list of
-line loops, which is build from a list of lines, which are in turn build from
+line loops, which is build from a list of lines, which are in turn built from
 points.
 
 It is important that file contains "physical lines" and "physical
@@ -88,12 +98,12 @@ under the "Geometry" tab.
 
 This tutorial contains an example .geo file, that describes a box with two
 objects cut out in the interior. This is how untitled.geo looks like in gmsh
-(displaying the boundary indicators): 
+(displaying the boundary indicators):
 @image html gmsh_picture.png Mesh displayed in Gmsh
 
 You might want to open the .geo file in a text editor to see how it is
 structured. Deal.II can read the .msh format written by gmsh. You generate the
-.msh from the .geo by running: 
+.msh from the .geo by running:
 
 <pre>
 gmsh -2 untitled.geo
@@ -131,7 +141,7 @@ a sin curve:
         <img src="http://www.dealii.org/images/steps/developer/step-49.grid-5a.png" alt=""> regular input mesh
     </td>
     <td ALIGN="center">
-        <img src="http://www.dealii.org/images/steps/developer/step-49.grid-5.png" alt=""> output mesh 
+        <img src="http://www.dealii.org/images/steps/developer/step-49.grid-5.png" alt=""> output mesh
     </td>
   </tr>
 </TABLE>
@@ -146,7 +156,7 @@ of this tutorial:
         <img src="http://www.dealii.org/images/steps/developer/step-49.grid-6a.png" alt=""> regular input mesh
     </td>
     <td ALIGN="center">
-        <img src="http://www.dealii.org/images/steps/developer/step-49.grid-6.png" alt=""> wall-adapted output mesh 
+        <img src="http://www.dealii.org/images/steps/developer/step-49.grid-6.png" alt=""> wall-adapted output mesh
     </td>
   </tr>
 </TABLE>
@@ -160,7 +170,7 @@ demonstrated in grid_7() and the result is as follows:
         <img src="http://www.dealii.org/images/steps/developer/step-49.grid-7a.png" alt=""> regular input mesh
     </td>
     <td ALIGN="center">
-        <img src="http://www.dealii.org/images/steps/developer/step-49.grid-7.png" alt=""> perturbed output mesh 
+        <img src="http://www.dealii.org/images/steps/developer/step-49.grid-7.png" alt=""> perturbed output mesh
     </td>
   </tr>
 </TABLE>
@@ -249,6 +259,5 @@ above. This is the output from grid_4():
   - change boundary indicators
   - relax inner vertices
 - Database of unstructured meshes for convergence studies
-- discuss GridTools::extract_boundary_mesh 
+- discuss GridTools::extract_boundary_mesh
 - how to remove or disable a cell inside a mesh
-
index 9580c289af122b3a14ba6f9f5519f53973a2e294..9975ca8578a64c8b1be7376cecc744c9ab501aa4 100644 (file)
@@ -1 +1 @@
-How to create and modify advanced grids.
+How to create and modify meshes.

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.