Online documentation

deal.II comes with quite extensive online documentation, which falls into several categories. They are listed below.

README

First, there is the README file of the library. It gives information on system requirements, installation, and copyright.

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.

Note that along with the rest of the documentation, the local HTML pages of the tutorials need to be generated first. Please follow the instructions in the ReadMe file on how to do this.

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 file on how to do this.

Development information

If you plan to develop your own applications using deal.II, it might be worth to take a look at this page.

Reports

There are a number of papers that describe the overall design or individual aspects of deal.II. Please refer to the papers listed at the top of the publications page for full references. In addition, there are the following reports:

Publications

A list of publications about and based on deal.II can be found on this page.

Copyright and License

deal.II is copyright of the deal.II authors. It is a joint effort of the current maintainers, Wolfgang Bangerth, Timo Heister, Guido Kanschat, and quite a number of contributors. deal.II is distributed under an OpenSource license. The full text of the license can be found in license.html.

Contact

We have a discussion group for discussion of issues of general interest to users and developers of deal.II.

More specific questions may be sent to the authors immediately at the address firstName.lastname at dealii.org.

Valid HTML 4.01!