Information for Users


This page gathers some information on developing programs based on deal.II, as well as on how to configure and use deal.II. At present, we have the following resources available:

Documentation

Tutorials

The tutorial is for new users of the library. It explains the basic elements of finite element programs based on the library, and provides small example programs. You can also reach the tutorial link from the menu bar at the left. There is also an extensive set of Youtube-hosted video lectures that provide both the context of the mathematical and computational methods of deal.II as well as demonstrate parts of the tutorial. These video lectures are also reachable from the menu bar at the left.

As all other documentation, the HTML pages of the tutorials can be generated locally on your computer and can then be read offline. Please follow the instructions in the ReadMe on how to generate them locally.

Programming interface

The programming interface/manual pages are what you will need most often as a reference of all classes, functions and variables in the library. They are extensively documented (presently more than 5000 pages if printed), and generated by Doxygen. There is also a quick link to these pages from the menu bar at the left.

The documentation uses many of the features of Doxygen. In particular, the link takes you straight to a page that lists modules, a way to group classes with similar purposes. This may be what you are probably interested in when you are not yet familiar with the library. If you already know your way around and want to look up the signature of a particular member function, for example, you may go to the class view or choose any of the other ways in which Doxygen allows you to navigate through the documentation.

Just as for the tutorials, the API docs need to be generated first, if you download deal.II. Please follow the instructions in the ReadMe on how to do this.


The deal.II Authors $Date: 2013-12-04 06:12:46 -0500 (Wed, 04 Dec 2013) $