]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Give a bit of an introduction to the library's documentation.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Wed, 9 Feb 2011 15:46:38 +0000 (15:46 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Wed, 9 Feb 2011 15:46:38 +0000 (15:46 +0000)
git-svn-id: https://svn.dealii.org/trunk@23316 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/examples/step-1/doc/intro.dox

index 9faf332d1c3593bbc1d8553f70ff99764cb66dfd..133da7689e04427e3666d3993f864bf25ed51989 100644 (file)
@@ -1,6 +1,44 @@
 <a name="Intro"></a>
 <h1>Introduction</h1>
 
+Since this is the first tutorial program, let us comment first on how
+this tutorial and the rest of the deal.II documentation is supposed to
+work. The documentation for deal.II comes essentially at three
+different levels:
+- The tutorial: This is a collection of programs that shows how
+  deal.II is used in practice. It doesn't typically discuss individual
+  functions at the level of individual arguments, but rather wants to
+  give the big picture of how things work together. In other words, it
+  discusses "concepts": what are the building blocks of deal.II and
+  how are they used together in finite element programs.
+- The manual: This is the documentation of every single class and
+  every single (member) function in deal.II. You get there if, for
+  example, you click on the "Main page" or "Classes" tab at the top of
+  this page. This is the place where you would look up what the second
+  argument of Triangulation::create_triangulation_compatibility means,
+  to give just one slightly obscure example. You need this level of
+  documentation for when you know what you want to do, but forgot how
+  exactly the function was named, what its arguments are, or what it
+  returns. Note that you also get into the manual whenever you read
+  through the tutorial and click on any of the class or function
+  names, i.e. the tutorial contains a great many links into the manual
+  for whenever you need a more detailed description of a function or
+  class. On the other hand, the manual is not a good place to learn
+  deal.II since it gives you a microscopic view of things without
+  telling you how a function might fit into the bigger picture.
+- Modules: These are groups of classes and functions that work
+  together or have related functionality. If you click on the
+  "Modules" tab at the top of this page, you end up on a page that
+  lists a number of such groups. Each module discusses the underlying
+  principles of these classes; for example, the @ref Sparsity module
+  talks about all sorts of different issues related to storing
+  sparsity patterns of matrices. This is documentation at an
+  intermediate level: they give you an overview of what's there in a
+  particular area. For example when you wonder what finite element
+  classes exist, you would take a look at the @ref fe module.
+
+
+
 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

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.