From 4d6481f81c0d2ffc92583553340add3c362ddf7b Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Mon, 23 Jan 2006 04:20:57 +0000 Subject: [PATCH] Add text to the main page. git-svn-id: https://svn.dealii.org/trunk@12121 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/doc/doxygen/headers/main.h | 48 ++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 deal.II/doc/doxygen/headers/main.h diff --git a/deal.II/doc/doxygen/headers/main.h b/deal.II/doc/doxygen/headers/main.h new file mode 100644 index 0000000000..028c2abe6b --- /dev/null +++ b/deal.II/doc/doxygen/headers/main.h @@ -0,0 +1,48 @@ +//------------------------------------------------------------------------- +// $Id$ +// Version: $Name$ +// +// Copyright (C) 2006 by the deal.II authors +// +// This file is subject to QPL and may not be distributed +// without copyright and license information. Please refer +// to the file deal.II/doc/license.html for the text and +// further information on this license. +// +//------------------------------------------------------------------------- + +/** + * @mainpage + * + * This is the main page for class and function documentation in + * deal.II. Documentation on other aspects of deal.II can be found + * elsewhere. In particular, there are tutorial programs on the use of this + * library. + * + * Many of the classes in the deal.II library can be grouped into modules (see + * the Modules entry in the menu at the top of this page). These modules + * follow roughly the following collaboration diagram that finite element + * programs follow: + * + * @image html collaboration.png "Collaboration diagram for the most important groups of classes in deal.II" + * @image latex collaboration.eps "Collaboration diagram for the most important groups of classes in deal.II" width=.9\textwidth + * + * This classification of groups can be explained as follows: + *
    + * + *
  1. Unit cell: deal.II supports only hypercubes as unit cells, i.e. the + * unit cell [0,1] in 1d, the unit square [0,1]^2 in 2d, and the unit cube + * [0,1]^3 in 3d. We do not support triangles, tetrahedra, pyramids, or + * prisms. + * + *
  2. Triangulation: + *
  3. Finite Element: + *
  4. Quadrature + *
  5. DoFHandler: + *
  6. Mapping: + *
  7. FEValues: + *
  8. Linear System: + *
  9. Linear Solver: + *
  10. Output: + *
+ */ -- 2.39.5