<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
- "http://www.w3.org/TR/html4/loose.dtd">
+ "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<head>
- <link href="screen.css" rel="StyleSheet" type="text/css">
- <title>The deal.II Online Documentation</title>
- <meta name="author" content="the deal.II authors <authors@dealii.org>">
- <meta name="copyright" content="Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 by the deal.II authors">
- <meta name="date" content="2006/02/07 22:49:01">
- <meta name="keywords" content="deal.II">
- <meta name="svn_id" content="$Id$">
-</head>
-<body>
+ <head>
+ <link href="screen.css" rel="StyleSheet" type="text/css">
+ <title>The deal.II Online Documentation</title>
+
<meta name="author" content="the deal.II authors <authors@dealii.org>">
+ <meta name="copyright" content="Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 by the deal.II authors">
+ <meta name="date" content="2006/02/07 22:49:01">
+ <meta name="keywords" content="deal.II">
+ <meta name="svn_id" content="$Id$">
+ </head>
+ <body>
<h2>Online documentation</h2>
<p>
- <acronym>deal.II</acronym> comes with quite extensive online
- documentation, which falls into several categories. They are
- listed below.
+
<acronym>deal.II</acronym> comes with quite extensive online
+ documentation, which falls into several categories. They are
+ listed below.
</p>
<h3><a href="readme.html">README</a></h3>
+ <p>
First, there is the <a href="readme.html" target="body">README file</a> of
the library. It gives information on system requirements,
installation, and copyright.
- </p>
+ </p>
<h3>Tutorials</h3>
+ <p>
The <a href="doxygen/tutorial/index.html"
- target="_top">tutorial</a> is
+ target="_top">tutorial</a> 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.
- </p>
+ </p>
+ <p>
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
<a href="readme.html" target="body">ReadMe file</a> on how to do
this.
- </p>
+ </p>
<h3>Programming interface</h3>
+ <p>
The <a href="doxygen/deal.II/index.html" target="_top">programming
- interface/manual</a> pages are what you will need most often as a
+ interface/manual</a> 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 <a href="http://www.doxygen.org/"
- target="_top">Doxygen</a>. There is also a quick link to these pages from
+ target="_top">Doxygen</a>. There is also a quick link to these pages from
the menu bar at the left.
- </p>
+ </p>
+ <p>
The documentation uses many of the features of Doxygen. In particular,
the link takes you straight to a page that lists <i>modules</i>, a way
to group classes with similar purposes. This may be what you are probably
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.
- </p>
+ </p>
+ <p>
Just as for the tutorials, the API docs need to be generated first,
if you download <acronym>deal.II</acronym>. Please follow the
instructions in the
<a href="readme.html" target="body">ReadMe file</a> on how to do
this.
- </p>
+ </p>
<h3>Development information</h3>
+ <p>
If you plan to <a href="development/index.html"
- target="_top">develop your own applications</a> using
+ target="_top">develop your own applications</a> using
<acronym>deal.II</acronym>, it might be worth to take a look
at <a href="development/index.html" target="_top">this
- page</a>.
- </p>
+ page</a>.
+ </p>
<h3>Reports</h3>
- There are a number of papers that describe the overall design or
-
individual aspects of <acronym>deal.II</acronym>. Please refer to the
-
papers listed at the top of the <a href="publications/index.html"
- target="body">publications page</a> for full references. In addition,
- there are the following reports:
- A publication on the
-
<a href="reports/dimension-independent/index.html"
- target="body">basics of dimension independent
+ <p>
+ There are a number of papers that describe the overall design or
+ individual aspects of <acronym>deal.II</acronym>. Please refer to the
+ papers listed at the top of the <a href="publications/index.html"
+ target="body">publications page</a> for full references. In addition,
+ there are the following reports:
+ <ul>
+ <li> <p>
+ A publication on the
+ <a href="reports/dimension-independent/index.html"
+ target="body">basics of dimension independent
programming</a> in <acronym>deal.II</acronym> (by Wolfgang
- Bangerth). This explains some of the fundamentals of the
- library's design, though rather briefly due to the page
- limit imposed for the publication.
- </p>
-
- This publication appeared in
- the proceedings of the 16th IMACS World Congress,
- Lausanne, Switzerland, 2000. See the
-
<a href="publications/index.html" target="body">publications</a>
- page for the full reference as well as a way to obtain a
- reprint of the original paper as a postscript or PDF file.
- </p>
-
- A brief report about the classes involved in the
-
<a href="reports/class-hierarchies/index.html"
- target="body">iterators and accessors</a>
- used to access cells in the triangulations and the data
- thereon, such as their geometry, the number of the
- degrees of freedom, data values, etc. You may want to
- read this object or parts of it if you want to know what
- information is available from iterators (by Wolfgang
- Bangerth).
- </p>
-
-
A brief report on <a href="reports/mapping_q/index.html"
- target="body">mapping</a> functions of higher polynomial
- degrees (by Ralf Hartmann). These allow the realisation
- of higher order boundary approximations. This report
- gives the theoretical background of the
- <code>MappingQ</code> class.
- </p>
-
- A report on
-
<a href="reports/assemble/assemble.pdf"
- target="body">assembling matrices</a> (by Wolfgang
- Bangerth). This report looks in particular at how
- matrices are assembled for vector-valued problems, and
- how things change if vector-valued finite elements are
- used for which the shape functions have more than one
- non-zero vector component, such as Nedelec or
- Raviart-Thomas elements. There are printable
- versions of the report
-
<a href="reports/assemble/assemble.ps"
- target="body">in postscript</a> and
-
<a href="reports/assemble/assemble.pdf"
- target="body">PDF format</a>.
- </p>
-
- A very detailed report on
-
<a href="reports/nedelec/nedelec.pdf"
- target="body">Nedelec elements</a> (by Anna
- Schneebeli, University of Basel, Switzerland). It
- explains the construction and application of Nedelec
- edge elements for H-curl spaces, as used, for example,
- in the numerical solution of the Maxwell equations. It
- also gives numerical results obtained with deal.II.
-
There is also a <a href="reports/nedelec/nedelec.ps"
- target="body">postscript version of the report</a>.
- </p>
-
- A report on the
-
<a href="reports/codimension-one/desimone-heltai-manigrasso.pdf"
- target="body">codimension one</a> capabilities
- of the library (by Antonio DeSimone, Luca Heltai
- and Cataldo Manigrasso, SISSA, Trieste, Italy). It
- explains in detail how to use the
- library for the solution of problems defined on codimension
- one manifolds, such as, for example, Boundary Element Methods.
- </ul>
-
-
- <h3>Publications</h3>
+ Bangerth). This explains some of the fundamentals of the
+ library's design, though rather briefly due to the page
+ limit imposed for the publication.
+ </p>
+
+ <p>
+ This publication appeared in
+ the proceedings of the 16th IMACS World Congress,
+ Lausanne, Switzerland, 2000. See the
+ <a href="publications/index.html" target="body">publications</a>
+ page for the full reference as well as a way to obtain a
+ reprint of the original paper as a postscript or PDF file.
+ </p>
+
+ <li> <p>
+ A brief report about the classes involved in the
+ <a href="reports/class-hierarchies/index.html"
+ target="body">iterators and accessors</a>
+ used to access cells in the triangulations and the data
+ thereon, such as their geometry, the number of the
+ degrees of freedom, data values, etc. You may want to
+ read this object or parts of it if you want to know what
+ information is available from iterators (by Wolfgang
+ Bangerth).
+ </p>
+
+ <li> <p>
+ A brief report on <a href="reports/mapping_q/index.html"
+ target="body">mapping</a> functions of higher polynomial
+ degrees (by Ralf Hartmann). These allow the realisation
+ of higher order boundary approximations. This report
+ gives the theoretical background of the
+ <code>MappingQ</code> class.
+ </p>
+
+ <li> <p>
+ A report on
+ <a href="reports/assemble/assemble.pdf"
+ target="body">assembling matrices</a> (by Wolfgang
+ Bangerth). This report looks in particular at how
+ matrices are assembled for vector-valued problems, and
+ how things change if vector-valued finite elements are
+ used for which the shape functions have more than one
+ non-zero vector component, such as Nedelec or
+ Raviart-Thomas elements. There are printable
+ versions of the report
+ <a href="reports/assemble/assemble.ps"
+ target="body">in postscript</a> and
+ <a href="reports/assemble/assemble.pdf"
+ target="body">PDF format</a>.
+ </p>
+
+ <li> <p>
+ A very detailed report on
+ <a href="reports/nedelec/nedelec.pdf"
+ target="body">Nedelec elements</a> (by Anna
+ Schneebeli, University of Basel, Switzerland). It
+ explains the construction and application of Nedelec
+ edge elements for H-curl spaces, as used, for example,
+ in the numerical solution of the Maxwell equations. It
+ also gives numerical results obtained with deal.II.
+ There is also a <a href="reports/nedelec/nedelec.ps"
+ target="body">postscript version of the report</a>.
+ </p>
+
+ <li> <p>
+ A report on the
+ <a href="reports/codimension-one/desimone-heltai-manigrasso.pdf"
+ target="body">codimension one</a> capabilities
+ of the library (by Antonio DeSimone, Luca Heltai
+ and Cataldo Manigrasso, SISSA, Trieste, Italy). It
+ explains in detail how to use the
+ library for the solution of problems defined on codimension
+ one manifolds, such as, for example, Boundary Element Methods.
+ </ul>
+
+
+ <h3>Publications</h3>
+ <p>
A <a href="publications/index.html" target="body">list of
- publications</a> about and based on
+ publications</a> about and based on
<acronym>deal.II</acronym> can be found on
<a href="publications/index.html" target="body">this</a> page. There is
also a <a href="http://www.dealii.org/presentations/toc.html"
- target="body">list of presentations</a> on development with and
+ target="body">list of presentations</a> on development with and
applications based on <acronym>deal.II</acronym>.
- </p>
+ </p>
<h3>Copyright and License</h3>
-
<p> <acronym>deal.II</acronym> is copyright of the
+ <p> <acronym>deal.II</acronym> is copyright of the
<acronym>deal.II</acronym> authors, Wolfgang Bangerth, Timo Heister,
and Guido Kanschat. It is a joint effort of the principal
authors and quite a number of <a href="authors.html"
- target="body">contributors</a>. <acronym>deal.II</acronym> is
+
target="body">contributors</a>. <acronym>deal.II</acronym> is
distributed under an <a href="http://www.opensource.org"
- target="_top">OpenSource</a>
+ target="_top">OpenSource</a>
license. The full text of the license can be found in <a
- href="license.html"><tt>license.html</tt></a>.
- </p>
+ href="license.html"><tt>license.html</tt></a>.
+ </p>
<h3>Contact</h3>
-
<p>We have a <a href="mail.html">discussion group</a> for discussion
+ <p>We have a <a href="mail.html">discussion group</a> for discussion
of issues of general interest to users and developers of
<acronym>deal.II</acronym>.</p>
-
<p>More specific questions may be sent to the authors
+ <p>More specific questions may be sent to the authors
immediately at the address <tt>firstName.lastname</tt><i> at
</i> <tt>dealii.org</tt>.</p>
-<div class="right">
- <p>
- <a href="http://validator.w3.org/check?uri=referer"><img border="0"
- src="http://www.w3.org/Icons/valid-html401"
- alt="Valid HTML 4.01!" height="31" width="88"></a>
- </p>
-</div>
-</body>
+
<a href="http://validator.w3.org/check?uri=referer"><img border="0"
+ src="http://www.w3.org/Icons/valid-html401"
+ alt="Valid HTML 4.01!" height="31" width="88"></a>
+ </p>
+ </div>
+ </body>
</html>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN"
- "http://www.w3.org/TR/REC-html40/frameset.dtd">
+ "http://www.w3.org/TR/REC-html40/frameset.dtd">
<html>
-<head>
- <title>deal.II Documentation</title>
- <link href="screen.css" rel="StyleSheet">
- <link rel="SHORTCUT ICON" href="deal.ico">
- <meta name="author" content="the deal.II authors <authors@dealii.org>">
- <meta name="copyright" content="Copyright (C) 1998, 1999, 2000, 2002, 2003, 2004, 2005 by the deal.II authors">
- <meta name="date" content="$Date$">
- <meta name="svn_id" content="$Id$">
- <meta name="keywords" content="deal dealii finite elements fem triangulation">
- <meta http-equiv="content-language" content="en">
+ <head>
+ <title>deal.II Documentation</title>
+ <link href="screen.css" rel="StyleSheet">
+ <link rel="SHORTCUT ICON" href="deal.ico">
+
<meta name="author" content="the deal.II authors <authors@dealii.org>">
+ <meta name="copyright" content="Copyright (C) 1998, 1999, 2000, 2002, 2003, 2004, 2005, 2012 by the deal.II authors">
+ <meta name="date" content="$Date$">
+ <meta name="svn_id" content="$Id$">
+ <meta name="keywords" content="deal dealii finite elements fem triangulation">
+ <meta http-equiv="content-language" content="en">
- <!-- Avoid being displayed in a foreign frame //-->
- <script type="text/javascript">
- <!--
- if(top!=self)
- top.location=self.location;
- //-->
- </script>
-</head>
+ <!-- Avoid being displayed in a foreign frame //-->
+ <script type="text/javascript">
+ <!--
+ if(top!=self)
+ top.location=self.location;
+ //-->
+ </script>
+ </head>
-<frameset rows="70,*">
- <frame name="title" src="title.html" frameborder="1">
- <frameset cols="120,*">
- <frame name="navbar" src="navbar.html" frameborder="0">
- <frame name="body" src="documentation.html" frameborder="0">
+ <frameset rows="70,*">
+ <frame name="title" src="title.html" frameborder="1">
+ <frameset cols="120,*">
+ <frame name="navbar" src="navbar.html" frameborder="0">
+ <frame name="body" src="documentation.html" frameborder="0">
+ </frameset>
+ <noframes>
+ <h1>The deal.II Documentation Page</h1>
+ Your browser does not seem to understand frames. A version of this
+ page that does not use frames can be found at
+ <a href="documentation.html">documentation.html</a>.
+ </noframes>
</frameset>
- <noframes>
- <h1>The deal.II Documentation Page</h1>
- Your browser does not seem to understand frames. A version of this
- page that does not use frames can be found at
- <a href="documentation.html">documentation.html</a>.
- </noframes>
-</frameset>
</html>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
- "http://www.w3.org/TR/html4/loose.dtd">
+ "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<head>
- <title>The deal.II License</title>
- <link href="screen.css" rel="StyleSheet">
- <meta name="author" content="the deal.II authors <authors@dealii.org>">
- <meta name="copyright" content="Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2011 by the deal.II authors">
- <meta name="date" content="$Date$">
- <meta name="svn_id" content="$Id$">
- <meta name="keywords" content="deal.II license">
-</head>
-<body>
-
-
- <h1>The deal.II license</h1>
-
- <p>
- The <acronym>deal.II</acronym> library has been placed under an Open
- Source license, in the sense advocated by the <a
- href="http://www.opensource.org" target="_top">Open Source
- Initiative</a>. You are thus free to copy and use it, and you have
- free access to all source codes. However, <acronym>deal.II</acronym>
- is not in the public domain, it is property of and copyrighted by
- the <acronym>deal.II</acronym> authors, and there are restrictions
- on its use. We will give some hints on license issues first. The
- legally binding license is the <a href="#license-text">Q Public
- License (QPL)</a> at the bottom of this page. Furthermore, deal.II
- distributions come bundled with some third party software for which
- the deal.II authors do not own the copyright. The licenses of these
- parts are discussed <a href="#3rdparty">below</a>.
-
- <p>
- In this document, as well as in the program files, the terms
- <i>authors of <acronym>deal.II</acronym></i> and
- <i><acronym>deal.II</acronym> authors</i> generally refer to the
- principal authors of the library. These are Wolfgang
- Bangerth, Timo Heister, and Guido Kanschat.
- </p>
-
-
-
- <h3>Restrictions on and commercial use of the library</h3>
-
- <p>
-
- <acronym>deal.II</acronym> is distributed under the <a
- href="http://www.opensource.org/osd.html" target="_top">Open Source
- license</a> called the <em>Q Public License</em> (or "QPL") listed
- in full below. Essentially, an interpretation of this license is
- that you can use the library free of charge for developing your own
- programs. However, if you plan to distribute these programs to others,
- certain restrictions are imposed by the QPL.
-
- <p>
-
- In non-legal terms, the license stipulates that if you want
- to give your program to someone else in whatever form (including as
- a binary executable), you have to make the entire source code of
- your own program and all modifications to the deal.II library
- available free of charge as well.
-
- <p>
-
- We recognize that giving away the source code may be an
- unacceptable restriction in a commercial setting. As the owners of
- the sources, we are able to grant you a differently licensed version
- of the deal.II library that does not contain this
- requirement, and we are very much willing to negotiate the terms of
- such a license. Please contact the authors of the library if you are
- interested in commercial use of deal.II.
-
-
-
- <h3>Referencing the library</h3>
-
- <p>
- In addition to the terms imposed by the QPL, we ask for the
- following courtesy:
- </p>
- <ul>
- <li> Every publication presenting numerical results obtained with
- the help of <acronym>deal.II</acronym> should state the name of
- the library and cite
- the canonical deal.II reference listed at the top of <a
- href="publications/index.html">the publications page</a>.
- </ul>
- This is the usual, fair way of giving credit to contributors to a
- scientific result. In addition, it helps us justify our effort in
- developing deal.II as an academic undertaking.
-
- <p>
-
- We keep a <a href="publications/index.html">list of publications
- using deal.II</a>. Feel free to let us know about your publications.
-
-
- <a name="3rdparty">
- <h3>Parts of the deal.II distribution under a separate license</h3>
- </a>
-
- Some of the files in the <code>contrib/</code> subdirectory are by
- other people, and are distributed under separate licenses. These
- files are not part of the <acronym>deal.II</acronym> library, but
- they are part of our distribution. They are generally available for
- use in non-commercial academic settings. For commercial use and if
- you want to distribute your codes, please consult the licenses of
- these parts of the deal.II distribution. We made sure that those parts of the
- distribution for which the license is not entirely free for all uses can be
- disabled upon configuration of <acronym>deal.II</acronym> without
- unduly restricting the functionality of the rest of the
- library.
-
- <p>
-
- In particular, these are libraries that we distribute in the
- <code>contrib/</code> subdirectory, courtesy of their authors:
- <ul>
- <li> Parts of the <a href="http://www.boost.org/" target="_top">BOOST</a>
- library.
- <li> <a
- href="http://www.cise.ufl.edu/research/sparse/umfpack/"
- target="_top">UMFPACK</a>. For the license, see <a
- href="http://www.cise.ufl.edu/research/sparse/umfpack/"
- target="_top">UMFPACK</a>.
- <li> <a href="http://warp.povusers.org/FunctionParser/"
- target="_top">FunctionParser</a>. For the license see <a
- href="http://warp.povusers.org/FunctionParser/"
- target="_top">FunctionParser</a>.
- </ul>
-
- <p>
-
- <acronym>deal.II</acronym> can interface with a number of <a
- href="readme.html#external-libs">other packages</a> that you have to install
- yourself. They are, of course, covered by their own licenses.
- </p>
-
-
-
- <h3>About the license</h3>
-
- <p>
- The QPL was originally developed by
- <a href="http://www.troll.no" target="_top">Troll Tech</a> for their
- Qt program library, but has since gained some support by other
- library authors as well.
- For more information on the QPL, please follow
- <a href="http://doc.trolltech.com/4.0/qpl.html" target="_top">this link</a>.
- </p>
-
-
-
-<hr>
-<a name="license-text">
-<h1 align=center>
-</a>
-THE Q PUBLIC LICENSE
-version 1.0
-<br>
-<br>
-<small>
-Copyright (C) 1999 Troll Tech AS, Norway.
-<br>
-<small>
-Everyone is permitted to copy and
-<br>
-distribute this license document.
-</small>
-</small>
-</h1>
-<p>
-The intent of this license is to establish freedom to share and change the
-software regulated by this license under the open source model.
-<p>
-This license applies to any software containing a notice placed by the
-copyright holder saying that it may be distributed under the terms of
-the Q Public License version 1.0. Such software is herein referred to as
-the Software. This license covers modification and distribution of the
-Software, use of third-party application programs based on the Software,
-and development of free software which uses the Software.
-<h2 align=center>
-Granted Rights
-</h2>
-<p>
-1. You are granted the non-exclusive rights set forth in this license
-provided you agree to and comply with any and all conditions in this
-license. Whole or partial distribution of the Software, or software
-items that link with the Software, in any form signifies acceptance of
-this license.
-<p>
-2. You may copy and distribute the Software in unmodified form provided
-that the entire package, including - but not restricted to - copyright,
-trademark notices and disclaimers, as released by the initial developer
-of the Software, is distributed.
-<p>
-3. You may make modifications to the Software and distribute your
-modifications, in a form that is separate from the Software, such as
-patches. The following restrictions apply to modifications:
-<blockquote>
-<p>
-a. Modifications must not alter or remove any copyright notices in
-the Software.
-<p>
-b. When modifications to the Software are released under this
-license, a non-exclusive royalty-free right is granted to the
-initial developer of the Software to distribute your modification
-in future versions of the Software provided such versions remain
-available under these terms in addition to any other license(s) of
-the initial developer.
-</blockquote>
-<p>
-4. You may distribute machine-executable forms of the Software or
-machine-executable forms of modified versions of the Software, provided
-that you meet these restrictions:
-<blockquote>
-<p>
-a. You must include this license document in the distribution.
-<p>
-b. You must ensure that all recipients of the machine-executable forms
-are also able to receive the complete machine-readable source code
-to the distributed Software, including all modifications, without
-any charge beyond the costs of data transfer, and place prominent
-notices in the distribution explaining this.
-<p>
-c. You must ensure that all modifications included in the
-machine-executable forms are available under the terms of this
-license.
-</blockquote>
-<p>
-5. You may use the original or modified versions of the Software to
-compile, link and run application programs legally developed by you
-or by others.
-<p>
-6. You may develop application programs, reusable components and other
-software items that link with the original or modified versions of the
-Software. These items, when distributed, are subject to the following
-requirements:
-<blockquote>
-<p>
-a. You must ensure that all recipients of machine-executable forms of
-these items are also able to receive and use the complete
-machine-readable source code to the items without any charge
-beyond the costs of data transfer.
-<p>
-b. You must explicitly license all recipients of your items to use
-and re-distribute original and modified versions of the items in
-both machine-executable and source code forms. The recipients must
-be able to do so without any charges whatsoever, and they must be
-able to re-distribute to anyone they choose.
-<p>
-c. If the items are not available to the general public, and the
-initial developer of the Software requests a copy of the items,
-then you must supply one.
-</blockquote>
-<h2 align=center>
-Limitations of Liability
-</h2>
-In no event shall the initial developers or copyright holders be liable
-for any damages whatsoever, including - but not restricted to - lost
-revenue or profits or other direct, indirect, special, incidental or
-consequential damages, even if they have been advised of the possibility
-of such damages, except to the extent invariable law, if any, provides
-otherwise.
-<h2 align=center>
-No Warranty
-</h2>
-<p>
-The Software and this license document are provided AS IS with NO WARRANTY
-OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS
-FOR A PARTICULAR PURPOSE.
-<h2 align=center>
-Choice of Law
-</h2>
-<p>
-This license is governed by the Laws of Germany. Disputes shall be settled
-by Amtsgericht Heidelberg.
-
-</p>
-
-
- <hr>
-
- <address>
- The deal.II authors
- </address>
-
-<div class="right">
- <p>
- <a href="http://validator.w3.org/check?uri=referer"><img border="0"
- src="http://www.w3.org/Icons/valid-html401"
- alt="Valid HTML 4.01!" height="31" width="88"></a>
- </p>
-</div>
-</body>
+ <head>
+ <title>The deal.II License</title>
+ <link href="screen.css" rel="StyleSheet">
+
<meta name="author" content="the deal.II authors <authors@dealii.org>">
+ <meta name="copyright" content="Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2011, 2012 by the deal.II authors">
+ <meta name="date" content="$Date$">
+ <meta name="svn_id" content="$Id$">
+ <meta name="keywords" content="deal.II license">
+ </head>
+ <body>
+
+
+ <h1>The deal.II license</h1>
+
+
The <acronym>deal.II</acronym> library has been placed under an Open
+
Source license, in the sense advocated by the <a
+ href="http://www.opensource.org" target="_top">Open Source
+ Initiative</a>. You are thus free to copy and use it, and you have
+
free access to all source codes. However, <acronym>deal.II</acronym>
+ is not in the public domain, it is property of and copyrighted by
+
the <acronym>deal.II</acronym> authors, and there are restrictions
+ on its use. We will give some hints on license issues first. The
+
legally binding license is the <a href="#license-text">Q Public
+ License (QPL)</a> at the bottom of this page. Furthermore, deal.II
+ distributions come bundled with some third party software for which
+ the deal.II authors do not own the copyright. The licenses of these
+
parts are discussed <a href="#3rdparty">below</a>.
+
+ In this document, as well as in the program files, the terms
+
<i>authors of <acronym>deal.II</acronym></i> and
+
<i><acronym>deal.II</acronym> authors</i> generally refer to the
+ principal authors of the library. These are Wolfgang
+ Bangerth, Timo Heister, and Guido Kanschat.
+ </p>
+
+
+
+ <h3>Restrictions on and commercial use of the library</h3>
+
+
+
<acronym>deal.II</acronym> is distributed under the <a
+ href="http://www.opensource.org/osd.html" target="_top">Open Source
+ license</a> called the <em>Q Public License</em> (or "QPL") listed
+ in full below. Essentially, an interpretation of this license is
+ that you can use the library free of charge for developing your own
+ programs. However, if you plan to distribute these programs to others,
+ certain restrictions are imposed by the QPL.
+
+
+ In non-legal terms, the license stipulates that if you want
+ to give your program to someone else in whatever form (including as
+ a binary executable), you have to make the entire source code of
+ your own program and all modifications to the deal.II library
+ available free of charge as well.
+
+
+ We recognize that giving away the source code may be an
+ unacceptable restriction in a commercial setting. As the owners of
+ the sources, we are able to grant you a differently licensed version
+ of the deal.II library that does not contain this
+ requirement, and we are very much willing to negotiate the terms of
+ such a license. Please contact the authors of the library if you are
+ interested in commercial use of deal.II.
+
+
+
+ <h3>Referencing the library</h3>
+
+ In addition to the terms imposed by the QPL, we ask for the
+ following courtesy:
+ </p>
+ <li> Every publication presenting numerical results obtained with
+ the help of <acronym>deal.II</acronym> should state the name of
+ the library and cite
+ the canonical deal.II reference listed at the top of <a
+ href="publications/index.html">the publications page</a>.
+ </ul>
+ This is the usual, fair way of giving credit to contributors to a
+ scientific result. In addition, it helps us justify our effort in
+ developing deal.II as an academic undertaking.
+
+
+
We keep a <a href="publications/index.html">list of publications
+ using deal.II</a>. Feel free to let us know about your publications.
+
+
+ <h3>Parts of the deal.II distribution under a separate license</h3>
+ </a>
+
+ Some of the files in the <code>contrib/</code> subdirectory are by
+ other people, and are distributed under separate licenses. These
+
files are not part of the <acronym>deal.II</acronym> library, but
+ they are part of our distribution. They are generally available for
+ use in non-commercial academic settings. For commercial use and if
+ you want to distribute your codes, please consult the licenses of
+ these parts of the deal.II distribution. We made sure that those parts of the
+ distribution for which the license is not entirely free for all uses can be
+
disabled upon configuration of <acronym>deal.II</acronym> without
+ unduly restricting the functionality of the rest of the
+ library.
+
+
+ In particular, these are libraries that we distribute in the
+ <code>contrib/</code> subdirectory, courtesy of their authors:
+
<li> Parts of the <a href="http://www.boost.org/" target="_top">BOOST</a>
+ library.
+ href="http://www.cise.ufl.edu/research/sparse/umfpack/"
+
target="_top">UMFPACK</a>. For the license, see <a
+ href="http://www.cise.ufl.edu/research/sparse/umfpack/"
+ target="_top">UMFPACK</a>.
+
<li> <a href="http://warp.povusers.org/FunctionParser/"
+
target="_top">FunctionParser</a>. For the license see <a
+ href="http://warp.povusers.org/FunctionParser/"
+ target="_top">FunctionParser</a>.
+ </ul>
+
+
+
<acronym>deal.II</acronym> can interface with a number of <a
+ href="readme.html#external-libs">other packages</a> that you have to install
+ yourself. They are, of course, covered by their own licenses.
+ </p>
+
+
+
+ <h3>About the license</h3>
+
+ The QPL was originally developed by
+
<a href="http://www.troll.no" target="_top">Troll Tech</a> for their
+ Qt program library, but has since gained some support by other
+ library authors as well.
+ For more information on the QPL, please follow
+
<a href="http://doc.trolltech.com/4.0/qpl.html" target="_top">this link</a>.
+ </p>
+
+
+
+ <hr>
+
<a name="license-text">
+ <h1 align=center>
+ </a>
+ THE Q PUBLIC LICENSE
+ version 1.0
+ <br>
+ <br>
+ <small>
+ Copyright (C) 1999 Troll Tech AS, Norway.
+ <br>
+ <small>
+ Everyone is permitted to copy and
+ <br>
+ distribute this license document.
+ </small>
+ </small>
+ </h1>
+ The intent of this license is to establish freedom to share and change the
+ software regulated by this license under the open source model.
+ This license applies to any software containing a notice placed by the
+ copyright holder saying that it may be distributed under the terms of
+ the Q Public License version 1.0. Such software is herein referred to as
+ the Software. This license covers modification and distribution of the
+ Software, use of third-party application programs based on the Software,
+ and development of free software which uses the Software.
+ <h2 align=center>
+ Granted Rights
+ </h2>
+ 1. You are granted the non-exclusive rights set forth in this license
+ provided you agree to and comply with any and all conditions in this
+ license. Whole or partial distribution of the Software, or software
+ items that link with the Software, in any form signifies acceptance of
+ this license.
+ 2. You may copy and distribute the Software in unmodified form provided
+ that the entire package, including - but not restricted to - copyright,
+ trademark notices and disclaimers, as released by the initial developer
+ of the Software, is distributed.
+ 3. You may make modifications to the Software and distribute your
+ modifications, in a form that is separate from the Software, such as
+ patches. The following restrictions apply to modifications:
+ a. Modifications must not alter or remove any copyright notices in
+ the Software.
+ b. When modifications to the Software are released under this
+ license, a non-exclusive royalty-free right is granted to the
+ initial developer of the Software to distribute your modification
+ in future versions of the Software provided such versions remain
+ available under these terms in addition to any other license(s) of
+ the initial developer.
+ </blockquote>
+ 4. You may distribute machine-executable forms of the Software or
+ machine-executable forms of modified versions of the Software, provided
+ that you meet these restrictions:
+ a. You must include this license document in the distribution.
+ b. You must ensure that all recipients of the machine-executable forms
+ are also able to receive the complete machine-readable source code
+ to the distributed Software, including all modifications, without
+ any charge beyond the costs of data transfer, and place prominent
+ notices in the distribution explaining this.
+ c. You must ensure that all modifications included in the
+ machine-executable forms are available under the terms of this
+ license.
+ </blockquote>
+ 5. You may use the original or modified versions of the Software to
+ compile, link and run application programs legally developed by you
+ or by others.
+ 6. You may develop application programs, reusable components and other
+ software items that link with the original or modified versions of the
+ Software. These items, when distributed, are subject to the following
+ requirements:
+ a. You must ensure that all recipients of machine-executable forms of
+ these items are also able to receive and use the complete
+ machine-readable source code to the items without any charge
+ beyond the costs of data transfer.
+ b. You must explicitly license all recipients of your items to use
+ and re-distribute original and modified versions of the items in
+ both machine-executable and source code forms. The recipients must
+ be able to do so without any charges whatsoever, and they must be
+ able to re-distribute to anyone they choose.
+ c. If the items are not available to the general public, and the
+ initial developer of the Software requests a copy of the items,
+ then you must supply one.
+ </blockquote>
+ <h2 align=center>
+ Limitations of Liability
+ </h2>
+ In no event shall the initial developers or copyright holders be liable
+ for any damages whatsoever, including - but not restricted to - lost
+ revenue or profits or other direct, indirect, special, incidental or
+ consequential damages, even if they have been advised of the possibility
+ of such damages, except to the extent invariable law, if any, provides
+ otherwise.
+ <h2 align=center>
+ No Warranty
+ </h2>
+ The Software and this license document are provided AS IS with NO WARRANTY
+ OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS
+ FOR A PARTICULAR PURPOSE.
+ <h2 align=center>
+ Choice of Law
+ </h2>
+ This license is governed by the Laws of Germany. Disputes shall be settled
+ by Amtsgericht Heidelberg.
+
+ </p>
+
+
+ <hr>
+
+ The deal.II authors
+ </address>
+
+
<a href="http://validator.w3.org/check?uri=referer"><img border="0"
+ src="http://www.w3.org/Icons/valid-html401"
+ alt="Valid HTML 4.01!" height="31" width="88"></a>
+ </p>
+ </div>
+ </body>
</html>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
- "http://www.w3.org/TR/html4/loose.dtd">
+ "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<head>
- <title>deal.II Communications</title>
- <link href="screen.css" rel="StyleSheet">
- <meta name="author" content="the deal.II authors <authors at dealii.org>">
- <meta name="copyright" content="Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2011, 2012 by the deal.II authors">
- <meta name="date" content="$Date$">
- <meta name="svn_id" content="$Id$">
- <meta name="keywords" content="deal.II">
-</head>
-<body>
+ <head>
+ <title>deal.II Communications</title>
+ <link href="screen.css" rel="StyleSheet">
+
<meta name="author" content="the deal.II authors <authors at dealii.org>">
+ <meta name="copyright" content="Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2011, 2012 by the deal.II authors">
+ <meta name="date" content="$Date$">
+ <meta name="svn_id" content="$Id$">
+ <meta name="keywords" content="deal.II">
+ </head>
+ <body>
<h1>
-
<acronym>deal.II</acronym> Communications
+ <acronym>deal.II</acronym> Communications
</h1>
<p>
- This page summarizes your possibilities of establishing contact to other
+ This page summarizes your possibilities of establishing contact to other
<acronym>deal.II</acronym> users and to the <acronym>deal.II</acronym>
authors.
</p>
<br>
-
+
<h2>
- User Group
+ User Group
</h2>
<p>
-
All <acronym>deal.II</acronym> users (and everybody interested)
-
are encouraged to join the <acronym>deal.II</acronym>
- Discussion group on Google Groups.
+ All <acronym>deal.II</acronym> users (and everybody interested)
+ are encouraged to join the <acronym>deal.II</acronym>
+ Discussion group on Google Groups.
</p>
<ul>
<li>
In order to join, go to
the <a href="https://groups.google.com/d/forum/dealii">deal.II
- Discussion Group web page</a> and register your email address
+ Discussion Group web page</a> and register your email address
there. Or click on the membership button below. This is also a
good place to browse through existing discussion
topics. There, you can manage your group membership and email
In order to post a question or a reply, you can either go to
the
the <a href="https://groups.google.com/d/forum/dealii">deal.II
- Discussion Group page</a> and click on the corresponding
+ Discussion Group page</a> and click on the corresponding
button (preferred), or you can send email
to <a href="mailto:dealii@googlegroups.com">dealii@googlegroups.com</a>. Or
just post from the window below. Note that you have to be a
allowed to post there.
</li>
</ul>
-<iframe id="forum_embed"
- src="javascript:void(0)"
- scrolling="no"
- frameborder="0"
- width="900"
- height="700">
-</iframe>
-<script type="text/javascript">
- document.getElementById('forum_embed').src =
- "https://groups.google.com/forum/embed/?place=forum/dealii&showsearch=false&showpopout=true&showtabs=false&hideforumtitle=true";
-</script>
+ <iframe id="forum_embed"
+ src="javascript:void(0)"
+ scrolling="no"
+ frameborder="0"
+ width="900"
+ height="700">
+ </iframe>
+ <script type="text/javascript">
+ document.getElementById('forum_embed').src =
+ "https://groups.google.com/forum/embed/?place=forum/dealii&showsearch=false&showpopout=true&showtabs=false&hideforumtitle=true";
+ </script>
<br>
-
+
<h2>
- Authors
+ Authors
</h2>
Everything you consider a personal matter between you and the authors (like
- flaming them on missing items) should be sent to one of
+ flaming them on missing items) should be sent to one of
<ul>
<li>
<b>authors</b> at <b>dealii.org</b>
</ul>
Everything, that is not directly related to the library is to be considered
personal in this respect! <br>
-
+
<hr>
<address>
<a href="mail.html" target="body">The deal.II Group</a>
</address>
-<div class="right">
- <p>
- <a href="http://validator.w3.org/check?uri=referer"><img border="0"
- src="http://www.w3.org/Icons/valid-html401"
- alt="Valid HTML 4.01!" height="31" width="88"></a>
- </p>
-</div>
+
<a href="http://validator.w3.org/check?uri=referer"><img border="0"
+ src="http://www.w3.org/Icons/valid-html401"
+ alt="Valid HTML 4.01!" height="31" width="88"></a>
+ </p>
+ </div>
</body>
</html>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
- "http://www.w3.org/TR/html4/loose.dtd">
+ "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<head>
- <title>deal.II navigation bar</title>
- <link href="screen.css" rel="StyleSheet">
- <meta name="author" content="the deal.II authors <authors@dealii.org>">
- <meta name="copyright" content="Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009, 2010, 2011, 2012 by the deal.II authors">
- <meta name="date" content="2006/02/07 22:49:06">
- <meta name="svn_id" content="$Id$">
-</head>
-<body class="navbar">
-
- <p>
- <a href="index.html" target="_top">Home</a><br />
- <a href="http://www.dealii.org"target="_top"><tt>dealii.org</tt></a><br />
- </p>
-
- <hr>
-
- <p>
- <a href="readme.html" target="body">README</a><br />
- <a href="http://dealii.sourceforge.net/index.php?title=Deal.II_Questions_and_Answers" target="_top">FAQ</a><br />
- <a href="news/news.html" target="body">News</a><br />
- <a href="http://www.dealii.org/download/" target="body">Download</a><br />
- <a href="http://www.dealii.org/mail.html" target="body">Mailing list</a><br />
- <a href="http://dealii.sourceforge.net/" target="_top">Wiki</a><br />
- <a href="https://sourceforge.net/apps/trac/dealii" target="_top">Bug tracker</a><br />
- </p>
-
- <hr>
-
- <p>
- <a href="doxygen/tutorial/index.html" target="_top">Tutorial</a><br />
- <a href="doxygen/deal.II/index.html" target="_top">Manual</a><br />
- </p>
-
- <hr>
-
- <p>
- <a href="development/index.html" target="_top">Development</a><br />
- <a href="publications/index.html" target="body">Publications</a><br />
- <a href="http://www.dealii.org/presentations/" target="body">Presentations</a><br />
- <a href="authors.html" target="body">Authors</a> <br />
- <a href="license.html" target="body">License</a>
- </p>
-
-<!-- Last modified: 2006/02/07 22:49:06 -->
-
-</body>
+ <head>
+ <title>deal.II navigation bar</title>
+ <link href="screen.css" rel="StyleSheet">
+
<meta name="author" content="the deal.II authors <authors@dealii.org>">
+ <meta name="copyright" content="Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009, 2010, 2011, 2012 by the deal.II authors">
+ <meta name="date" content="2006/02/07 22:49:06">
+ <meta name="svn_id" content="$Id$">
+ </head>
+ <body class="navbar">
+
+
<a href="index.html" target="_top">Home</a><br />
+
<a href="http://www.dealii.org"target="_top"><tt>dealii.org</tt></a><br />
+ </p>
+
+ <hr>
+
+
<a href="readme.html" target="body">README</a><br />
+
<a href="http://dealii.sourceforge.net/index.php?title=Deal.II_Questions_and_Answers" target="_top">FAQ</a><br />
+
<a href="news/news.html" target="body">News</a><br />
+
<a href="http://www.dealii.org/download/" target="body">Download</a><br />
+
<a href="http://www.dealii.org/mail.html" target="body">Mailing list</a><br />
+
<a href="http://dealii.sourceforge.net/" target="_top">Wiki</a><br />
+
<a href="https://sourceforge.net/apps/trac/dealii" target="_top">Bug tracker</a><br />
+ </p>
+
+ <hr>
+
+
<a href="doxygen/tutorial/index.html" target="_top">Tutorial</a><br />
+
<a href="doxygen/deal.II/index.html" target="_top">Manual</a><br />
+ </p>
+
+ <hr>
+
+
<a href="development/index.html" target="_top">Development</a><br />
+
<a href="publications/index.html" target="body">Publications</a><br />
+
<a href="http://www.dealii.org/presentations/" target="body">Presentations</a><br />
+
<a href="authors.html" target="body">Authors</a> <br />
+
<a href="license.html" target="body">License</a>
+ </p>
+
+ <!-- Last modified: 2006/02/07 22:49:06 -->
+
+ </body>
</html>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
- "http://www.w3.org/TR/html4/loose.dtd">
+ "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<head>
- <title>Porting deal.II</title>
- <link href="screen.css" rel="StyleSheet" media="screen">
- <meta name="author" content="the deal.II authors <authors@dealii.org>">
- <meta name="copyright" content="Copyright (C) 2000, 2001, 2002, 2005, 2010, 2012 by the deal.II authors">
- <meta name="date" content="$Date$">
- <meta name="svn_id" content="$Id$">
- <meta name="keywords" content="deal.II porting">
-</head>
-
-<body>
-
-
- <h1>Porting <acronym>deal.II</acronym> to new systems</h1>
-
- <p>
- <acronym>deal.II</acronym> uses very few system dependent
- features. Consequently, there is a good chance that it might also run on other
- systems besides the ones listed in the
- <a href="readme.html" targte="body">ReadMe file</a>. Nevertheless,
- there are cases where some adjustments are necessary.
- </p>
-
-
- <p>
- Basically, all the setup of the specifics or a system is done in the
- <code>./configure</code> script that is run first. This script finds out about
- operating system, processor, and the like, and then goes on testing
- whether certain features are present, or if their absence can be
- worked around.
- <code>./configure</code> is not made for human eyes. It is in fact only a
- script generated by the <code>autoconf</code> program from the files
- <code>configure.in</code> and <code>aclocal.m4</code> in the top-level directory of
- <acronym>deal.II</acronym>. The first contains the order in which
- macros are called that test for features, interspersed by shell
- script snippets that do actions depending on the results of the
- macros. The second file contains the user-defined macros used in
- <code>configure.in</code> (most macros are already predefined by autoconf).
- To understand how all this works together, you will have to have some, though
- not a whole lot of,
- knowledge of both Unix shell scripting as well as of <code>autoconf</code>
- </p>
-
- <p>
- At the end of running <code>./configure</code>, it creates output files by
- replacing all occurrences of variables like <code>@var@</code> in input files
- by the value of the respective environment variable in
- the <code>configure</code> shell script. By convention, input files have a
- file ending <code>.in</code>; the two most important input/output file pairs
- are <code>common/Make.global_options</code>
- and <code>common/Make.global_options.in</code> as well as
- <code>include/deal.II/base/config.h.in</code>
- and <code>include/deal.II/base/config.h</code>.
- </p>
-
-
-
- <h2>Quick porting</h2>
-
- <p>
- If you find something that does not work on your system, then the
- quickest way to make <acronym>deal.II</acronym> run on your system
- is to run <code>configure</code> and change things in
- <code>common/Make.global_options</code> by hand so that it works for
- you. The downside is that
- this file is overwritten next time you run <code>./configure</code>.
- </p>
-
- <p>
- Most often, problems on new systems are caused by the compiler not
- accepting certain flags, crashing or producing invalid code on
- optimization flags, not supporting shared libraries, and the like.
- All these problems can be solved by changing
- <code>common/Make.global_options</code>, e.g. by setting the variable
- <code>enable-shared</code> to <code>no</code>, or by changing the compiler flags in
- the variables <code>CXXFLAGS.g</code> (for debug mode) or <code>CXXFLAGS.o</code> (for
- optimized mode). The most important variables in
- <code>common/Make.global_options</code> are
- <a href="development/makefiles.html">listed here</a>.
- </p>
-
-
-
- <h2>Portable porting</h2>
-
- <p>
- While the measures shown above make <acronym>deal.II</acronym> run
- on your system, it does not help other users. Neither does it mean
- that the next version will run on your system unless you do the same
- changes over again. There are basically two ways to help us make
- <acronym>deal.II</acronym> run on your system by default:
- <ul>
- <li>
+ <head>
+ <title>Porting deal.II</title>
+ <link href="screen.css" rel="StyleSheet" media="screen">
+ <meta name="author" content="the deal.II authors <authors@dealii.org>">
+ <meta name="copyright" content="Copyright (C) 2000, 2001, 2002, 2005, 2010, 2012 by the deal.II authors">
+ <meta name="date" content="$Date$">
+ <meta name="svn_id" content="$Id$">
+ <meta name="keywords" content="deal.II porting">
+ </head>
+
+ <body>
+
+
+ <h1>Porting <acronym>deal.II</acronym> to new systems</h1>
+
<p>
- You can send us the changes you had to make so that we can include
- it into the distribution.
+ <acronym>deal.II</acronym> uses very few system dependent
+ features. Consequently, there is a good chance that it might also run on other
+ systems besides the ones listed in the
+ <a href="readme.html" targte="body">ReadMe file</a>. Nevertheless,
+ there are cases where some adjustments are necessary.
</p>
- <li>
+
<p>
- If you know the basics of <code>autoconf</code>, or of shell scripting, you
- will be able to write tests for the changes that are necessary in
- <code>configure.in</code> or <code>aclocal.m4</code> yourself. There are plenty of examples, both for
- things that we do depending on the system (for example disabling
- shared libraries on certain systems) or depending on the compiler
- (for example using some optimization flags for newer gcc
- versions), and depending on the results of feature tests. For the
- latter, you may for example take a look at the macro
- <code>DEAL_II_CHECK_ASSERT_THROW</code> in <code>aclocal.m4</code> that shows how to
- test whether the <code>AssertThrow</code> construct in
- <acronym>deal.II</acronym> works as intended (this check is
- necessary since some very old compiler versions get an internal compiler
- error on DEC Alpha machines for this construct).
+ Basically, all the setup of the specifics or a system is done in the
+ <code>./configure</code> script that is run first. This script finds out about
+ operating system, processor, and the like, and then goes on testing
+ whether certain features are present, or if their absence can be
+ worked around.
+ <code>./configure</code> is not made for human eyes. It is in fact only a
+ script generated by the <code>autoconf</code> program from the files
+ <code>configure.in</code> and <code>aclocal.m4</code> in the top-level directory of
+ <acronym>deal.II</acronym>. The first contains the order in which
+ macros are called that test for features, interspersed by shell
+ script snippets that do actions depending on the results of the
+ macros. The second file contains the user-defined macros used in
+ <code>configure.in</code> (most macros are already predefined by autoconf).
+ To understand how all this works together, you will have to have some, though
+ not a whole lot of,
+ knowledge of both Unix shell scripting as well as of <code>autoconf</code>
</p>
<p>
- If you have made such changes to <code>configure.in</code> or
- <code>aclocal.m4</code>, run <code>autoconf</code> in the top-level directory to
- regenerate the <code>configure</code> script, which you should then run and
- see whether the output in <code>common/Make.global_options</code> matches
- your expectations.
+ At the end of running <code>./configure</code>, it creates output files by
+ replacing all occurrences of variables like <code>@var@</code> in input files
+ by the value of the respective environment variable in
+ the <code>configure</code> shell script. By convention, input files have a
+ file ending <code>.in</code>; the two most important input/output file pairs
+ are <code>common/Make.global_options</code>
+ and <code>common/Make.global_options.in</code> as well as
+ <code>include/deal.II/base/config.h.in</code>
+ and <code>include/deal.II/base/config.h</code>.
</p>
+
+
+ <h2>Quick porting</h2>
+
+ <p>
+ If you find something that does not work on your system, then the
+ quickest way to make <acronym>deal.II</acronym> run on your system
+ is to run <code>configure</code> and change things in
+ <code>common/Make.global_options</code> by hand so that it works for
+ you. The downside is that
+ this file is overwritten next time you run <code>./configure</code>.
+ </p>
+
+ <p>
+ Most often, problems on new systems are caused by the compiler not
+ accepting certain flags, crashing or producing invalid code on
+ optimization flags, not supporting shared libraries, and the like.
+ All these problems can be solved by changing
+ <code>common/Make.global_options</code>, e.g. by setting the variable
+ <code>enable-shared</code> to <code>no</code>, or by changing the compiler flags in
+ the variables <code>CXXFLAGS.g</code> (for debug mode) or <code>CXXFLAGS.o</code> (for
+ optimized mode). The most important variables in
+ <code>common/Make.global_options</code> are
+ <a href="development/makefiles.html">listed here</a>.
+ </p>
+
+
+
+ <h2>Portable porting</h2>
+
<p>
- Of course, we would be happy to hear about the changes you made
- for your system, so that we can include them into the next version
- of the library.
+ While the measures shown above make <acronym>deal.II</acronym> run
+ on your system, it does not help other users. Neither does it mean
+ that the next version will run on your system unless you do the same
+ changes over again. There are basically two ways to help us make
+ <acronym>deal.II</acronym> run on your system by default:
+ <ul>
+ <li>
+ <p>
+ You can send us the changes you had to make so that we can include
+ it into the distribution.
+ </p>
+
+ <li>
+ <p>
+ If you know the basics of <code>autoconf</code>, or of shell scripting, you
+ will be able to write tests for the changes that are necessary in
+ <code>configure.in</code> or <code>aclocal.m4</code> yourself. There are plenty of examples, both for
+ things that we do depending on the system (for example disabling
+ shared libraries on certain systems) or depending on the compiler
+ (for example using some optimization flags for newer gcc
+ versions), and depending on the results of feature tests. For the
+ latter, you may for example take a look at the macro
+ <code>DEAL_II_CHECK_ASSERT_THROW</code> in <code>aclocal.m4</code> that shows how to
+ test whether the <code>AssertThrow</code> construct in
+ <acronym>deal.II</acronym> works as intended (this check is
+ necessary since some very old compiler versions get an internal compiler
+ error on DEC Alpha machines for this construct).
+ </p>
+
+ <p>
+ If you have made such changes to <code>configure.in</code> or
+ <code>aclocal.m4</code>, run <code>autoconf</code> in the top-level directory to
+ regenerate the <code>configure</code> script, which you should then run and
+ see whether the output in <code>common/Make.global_options</code> matches
+ your expectations.
+ </p>
+
+ <p>
+ Of course, we would be happy to hear about the changes you made
+ for your system, so that we can include them into the next version
+ of the library.
+ </p>
+ </ul>
</p>
- </ul>
- </p>
-<hr>
+ <hr>
-<address>
-<a href="mail.html" target="body">The deal.II Group</a>
-</address>
+
<a href="mail.html" target="body">The deal.II Group</a>
+ </address>
-</body>
+ </body>
</html>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
- "http://www.w3.org/TR/html4/loose.dtd">
+ "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<head>
- <title>The deal.II Readme on interfacing to PETSc and Trilinos</title>
- <link href="screen.css" rel="StyleSheet">
- <meta name="author" content="the deal.II authors <authors @ dealii.org>">
- <meta name="copyright" content="Copyright (C) 2008, 2009, 2010, 2011, 2012 by the deal.II authors">
- <meta name="date" content="$Date: 2008-10-14 05:36:48 -0500 (Tue, 14 Oct 2008) $">
- <meta name="svn_id" content="$Id: readme.html 17202 2008-10-14 10:36:48Z heister $">
- <meta name="keywords" content="deal.II">
-</head>
+ <head>
+ <title>The deal.II Readme on interfacing to PETSc and Trilinos</title>
+ <link href="screen.css" rel="StyleSheet">
+
<meta name="author" content="the deal.II authors <authors @ dealii.org>">
+ <meta name="copyright" content="Copyright (C) 2008, 2009, 2010, 2011, 2012 by the deal.II authors">
+ <meta name="date" content="$Date: 2008-10-14 05:36:48 -0500 (Tue, 14 Oct 2008) $">
+ <meta name="svn_id" content="$Id: readme.html 17202 2008-10-14 10:36:48Z heister $">
+ <meta name="keywords" content="deal.II">
+ </head>
-<body>
+ <body>
<h1>Interfacing <acronym>deal.II</acronym> to PETSc and Trilinos</h1>
<h3>About PETSc, Trilinos, and the <acronym>deal.II</acronym>
- interfaces</h3>
+ interfaces</h3>
<p>
<acronym>deal.II</acronym> can interface to the <a
- href="http://www.mcs.anl.gov/petsc/" target="_top">PETSc</a> and
+ href="http://www.mcs.anl.gov/petsc/" target="_top">PETSc</a> and
<a href="http://trilinos.sandia.gov" target="_top">Trilinos</a> software
libraries. Both of these libraries provide lots of functions for linear
algebra, among other things, for example implementations of a variety of
computers. PETSc is written in C; Trilinos is written in C++ and can be
considered to be a more modern version of PETSc though both packages are
under continuing development at their respective national laboratories.
- </p>
+ </p>
+ <p>
<acronym>deal.II</acronym> has wrapper classes to the linear algebra
parts of both packages that provide almost the
same interfaces as the built-in <acronym>deal.II</acronym> linear
algebra classes. We use these interfaces for parallel computations based
on MPI since the native deal.II linear algebra classes lack this ability.
- </p>
+ </p>
- <h3>Configuring the interfaces to PETSc and Trilinos</h3>
+ <h3>Configuring the interfaces to PETSc and Trilinos</h3>
+ <p>
The use of PETSc and Trilinos is optional. To use the wrapper classes,
you first have to install these packages and
point <acronym>deal.II</acronym>'s <code>./configure</code> to the
installation directories. This happens in similar ways for the two
packages:
- </p>
+ </p>
- <h4>PETSc</h4>
+ <h4>PETSc</h4>
+ <p>
PETSc usually requires you to set the
environment variables <code>PETSC_DIR</code> and <code>PETSC_ARCH</code>
to a path to PETSc and denoting the architecture for which PETSc is
<acronym>deal.II</acronym> will pick them up during
configuration, and store them. It will then also recognize that
PETSc shall be used, and enable the wrapper classes.
- </p>
+ </p>
+ <p>
Alternatively, the <code>--with-petsc=DIR</code> and
<code>--with-petsc-arch=ARCH</code> switches to
<code>./configure</code> can be used to override the values
<acronym>deal.II</acronym> to be configured for PETSc use, you
should specify <code>--with-petsc=no</code> as a flag during
configuration.
- </p>
+ </p>
+ <p>
There is an additional caveat: PETSc appears not to co-operate
well when using threads and some programs crash when deal.II is
compiled in its usual mode supporting multithreading. If you see
multithreading upon configuration of <acronym>deal.II</acronym>
using the
<code>--disable-threads</code> switch to <code>./configure</code>.
- </p>
+ </p>
+ <p>
Installing both PETSc and deal.II together can be a bit of a
challenge. A good summary of the relevant steps can be found on
the <a href="http://dealii.sourceforge.net/index.php?title=Deal.II_Questions_and_Answers"
- target="_top">Frequently Asked Questions</a> page.
- </p>
+ target="_top">Frequently Asked Questions</a> page.
+ </p>
-
<p><b>Note:</b> <acronym>deal.II</acronym> can be installed with both
+ <p><b>Note:</b> <acronym>deal.II</acronym> can be installed with both
PETSc and Trilinos (see below) and they do not usually get in their
respective ways. There are, however, occasions where this is not true
and this fundamentally comes from the fact that both of these packages
difficult to understand error messages at compile or link time are
almost inevitable, and there is little the <acronym>deal.II</acronym>
build system can do to prevent this. Thus, <i>don't try to do such a
- thing!</i>
- </p>
+ thing!</i>
+ </p>
- <h4>Trilinos</h4>
+ <h4>Trilinos</h4>
+ <p>
As above, set the <code>TRILINOS_DIR</code>
environment variable to the path to an existing Trilinos installation,
or use the <code>--with-trilinos=/path/to/trilinos</code> switch of
<acronym>deal.II</acronym> is configured for, i.e. if you want deal.II
to use shared libraries, then Trilinos needs to use shared libraries as
well.
- </p>
+ </p>
+ <p>
<acronym>deal.II</acronym> and its tutorial programs use several of the
Trilinos sub-packages.
- </p>
-
- <h5>Trilinos starting with version 10.0</h5>
-
- <p style="color: red">
- Note: Trilinos versions 10.6.x, 10.8.0, 10.8.1, 10.10.2, 10.12.1 are not compatible with
- deal.II. They contain subtle bugs related to (parallel) matrices and vectors.
- Versions tested to work are 10.4.2, 10.8.5, and 10.12.2. We recommend only using
- one of the tested versions for the time being.
- </p>
-
- <p>
- Due to the entirely different build system, deal.II does no longer
- support Trilinos versions prior to 10.0.
- Starting with this version, Trilinos uses cmake to configure and
- build. This is a bit cumbersome because you first have to install a
- version of cmake that is at least a cmake 2.8 prerelease, and then enter
+ </p>
+
+ <h5>Trilinos starting with version 10.0</h5>
+
+ <p style="color: red">
+ Note: Trilinos versions 10.6.x, 10.8.0, 10.8.1, 10.10.2, 10.12.1 are not
+ compatible with deal.II. They contain subtle bugs related to (parallel)
+ matrices and vectors. Versions tested to work are 10.4.2, 10.8.5, and
+ 10.12.2. We recommend only using one of the tested versions for the time
+ being.
+ </p>
+
+ <p>
+ Trilinos uses <a href="http://cmake.org/">cmake</a> to configure and
+ build. This is a bit cumbersome because you have to enter
the following slightly longish set of commands:
<code>
- <pre>
-cd trilinos-10.4.2
-mkdir build
-cd build
-
-cmake -D Trilinos_ENABLE_OPTIONAL_PACKAGES:BOOL=ON \
- -D Trilinos_ENABLE_Sacado:BOOL=ON \
- -D Trilinos_ENABLE_Stratimikos:BOOL=ON \
- -D CMAKE_BUILD_TYPE:STRING=RELEASE \
- -D CMAKE_CXX_FLAGS:STRING="-g -O3" \
- -D CMAKE_C_FLAGS:STRING="-g -O3" \
- -D CMAKE_FORTRAN_FLAGS:STRING="-g -O5" \
- -D Trilinos_EXTRA_LINK_FLAGS:STRING="-lgfortran" \
- -D CMAKE_VERBOSE_MAKEFILE:BOOL=FALSE \
- -D Trilinos_VERBOSE_CONFIGURE:BOOL=FALSE \
- -D TPL_ENABLE_MPI:BOOL=OFF \
- -D CMAKE_INSTALL_PREFIX:PATH=/w/bangerth/share/x86_64/trilinos-10.4.2 \
- -D BUILD_SHARED_LIBS:BOOL=ON `pwd`/..
-
-make
-make install
- </pre>
+ cd trilinos-10.4.2
+ mkdir build
+ cd build
+
+ cmake -D Trilinos_ENABLE_OPTIONAL_PACKAGES:BOOL=ON \
+ -D Trilinos_ENABLE_Sacado:BOOL=ON \
+ -D Trilinos_ENABLE_Stratimikos:BOOL=ON \
+ -D CMAKE_BUILD_TYPE:STRING=RELEASE \
+ -D CMAKE_CXX_FLAGS:STRING="-g -O3" \
+ -D CMAKE_C_FLAGS:STRING="-g -O3" \
+ -D CMAKE_FORTRAN_FLAGS:STRING="-g -O5" \
+ -D Trilinos_EXTRA_LINK_FLAGS:STRING="-lgfortran" \
+ -D CMAKE_VERBOSE_MAKEFILE:BOOL=FALSE \
+ -D Trilinos_VERBOSE_CONFIGURE:BOOL=FALSE \
+ -D TPL_ENABLE_MPI:BOOL=OFF \
+ -D CMAKE_INSTALL_PREFIX:PATH=/w/bangerth/share/x86_64/trilinos-10.4.2 \
+ -D BUILD_SHARED_LIBS:BOOL=ON `pwd`/..
+
+ make
+ make install
+ </pre>
</code>
Again, the path into which you want to install Trilinos in the second to
last line of the cmake command needs to be adjusted. Obviously, if you
the <code>-jN</code> flag to the calls to <code>make</code>
where <code>N</code> is the number of compile jobs you want to run in
parallel.
- </p>
-
- Trilinos sometimes searches for other libraries but can't find
- them if they are not in the usual directories or have other
- names. A common example are BLAS or LAPACK. In a case like
- this, you may have to specifically pass the directories and/or
- library names under which they can be found
- to <code>cmake</code>. For example, this may mean to add the
- following flags to the call above:
- <code>
- -D BLAS_LIBRARY_NAMES:STRING=goto \
- -D BLAS_LIBRARY_DIRS:STRING=/apps/GotoBLAS/lib64 \
- -D LAPACK_LIBRARY_NAMES:STRING=lapack \
- -D LAPACK_LIBRARY_DIRS:STRING=/apps/lapack-3.2.1/lib64
- </pre>
- </code>
- </p>
-
- If the deal configuration complains about
-<code><pre>
-configure: error: *** Your Trilinos installation is not compatible with the C++ standard selected for this compiler. See the deal.II FAQ page for a solution. ***
-</pre></code>
- you have encountered a bug in Trilinos. As a workaround,
-
include/Sacado_cmath.hpp has to be edited (see <a href="http://dealii.sourceforge.net/index.php?title=Deal.II_Questions_and_Answers#Trilinos_detection_in_..2Fconfigure_fails_with_an_error_in_the_file_Sacado.hpp_or_Sacado_cmath.hpp">the FAQ entry for details</a>).
- </p>
-
-
- <h3>Configuring for installed Trilinos packages</h3>
-
- The above scheme works if Trilinos is installed in its own directory
- and header and library files are in subdirectories of the directory
- given to <code>--with-trilinos</code>. This scheme doesn't work,
- however, if Trilinos has been installed as a regular package on a
- system, for example into the <code>/usr</code> or <code>/opt</code>
- directories.
- </p>
-
- In that case, paths to include and library files may be specified
- separately using the <code>--with-trilinos-include</code>
- and <code>--with-trilinos-libs</code> switches
- to <code>./configure</code>. Alternatively, this information can also
- be passed to the configuration script by setting the environment
- variables <code>TRILINOS_INCDIR, TRILINOS_LIBDIR</code>.
- </p>
-
- <h3>Dealing with other Trilinos packages</h3>
-
- In the commands configuring Trilinos shown above, we have assumed a
- particular subset of Trilinos libraries that deal.II interfaces
- with. However, Trilinos has many more packages that deal.II doesn't
- use, and you can add many more <code>-D
+ </p>
+
+ <p>
+ Trilinos sometimes searches for other libraries but can't find
+ them if they are not in the usual directories or have other
+ names. A common example are BLAS or LAPACK. In a case like
+ this, you may have to specifically pass the directories and/or
+ library names under which they can be found
+ to <code>cmake</code>. For example, this may mean to add the
+ following flags to the call above:
+ <code>
+ <pre>
+ -D BLAS_LIBRARY_NAMES:STRING=goto \
+ -D BLAS_LIBRARY_DIRS:STRING=/apps/GotoBLAS/lib64 \
+ -D LAPACK_LIBRARY_NAMES:STRING=lapack \
+ -D LAPACK_LIBRARY_DIRS:STRING=/apps/lapack-3.2.1/lib64
+ </pre>
+ </code>
+ </p>
+
+ <p>
+ If the deal configuration complains about
+ configure: error: *** Your Trilinos installation is not compatible with the C++ standard selected for this compiler. See the deal.II FAQ page for a solution. ***
+ </pre></code>
+ you have encountered a bug in Trilinos. As a workaround,
+ include/Sacado_cmath.hpp has to be edited (see <a href="http://dealii.sourceforge.net/index.php?title=Deal.II_Questions_and_Answers#Trilinos_detection_in_..2Fconfigure_fails_with_an_error_in_the_file_Sacado.hpp_or_Sacado_cmath.hpp">the FAQ entry for details</a>).
+ </p>
+
+
+ <h3>Configuring for installed Trilinos packages</h3>
+
+ <p>
+ The above scheme works if Trilinos is installed in its own directory
+ and header and library files are in subdirectories of the directory
+ given to <code>--with-trilinos</code>. This scheme doesn't work,
+ however, if Trilinos has been installed as a regular package on a
+ system, for example into the <code>/usr</code> or <code>/opt</code>
+ directories.
+ </p>
+
+ <p>
+ In that case, paths to include and library files may be specified
+ separately using the <code>--with-trilinos-include</code>
+ and <code>--with-trilinos-libs</code> switches
+ to <code>./configure</code>. Alternatively, this information can also
+ be passed to the configuration script by setting the environment
+ variables <code>TRILINOS_INCDIR, TRILINOS_LIBDIR</code>.
+ </p>
+
+ <h3>Dealing with other Trilinos packages</h3>
+
+ <p>
+ In the commands configuring Trilinos shown above, we have assumed a
+ particular subset of Trilinos libraries that deal.II interfaces
+ with. However, Trilinos has many more packages that deal.II doesn't
+ use, and you can add many more <code>-D
Trilinos_ENABLE_XXX:BOOL=ON</code> flags for
- package <code>XXX</code>. Most of the time, no harm is done by doing
- so, but there are cases where some of the packages deal.II does
- interact with also interacts with package <code>XXX</code> if the
- latter was enabled in Trilinos. One example is that Trilinos' ML
- package (which we use) uses Trilinos' Zoltan package if Zoltan is
- enable, but not if Zoltan is not enabled. That means that
- the <code>libml.so</code> library may or may not depend on
- a <code>libzoltan.so</code> library.
- </p>
-
- Unfortunately, Trilinos' configuration framework does not record this
- in <code>libml.so</code>, and it is also something that is difficult
- for the deal.II configuration framework to find out after the
- fact. Consequently, deal.II's Makefiles rely on the fact
- that <i>only</i> the Trilinos packages listed above were enabled. If
- that isn't the case, you may get linker warnings. The only way to
- solve this problem is to add the additional Trilinos libraries at the
- appropriate place in the list of <code>DEAL_II_TRILINOS_LIBS</code>
- libraries in <code>common/Make.global_options</code> by hand.
- </p>
+ package <code>XXX</code>. Most of the time, no harm is done by doing
+ so, but there are cases where some of the packages deal.II does
+ interact with also interacts with package <code>XXX</code> if the
+ latter was enabled in Trilinos. One example is that Trilinos' ML
+ package (which we use) uses Trilinos' Zoltan package if Zoltan is
+ enable, but not if Zoltan is not enabled. That means that
+ the <code>libml.so</code> library may or may not depend on
+ a <code>libzoltan.so</code> library.
+ </p>
+
+ <p>
+ Unfortunately, Trilinos' configuration framework does not record this
+ in <code>libml.so</code>, and it is also something that is difficult
+ for the deal.II configuration framework to find out after the
+ fact. Consequently, deal.II's Makefiles rely on the fact
+ that <i>only</i> the Trilinos packages listed above were enabled. If
+ that isn't the case, you may get linker warnings. The only way to
+ solve this problem is to add the additional Trilinos libraries at the
+ appropriate place in the list of <code>DEAL_II_TRILINOS_LIBS</code>
+ libraries in <code>common/Make.global_options</code> by hand.
+ </p>
<hr>
<address>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
- "http://www.w3.org/TR/html4/loose.dtd">
+ "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<head>
- <title>The deal.II Readme</title>
- <link href="screen.css" rel="StyleSheet">
- <meta name="author" content="the deal.II authors <authors @ dealii.org>">
- <meta name="copyright" content="Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 by the deal.II authors">
- <meta name="date" content="$Date$">
- <meta name="svn_id" content="$Id$">
- <meta name="keywords" content="deal.II">
-</head>
+ <head>
+ <title>The deal.II Readme</title>
+ <link href="screen.css" rel="StyleSheet">
+
<meta name="author" content="the deal.II authors <authors @ dealii.org>">
+ <meta name="copyright" content="Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 by the deal.II authors">
+ <meta name="date" content="$Date$">
+ <meta name="svn_id" content="$Id$">
+ <meta name="keywords" content="deal.II">
+ </head>
-<body>
+ <body>
<h1>Installation instructions and further information
-
on <acronym>deal.II</acronym> </h1>
+ on <acronym>deal.II</acronym> </h1>
<p>
- This document contains the following sections:
+ This document contains the following sections:
</p>
<ul>
<li> <a href="#prerequisites">System requirements</a>
<li> <a href="#configuration">Configuring</a>
<li> <a href="#building">Building the library</a>
<li> <a href="#configuration-options">Configuration options</a>
- <ul>
- <li> <a href="#choose-compiler">Changing the compiler or
- compiler flags</a>
- <li> <a href="#optional">Selecting optional behavior</a>
- <li> <a href="#optional-software">Optional interfaces to
- other software packages</a>
- </ul>
+
<li> <a href="#choose-compiler">Changing the compiler or
+ compiler flags</a>
+
<li> <a href="#optional">Selecting optional behavior</a>
+
<li> <a href="#optional-software">Optional interfaces to
+ other software packages</a>
+ </ul>
</ul>
<li> <a href="#problems">Problems, questions, mailing lists</a>
<li> <a href="#license">License</a>
libraries you need to have the following programs installed:
<ul>
<li> <p>
- Perl: Any Perl 5.x version should work.
- </p>
+ Perl: Any Perl 5.x version should work.
+ </p>
<li> <p>
-
Make: We use <a href="http://www.gnu.org"
- target="_top">GNU make</a>, version 3.78 or later. Other make
- programs (i.e. non-GNU) will usually fail
- to work and are not supported.
- </p>
+ Make: We use <a href="http://www.gnu.org"
+ target="_top">GNU make</a>, version 3.78 or later. Other make
+ programs (i.e. non-GNU) will usually fail
+ to work and are not supported.
+ </p>
<li> <p>
- For debugging programs, we have found that the
-
<a href="http://www.gnu.org" target="_top">GNU
- debugger gdb</a> is a valuable tool. Other options
-
are <a href="http://www.gnu.org/software/ddd/" target="_top">DDD</a>
-
and <a href="http://www.kdbg.org/" target="_top">kdbg</a>, both of
- which have graphical user interfaces. Most integrated development
-
environments like <a href="http://www.kdevelop.org/"
- target="_top">kdevelop</a> or
-
<a href="http://eclipse.org/" target="_top">Eclipse</a> have built
- in debuggers as well.
- </p>
+ For debugging programs, we have found that the
+ <a href="http://www.gnu.org" target="_top">GNU
+ debugger gdb</a> is a valuable tool. Other options
+ are <a href="http://www.gnu.org/software/ddd/" target="_top">DDD</a>
+ and <a href="http://www.kdbg.org/" target="_top">kdbg</a>, both of
+ which have graphical user interfaces. Most integrated development
+ environments like <a href="http://www.kdevelop.org/"
+ target="_top">kdevelop</a> or
+ <a href="http://eclipse.org/" target="_top">Eclipse</a> have built
+ in debuggers as well.
+ </p>
<li> <p>
- In case you want to generate the documentation locally on your
-
machine from the header <acronym>deal.II</acronym> files, you need a
-
copy of <a href="http://www.doxygen.org/" target="_top">doxygen</a>
- on your machine. If not, you can still work with the library and
- use the documentation provided on our homepage for reference. Note
- that in order to generate inheritance graphs for classes, doxygen
-
can use the <code>dot</code> program, which is part of the <a
- href="http://www.graphviz.org" target="_top">GraphViz</a>
- package. If this program is not available, then doxygen attempts to
- generate text-mode graphs; these are much less nice, though.
- </p>
+ In case you want to generate the documentation locally on your
+ machine from the header <acronym>deal.II</acronym> files, you need a
+ copy of <a href="http://www.doxygen.org/" target="_top">doxygen</a>
+ on your machine. If not, you can still work with the library and
+ use the documentation provided on our homepage for reference. Note
+ that in order to generate inheritance graphs for classes, doxygen
+ can use the <code>dot</code> program, which is part of the <a
+ href="http://www.graphviz.org" target="_top">GraphViz</a>
+ package. If this program is not available, then doxygen attempts to
+ generate text-mode graphs; these are much less nice, though.
+ </p>
<li> <p>
- The library generates output in formats readable by
-
<a href="http://www.ucc.ie/gnuplot/gnuplot-faq.html" target="_top">GNUPLOT</a>,
-
<a href="http://www-xdiv.lanl.gov/XCM/gmv/" target="_top">GMV
- (general mesh viewer)</a>,
-
<a href="http://www.amtec.com" target="_top">Tecplot</a> (ASCII and binary),
-
<a href="http://public.kitware.com/VTK/"
- target="_top">Visualization Toolkit (Vtk)</a>,
-
<a href="http://www.avs.com" target="_top">AVS Explorer</a>,
-
<a href="http://www.opendx.org" target="_top">Open DX</a>,
-
<a href="http://www.povray.org" target="_top">Povray</a>,
- and directly to Encapsulated Postscript. GNUPLOT and a
- postscript viewer (for EPS) should be available almost
- everywhere. In the last few years, most new visualization
- programs have moved to support VTK/VTU format. There are a
-
number of excellent programs that can read VTK and VTU, such as <a
- href="http://www.llnl.gov/visit/" target="_top">Visit</a>,
-
<a href="http://www.paraview.org/HTML/Index.html"
- target="_top">ParaView</a>, as well as others.
- Povray is freely available for almost all
- platforms. AVS is a commercial program available for most
- Unix flavors. Tecplot is a commercial program available for
- Windows and most Unix platforms.
- </p>
-
- <p>
- In case you didn't find your favorite graphics format above, adding a new
- writer to <acronym>deal.II</acronym> is not too difficult as only a
- simple
- intermediate format needs to be
- converted into output (without references to cells,
- nodes, types of finite elements, and the like).
- </p>
+ The library generates output in formats readable by
+ <a href="http://www.ucc.ie/gnuplot/gnuplot-faq.html" target="_top">GNUPLOT</a>,
+ <a href="http://www-xdiv.lanl.gov/XCM/gmv/" target="_top">GMV
+ (general mesh viewer)</a>,
+ <a href="http://www.amtec.com" target="_top">Tecplot</a> (ASCII and binary),
+ <a href="http://public.kitware.com/VTK/"
+ target="_top">Visualization Toolkit (Vtk)</a>,
+ <a href="http://www.avs.com" target="_top">AVS Explorer</a>,
+ <a href="http://www.opendx.org" target="_top">Open DX</a>,
+ <a href="http://www.povray.org" target="_top">Povray</a>,
+ and directly to Encapsulated Postscript. GNUPLOT and a
+ postscript viewer (for EPS) should be available almost
+ everywhere. In the last few years, most new visualization
+ programs have moved to support VTK/VTU format. There are a
+ number of excellent programs that can read VTK and VTU, such as <a
+ href="http://www.llnl.gov/visit/" target="_top">Visit</a>,
+ <a href="http://www.paraview.org/HTML/Index.html"
+ target="_top">ParaView</a>, as well as others.
+ Povray is freely available for almost all
+ platforms. AVS is a commercial program available for most
+ Unix flavors. Tecplot is a commercial program available for
+ Windows and most Unix platforms.
+ </p>
+
+ <p>
+ In case you didn't find your favorite graphics format above, adding a new
+
writer to <acronym>deal.II</acronym> is not too difficult as only a
+ simple
+ intermediate format needs to be
+ converted into output (without references to cells,
+ nodes, types of finite elements, and the like).
+ </p>
</ul>
<a name="configuration"></a>
<h3>Configuration</h3>
- Unpacking will create a subdirectory <tt>deal.II</tt>. First run
- <pre>
- cd deal.II
- ./configure
- </pre>
- to set some paths and find out your system parameters. <tt>configure</tt>
- supports several flags which are discussed
- further down <a href="#configuration-options">below</a>.
+ <p>
+ Unpacking will create a subdirectory <tt>deal.II</tt>. First run
+ <pre>
+
+ cd deal.II
+ ./configure
+ </pre>
+ to set some paths and find out your system parameters. <tt>configure</tt>
+ supports several flags which are discussed
+ further down <a href="#configuration-options">below</a>.
</p>
<p>
- <code>./configure</code> creates the
- file <code>deal.II/common/Make.global_options</code>,
- which remembers paths and configuration options. Please note that it is not
- possible to move the library directory after configuration. Neither will
- the library compile, nor will your application programs be able to use it.
- You can
- use <code>deal.II/common/Make.global_options</code> in the
- <a href="development/index.html" target="_top">Makefiles
- of your own projects</a> to set relevant paths and parameters correctly.
+ <code>./configure</code> creates the
+ file <code>deal.II/common/Make.global_options</code>,
+ which remembers paths and configuration options. Please note that it is not
+ possible to move the library directory after configuration. Neither will
+ the library compile, nor will your application programs be able to use it.
+ You can
+ use <code>deal.II/common/Make.global_options</code> in the
+
<a href="development/index.html" target="_top">Makefiles
+ of your own projects</a> to set relevant paths and parameters correctly.
</p>
<a name="building"></a>
output may change slightly over time, just try it):
<pre>
- ========================================================================
- = Global Makefile for the deal.II libraries =
- ========================================================================
- = =
- = The following targets exist: =
- = all : debug and optimized libraries =
- = debug : the debug version of the deal.II library =
- = optimized : the optimized version of the deal.II library =
- = =
- = contrib : additional libraries in contrib, if there are any =
- = =
- = online-doc : generate the documentation in HTML format =
- = TODO : create a "TODO" file from the source files =
- = TAGS : create a TAGS file from include and source files =
- = =
- = clean : removes all object files in subdirs =
- = distclean : removes all object files, libraries, etc in subdirs =
- ========================================================================
+ ========================================================================
+ = Global Makefile for the deal.II libraries =
+ ========================================================================
+ = =
+ = The following targets exist: =
+ = all : debug and optimized libraries =
+ = debug : the debug version of the deal.II library =
+ = optimized : the optimized version of the deal.II library =
+ = =
+ = contrib : additional libraries in contrib, if there are any =
+ = =
+ = online-doc : generate the documentation in HTML format =
+ = TODO : create a "TODO" file from the source files =
+ = TAGS : create a TAGS file from include and source files =
+ = =
+ = clean : removes all object files in subdirs =
+ = distclean : removes all object files, libraries, etc in subdirs =
+ ========================================================================
</pre>
<p>
resulting executables are smaller and will run between 2 and 10
times faster than the debug executables.
</p>
- </ul>
- Each library file will have a suffix that depends on the system.
- If static libraries were requested during
- configuration, then the suffix is <code>.a</code>. For shared
- libraries, it is <code>.so</code> (for most Unix-like and Linux
- systems), <code>.dylib</code> (for Mac OS X), or <code>.dll</code>
- (for Cygwin/Windows).
+ </ul>
+ Each library file will have a suffix that depends on the system.
+ If static libraries were requested during
+ configuration, then the suffix is <code>.a</code>. For shared
+ libraries, it is <code>.so</code> (for most Unix-like and Linux
+ systems), <code>.dylib</code> (for Mac OS X), or <code>.dll</code>
+ (for Cygwin/Windows).
</p>
<p>
- Apart from the libraries, you can generate the full set of
- documentation files, by typing <code>make online-doc</code>; this takes
- some minutes but you will
- have (almost) all the documentation locally on your computer. You
- will then be able to access it through <a
- href="documentation.html" target="body">this page</a>.
+ Apart from the libraries, you can generate the full set of
+ documentation files, by typing <code>make online-doc</code>; this takes
+ some minutes but you will
+ have (almost) all the documentation locally on your computer. You
+
will then be able to access it through <a
+ href="documentation.html" target="body">this page</a>.
</p>
<p>
- At this point, you have generated everything necessary to write
- programs based on <acronym>deal.II</acronym>. If you are new to
- <acronym>deal.II</acronym>, you may want to continue with the
- <a href="doxygen/tutorial/index.html" target="_top">tutorial</a>.
+ At this point, you have generated everything necessary to write
+
programs based on <acronym>deal.II</acronym>. If you are new to
+
<acronym>deal.II</acronym>, you may want to continue with the
+
<a href="doxygen/tutorial/index.html" target="_top">tutorial</a>.
</p>
<a name="configuration-options"></a>
<h3>Configuration options</h3>
- <a name="choose-compiler"></a></a>
+ <a name="choose-compiler"></a>
<h4>Changing the compiler or compiler flags</h4>
To instruct <code>configure</code> to use a particular compiler, there are two
</pre>
<p>
- The paths to these compilers are stored in the
- <code>common/Make.global_options</code> files, so the compilers
- are always used when compiling the library even if the environment
- variables are not set later on any more (for example if you are working
- within another window, or have unset the variables for other
- purposes).
+ The paths to these compilers are stored in the
+ <code>common/Make.global_options</code> files, so the compilers
+ are always used when compiling the library even if the environment
+ variables are not set later on any more (for example if you are working
+ within another window, or have unset the variables for other
+ purposes).
</p>
<p>
- If all you want to do is pass different compiler flags to the
- compiler, set the standard environment variables <code>CXXFLAGS,
- CFLAGS, LDFLAGS</code> before calling
- <code>./configure</code>. For example, to produce
- <code>gprof</code> output, do:
- <pre>
- setenv CXXFLAGS -pg
- setenv LDFLAGS -pg
- ./configure <configure-options>
- </pre>
- The flags so set are used for both optimized and debug mode. If you want to
- set flags for only one of these two cases, you should
- set <code>CXXFLAGSO</code> or <code>CXXFLAGSG</code>, respectively.
+ If all you want to do is pass different compiler flags to the
+ compiler, set the standard environment variables <code>CXXFLAGS,
+ CFLAGS, LDFLAGS</code> before calling
+ <code>./configure</code>. For example, to produce
+ <code>gprof</code> output, do:
+ setenv CXXFLAGS -pg
+ setenv LDFLAGS -pg
+ ./configure <configure-options>
+ </pre>
+ The flags so set are used for both optimized and debug mode. If you want to
+ set flags for only one of these two cases, you should
+ set <code>CXXFLAGSO</code> or <code>CXXFLAGSG</code>, respectively.
</p>
<a name="optional">
- <h4>Selecting optional behavior</h4></a>
+ <h4>Selecting optional behavior</h4></a>
You can give several flags to ./configure:
<ul>
- <li>
- <p>
- <code>--enable-shared</code>: Compile the files of deal.II into
- shared libraries, rather than statically linked
- libraries. Enabling this option saves disk space, link time and
- start-up time, so this is the default. Some systems
- might not support shared libraries, in which case you should
- call ./configure with the parameter
- <code>--disable-shared</code>.
- </p>
-
- <li>
- <p>
- <code>--enable-threads</code>: This flag indicates that those
- parts of the library that support this compute in parallel,
- using multiple threads, making programs significantly faster on
- machines with multiple cores or processors. The default is to
- use multiple threads since most machines today have several
- processor cores. If this is not desired,
- use <code>--disable-threads</code>.
-
- <li>
- <p>
- <code>--enable-mpi</code>: If given this
- flag, <code>./configure</code> chooses <code>mpiCC</code>
- and <code>mpicc</code> as the C++ and C compilers, respectively,
- unless the <code>$CXX</code> and <code>$CC</code> environment
- variables have specifically been set to something else. If these
- compilers exist and indeed support MPI, then this also switches
- on support for MPI in the library.
- </p>
-
- <li>
- <p>
- <code>--with-cpu=...</code>: Enable specific optimization
- flags for a particular processor. Programs compiled with these options
- might not execute on another system, but may be faster on the
- particular CPU selected.
- </p>
-
- <p>
- For a complete list of supported values of this switch, you may
- take a look at the file <code>aclocal.m4</code> in the top-level
- directory. However, the most commonly used value
- is <code>--with-cpu=native</code>, indicating that the compiler
- should determine the CPU we are running on by itself and
- optimize for it.
- </p>
-
- <li>
- <p>
- <code>--with-doxygen=...</code>: Select the specified executable
- of <code>doxygen</code> over the one automatically found by
- <code>./configure</code>. May also be used if no
- <code>doxygen</code> can be found automatically.
- </p>
+ <li>
+ <code>--enable-shared</code>: Compile the files of deal.II into
+ shared libraries, rather than statically linked
+ libraries. Enabling this option saves disk space, link time and
+ start-up time, so this is the default. Some systems
+ might not support shared libraries, in which case you should
+ call ./configure with the parameter
+ <code>--disable-shared</code>.
+ </p>
+
+ <li>
+ <code>--enable-threads</code>: This flag indicates that those
+ parts of the library that support this compute in parallel,
+ using multiple threads, making programs significantly faster on
+ machines with multiple cores or processors. The default is to
+ use multiple threads since most machines today have several
+ processor cores. If this is not desired,
+ use <code>--disable-threads</code>.
+
+ <li>
+ <code>--enable-mpi</code>: If given this
+ flag, <code>./configure</code> chooses <code>mpiCC</code>
+ and <code>mpicc</code> as the C++ and C compilers, respectively,
+ unless the <code>$CXX</code> and <code>$CC</code> environment
+ variables have specifically been set to something else. If these
+ compilers exist and indeed support MPI, then this also switches
+ on support for MPI in the library.
+ </p>
+
+ <li>
+ <code>--with-cpu=...</code>: Enable specific optimization
+ flags for a particular processor. Programs compiled with these options
+ might not execute on another system, but may be faster on the
+ particular CPU selected.
+ </p>
+
+ For a complete list of supported values of this switch, you may
+ take a look at the file <code>aclocal.m4</code> in the top-level
+ directory. However, the most commonly used value
+ is <code>--with-cpu=native</code>, indicating that the compiler
+ should determine the CPU we are running on by itself and
+ optimize for it.
+ </p>
+
+ <li>
+ <code>--with-doxygen=...</code>: Select the specified executable
+ of <code>doxygen</code> over the one automatically found by
+ <code>./configure</code>. May also be used if no
+ <code>doxygen</code> can be found automatically.
+ </p>
</ul>
<p>
- <code>./configure</code> stores the paths to some
- programs, such as the compilers or the Perl interpreter. The
- compiler which will be used when compiling the library (or your
- own application) is therefore selected at the time of
- configuration and independent of the setting of your $PATH
- environment value at the time when you run <code>make</code>. If
- you want to change the compiler used, you will therefore have
- to re-run ./configure.
+ <code>./configure</code> stores the paths to some
+ programs, such as the compilers or the Perl interpreter. The
+ compiler which will be used when compiling the library (or your
+ own application) is therefore selected at the time of
+ configuration and independent of the setting of your $PATH
+ environment value at the time when you run <code>make</code>. If
+ you want to change the compiler used, you will therefore have
+ to re-run ./configure.
</p>
<p>
- It is in general a good idea to run <code>make clean</code>
- before re-configuring.
+ It is in general a good idea to run <code>make clean</code>
+ before re-configuring.
</p>
</p>
<dl>
- <dt>TECPLOT</dt>
- <dd>Autodetected if one of the variables <tt>$TECHOME</tt>,
- <tt>$TEC80HOME</tt> or <tt>$TEC90HOME</tt> points to a valid installation
- of the tecio library. If enabled, allows data output in TECPLOT format.
- </dd>
-
- <a name="umfpack"></a>
- <dt>UMFPACK</dt>
- <dd>Enabled by <tt>--with-umfpack</tt>. If no argument is given,
- use the version of UMFPACK that comes bundled with <acronym>deal.II</acronym>. If you
- want a different version of UMFPACK, provide the path to that
- version as an argument. Enabling UMFPACK adds the
- class <tt>SparseDirectUMFPACK</tt> to the library. The default is to not
- use UMFPACK.
-
- <p>
- If you want to use an external installation of UMFPACK, but UMFPACK was
- installed as
- part of <code>/usr</code> or <code>/opt</code>, instead of local
- directories in a home directory for example, you can use configure
- switches <code>--with-umfpack-include, --with-umfpack-libs</code>.
- </p>
-
- <p>
- Note that UMFPACK has its own license; if
- you want to use it with deal.II, please read it and make sure that you
- agree with it. You can find the license of UMFPACK <a
- href="http://www.cise.ufl.edu/research/sparse/umfpack/">here</a>. We
- include UMFPACK in the deal.II distributions courtesy of its author,
- <a href="http://www.cise.ufl.edu/~davis/">Timothy A. Davis</a>.
- </dd>
-
- <a name="petsc"></a>
- <dt>Petsc</dt>
- <dd>
- <p>
- <acronym>deal.II</acronym> can interface to
- the <a href="http://www.mcs.anl.gov/petsc/"
- target="_top">PETSc</a> library. The simplest way to do so is to
- set the <code>PETSC_DIR</code> and <code>PETSC_ARCH</code>
- environment variables. More information and configuration
- options can be found by issuing <code>./configure --help</code>
- at the command line, or, <a href="readme-petsc-trilinos.html"
- target="body">here</a>.
- </p>
-
- <p>
- (<acronym>deal.II</acronym>) version 7.2 (and higher) support
- PETSc 3.x.x only; earlier releases are no longer supported.
- </p>
- </dd>
-
- <a name="slepc"></a>
- <dt>Slepc</dt>
- <dd>
- <p>
- <acronym>deal.II</acronym> can also interface to
- the <a href="http://www.grycap.upv.es/slepc/"
- target="_top">SLEPc</a> library. The way to do it is to set
- the <code>SLEPC_DIR</code> environment variable by
- passing <code>--with-slepc=/path/to/slepc</code>
- to <acronym>deal.II</acronym>'s <code>./configure</code> script.
- The use of SLEPc is optional, however, for the interface with
- SLEPc to work at all, <acronym>deal.II</acronym>'s interface to
- PETSc must also be configured correctly (see the notes above on
- how to do this).
- </p>
- </dd>
-
- <a name="trilinos"></a>
- <dt>Trilinos</dt>
- <dd>
- <p>
- <acronym>deal.II</acronym> can also interface
- to <a href="http://trilinos.sandia.gov" target="_top">Trilinos</a>. The
- simplest way to use these interfaces is to
- pass <code>--with-trilinos=/path/to/trilinos</code>
- to <acronym>deal.II</acronym>'s <code>./configure</code> script. Note
- that not all versions of Trilinos are compatible
- with <acronym>deal.II</acronym>. More details about compatibility and
- configuration can be found <a href="readme-petsc-trilinos.html"
- target="body">here</a>.
- </p>
- </dd>
-
- <a name="metis"></a>
- <dt>Metis</dt>
- <dd>
- <p>
- In order to generate partitionings of triangulations, we have
- functions that
- call <a href="http://glaros.dtc.umn.edu/gkhome/metis/metis/overview"
- target="_top">METIS</a> library. METIS is a library that
- provides various methods to partition graphs, which we use to
- define which cell belongs to which part of a
- triangulation. The main point in using METIS is to generate
- partitions so that the interfaces between cell blocks are as
- small as possible. This data can, in turn, be used to
- distribute degrees of freedom onto different processors when
- using PETSc and/or SLEPc in parallel mode.
- </p>
-
- <p>
- As with PETSc and SLEPc, the use of METIS is optional. If you
- wish to use it, you can do so by having a METIS installation
- around at the time of calling
- <code>./configure</code> by either setting
- the <code>METIS_DIR</code> environment variable denoting the
- path to the METIS library, or using the
- <code>--with-metis</code> flag.
- </p>
-
- <p>
- (<acronym>deal.II</acronym>) version 7.2 (and higher) support
- METIS 5.x.x only; earlier releases are no longer
- supported. <br>METIS is not needed when
- using <code>p4est</code> to parallelize programs, see below.
- </p>
- </dd>
-
- <a name="p4est"></a>
- <dt>p4est</dt>
- <dd>
- <p>
- p4est is a library that <acronym>deal.II</acronym> uses to
- distribute very large meshes across multiple processors (think
- meshes with a billion cells on 10,000 processors). Using and
- installing p4est is discussed <a href="external-libs/p4est.html"
- target="body">here</a>.
- To configure <acronym>deal.II</acronym> with p4est, you will
- need to use the <code>--with-path=/path/to/path</code>
- switch to the <code>./configure</code> script.
- </p>
- </dd>
-
- <a name="blas"></a>
- <dt>BLAS, LAPACK</dt>
-
- <dd> <p>If <code>--with-blas=blasname</code> and/or
- <code>--with-lapack=lapackname</code> is given, provide wrappers
- around some of the BLAS and LAPACK functions, and link with the
- respective libraries. It will make sure that we link with the
- required FORTRAN libraries. If no argument is given to
- <code>--with-blas</code>, then a BLAS library
- <code>libblas.a</code> or <code>libblas.so</code> is searched for
- in the default locations of your system, and similarly for LAPACK.</p>
-
- <p>If your BLAS or LAPACK libraries are not in the standard search
- path of your linker, you have to tell the linker where to find them.
- The path is not given as an argument to
- <code>--with-blas</code>. Rather, you set the variable
- <code>LDFLAGS</code> accordingly or make sure that the path is in
- your <code>LD_LIBRARY_PATH</code> or similar. For details, please
- look up the documentation of your linker. An example configuration
- for Linux is:</p>
- <pre>
- ./configure --with-blas=myblas LDFLAGS=-L/my/lib/
- </pre>
- <p> This example will search for a library
- <code>libmyblas.a</code> or <code>libmyblas.so</code> in the
- directory <code>/my/lib</code> and elsewhere in the system library
- paths.</p>
-
- <p>Some versions of BLAS and LAPACK need additional libraries
- to be linked with. Such an example is the
- <a href="http://math-atlas.sourceforge.net/">automatically tuned
- linear algebra software (ATLAS)</a>. The BLAS version of this
- package also needs declarations from <code>libatlas.a</code>,
- so it must be included. Using the standard library names of
- atlas, the include for BLAS reads
- <pre>
- ./configure --with-blas='f77blas -latlas'
- </pre>
- assuming that the library files <code>libf77blas.a</code> and
- <code>libatlas.a</code> or the respective shared libraries
- <code>*.so</code> are in libraries included in
- <code>LD_LIBRARY_PATH</code>. LAPACK generated by ATLAS is
- included in a similar fashion.</p>
- </dd>
-
- <a name="netcdf"></a>
- <dt>NetCDF</dt>
- <dd>Autodetected if the <tt>NETCDF_DIR</tt> environment variable
- points to a valid installation of the <a
- href="http://www.unidata.ucar.edu/software/netcdf/">NetCDF</a>
- library. Can also be enabled by
- <tt>--with-netcdf=/path/to/netcdf</tt> which overrides the path in
- <tt>$NETCDF_DIR</tt>. If enabled, <acronym>deal.II</acronym> allows grid
- input in NetCDF format (GridIn::read_netcdf). If NetCDF was installed as
- part of <code>/usr</code> or <code>/opt</code>, instead of local
- directories in a home directory for example, you can use configure
- switches <code>--with-netcdf-include, --with-netcdf-libs</code>.
- </dd>
-
- <a name="hsl"></a>
- <dt>Harwell Subroutine Library (HSL)</dt>
- <dd>
- It is possible to use some subroutines from the
- <a href="http://www.cse.clrc.ac.uk/Activity/HSL"
- target="_top">Harwell Subroutine Library (HSL)</a> to make use
- of some sparse direct solvers. For a description of how to
- include these functions, see
- <a href="external-libs/hsl.html" target="body">this page</a>.
- </dd>
-
- <a name="mumps"></a>
- <dt>MUltifrontal Massively Parallel sparse direct Solver (MUMPS)</dt>
- <dd>
- It is possible to make use some subroutines that make use of the
- <a href="http://mumps.enseeiht.fr"
- target="_top">MUltifrontal Massively Parallel sparse direct Solver
- (MUMPS)</a>. For a detailed description of how to compile MUMPS (and
- some dependencies) and linking with deal.II, see
- <a href="external-libs/mumps.html" target="body">this page</a>.
- </dd>
-
- <a name="functionparser"></a>
- <dt>FunctionParser</dt>
- <dd>
- There is a wrapper for the
- <a href="http://warp.povusers.org/FunctionParser/">FunctionParser</a>
- library, which has its own license; if you want to use it with deal.II,
- please read it and make sure that you agree with it.
- You can find the license of FunctionParser
- <a href="http://warp.povusers.org/FunctionParser/">here</a>. We
- include FunctionParser in the deal.II distributions courtesy of its author,
- <a href="http://www.students.tut.fi/~warp/">Juha Nieminen</a>.
- </dd>
-
- <a name="ARPACK"></a>
- <dt>ARPACK</dt>
- <dd>
- There is a wrapper for the eigenvalue solver
- <a href="http://www.caam.rice.edu/software/ARPACK/">ARPACK</a>
- library, which has its own license; if you want to use it with deal.II,
- please read it and make sure that you agree with it.
- You can find the license of ARPACK
- <a href="http://www.caam.rice.edu/software/ARPACK/RiceBSD.txt">here</a>.
- For a detailed description of how to compile ARPACK and linking with deal.II, see
- <a href="external-libs/arpack.html" target="body">this page</a>.
- </dd>
-
- <a name="HDF5"></a>
- <dt>HDF5</dt>
- <dd>
- This adds HDF5/XDMF graphical output capabilities to deal.II. You need to
- install the <a href="http://www.hdfgroup.org/HDF5/">HDF5 library</a>
- separately. Configure with <code>--with-hdf5=</code> and point it to
- the h5pcc or h5cc script inside your hdf5 installation.
-
- For a detailed description of how to compile HDF5 and linking with
- deal.II, see <a href="external-libs/hdf5.html" target="body">this
- page</a>.
- </dd>
+ <dt>TECPLOT</dt>
+ <dd>Autodetected if one of the variables <tt>$TECHOME</tt>,
+ <tt>$TEC80HOME</tt> or <tt>$TEC90HOME</tt> points to a valid installation
+ of the tecio library. If enabled, allows data output in TECPLOT format.
+ </dd>
+
+ <dt>UMFPACK</dt>
+ <dd>Enabled by <tt>--with-umfpack</tt>. If no argument is given,
+
use the version of UMFPACK that comes bundled with <acronym>deal.II</acronym>. If you
+ want a different version of UMFPACK, provide the path to that
+ version as an argument. Enabling UMFPACK adds the
+ class <tt>SparseDirectUMFPACK</tt> to the library. The default is to not
+ use UMFPACK.
+
+ If you want to use an external installation of UMFPACK, but UMFPACK was
+ installed as
+ part of <code>/usr</code> or <code>/opt</code>, instead of local
+ directories in a home directory for example, you can use configure
+ switches <code>--with-umfpack-include, --with-umfpack-libs</code>.
+ </p>
+
+ Note that UMFPACK has its own license; if
+ you want to use it with deal.II, please read it and make sure that you
+
agree with it. You can find the license of UMFPACK <a
+ href="http://www.cise.ufl.edu/research/sparse/umfpack/">here</a>. We
+ include UMFPACK in the deal.II distributions courtesy of its author,
+
<a href="http://www.cise.ufl.edu/~davis/">Timothy A. Davis</a>.
+ </dd>
+
+ <dt>Petsc</dt>
+ <dd>
+
<acronym>deal.II</acronym> can interface to
+
the <a href="http://www.mcs.anl.gov/petsc/"
+ target="_top">PETSc</a> library. The simplest way to do so is to
+ set the <code>PETSC_DIR</code> and <code>PETSC_ARCH</code>
+ environment variables. More information and configuration
+ options can be found by issuing <code>./configure --help</code>
+
at the command line, or, <a href="readme-petsc-trilinos.html"
+ target="body">here</a>.
+ </p>
+
+
(<acronym>deal.II</acronym>) version 7.2 (and higher) support
+ PETSc 3.x.x only; earlier releases are no longer supported.
+ </p>
+ </dd>
+
+ <dt>Slepc</dt>
+ <dd>
+
<acronym>deal.II</acronym> can also interface to
+
the <a href="http://www.grycap.upv.es/slepc/"
+ target="_top">SLEPc</a> library. The way to do it is to set
+ the <code>SLEPC_DIR</code> environment variable by
+ passing <code>--with-slepc=/path/to/slepc</code>
+
to <acronym>deal.II</acronym>'s <code>./configure</code> script.
+ The use of SLEPc is optional, however, for the interface with
+
SLEPc to work at all, <acronym>deal.II</acronym>'s interface to
+ PETSc must also be configured correctly (see the notes above on
+ how to do this).
+ </p>
+ </dd>
+
+
<a name="trilinos"></a>
+ <dt>Trilinos</dt>
+ <dd>
+
<acronym>deal.II</acronym> can also interface
+
to <a href="http://trilinos.sandia.gov" target="_top">Trilinos</a>. The
+ simplest way to use these interfaces is to
+ pass <code>--with-trilinos=/path/to/trilinos</code>
+
to <acronym>deal.II</acronym>'s <code>./configure</code> script. Note
+ that not all versions of Trilinos are compatible
+
with <acronym>deal.II</acronym>. More details about compatibility and
+
configuration can be found <a href="readme-petsc-trilinos.html"
+ target="body">here</a>.
+ </p>
+ </dd>
+
+ <dt>Metis</dt>
+ <dd>
+ In order to generate partitionings of triangulations, we have
+ functions that
+
call <a href="http://glaros.dtc.umn.edu/gkhome/metis/metis/overview"
+ target="_top">METIS</a> library. METIS is a library that
+ provides various methods to partition graphs, which we use to
+ define which cell belongs to which part of a
+ triangulation. The main point in using METIS is to generate
+ partitions so that the interfaces between cell blocks are as
+ small as possible. This data can, in turn, be used to
+ distribute degrees of freedom onto different processors when
+ using PETSc and/or SLEPc in parallel mode.
+ </p>
+
+ As with PETSc and SLEPc, the use of METIS is optional. If you
+ wish to use it, you can do so by having a METIS installation
+ around at the time of calling
+ <code>./configure</code> by either setting
+ the <code>METIS_DIR</code> environment variable denoting the
+ path to the METIS library, or using the
+ <code>--with-metis</code> flag.
+ </p>
+
+
(<acronym>deal.II</acronym>) version 7.2 (and higher) support
+ METIS 5.x.x only; earlier releases are no longer
+ supported. <br>METIS is not needed when
+ using <code>p4est</code> to parallelize programs, see below.
+ </p>
+ </dd>
+
+ <dt>p4est</dt>
+ <dd>
+
p4est is a library that <acronym>deal.II</acronym> uses to
+ distribute very large meshes across multiple processors (think
+ meshes with a billion cells on 10,000 processors). Using and
+
installing p4est is discussed <a href="external-libs/p4est.html"
+ target="body">here</a>.
+
To configure <acronym>deal.II</acronym> with p4est, you will
+ need to use the <code>--with-path=/path/to/path</code>
+ switch to the <code>./configure</code> script.
+ </p>
+ </dd>
+
+ <dt>BLAS, LAPACK</dt>
+
+
<dd> <p>If <code>--with-blas=blasname</code> and/or
+ <code>--with-lapack=lapackname</code> is given, provide wrappers
+ around some of the BLAS and LAPACK functions, and link with the
+ respective libraries. It will make sure that we link with the
+ required FORTRAN libraries. If no argument is given to
+ <code>--with-blas</code>, then a BLAS library
+ <code>libblas.a</code> or <code>libblas.so</code> is searched for
+ in the default locations of your system, and similarly for LAPACK.</p>
+
+
<p>If your BLAS or LAPACK libraries are not in the standard search
+ path of your linker, you have to tell the linker where to find them.
+ The path is not given as an argument to
+ <code>--with-blas</code>. Rather, you set the variable
+ <code>LDFLAGS</code> accordingly or make sure that the path is in
+ your <code>LD_LIBRARY_PATH</code> or similar. For details, please
+ look up the documentation of your linker. An example configuration
+ for Linux is:</p>
+ ./configure --with-blas=myblas LDFLAGS=-L/my/lib/
+ </pre>
+
<p> This example will search for a library
+ <code>libmyblas.a</code> or <code>libmyblas.so</code> in the
+ directory <code>/my/lib</code> and elsewhere in the system library
+ paths.</p>
+
+
<p>Some versions of BLAS and LAPACK need additional libraries
+ to be linked with. Such an example is the
+
<a href="http://math-atlas.sourceforge.net/">automatically tuned
+ linear algebra software (ATLAS)</a>. The BLAS version of this
+ package also needs declarations from <code>libatlas.a</code>,
+ so it must be included. Using the standard library names of
+ atlas, the include for BLAS reads
+ ./configure --with-blas='f77blas -latlas'
+ </pre>
+ assuming that the library files <code>libf77blas.a</code> and
+ <code>libatlas.a</code> or the respective shared libraries
+ <code>*.so</code> are in libraries included in
+ <code>LD_LIBRARY_PATH</code>. LAPACK generated by ATLAS is
+ included in a similar fashion.</p>
+ </dd>
+
+ <dt>NetCDF</dt>
+ <dd>Autodetected if the <tt>NETCDF_DIR</tt> environment variable
+
points to a valid installation of the <a
+ href="http://www.unidata.ucar.edu/software/netcdf/">NetCDF</a>
+ library. Can also be enabled by
+ <tt>--with-netcdf=/path/to/netcdf</tt> which overrides the path in
+
<tt>$NETCDF_DIR</tt>. If enabled, <acronym>deal.II</acronym> allows grid
+ input in NetCDF format (GridIn::read_netcdf). If NetCDF was installed as
+ part of <code>/usr</code> or <code>/opt</code>, instead of local
+ directories in a home directory for example, you can use configure
+ switches <code>--with-netcdf-include, --with-netcdf-libs</code>.
+ </dd>
+
+ <dt>Harwell Subroutine Library (HSL)</dt>
+ <dd>
+ It is possible to use some subroutines from the
+
<a href="http://www.cse.clrc.ac.uk/Activity/HSL"
+ target="_top">Harwell Subroutine Library (HSL)</a> to make use
+ of some sparse direct solvers. For a description of how to
+ include these functions, see
+
<a href="external-libs/hsl.html" target="body">this page</a>.
+ </dd>
+
+ <dt>MUltifrontal Massively Parallel sparse direct Solver (MUMPS)</dt>
+ <dd>
+ It is possible to make use some subroutines that make use of the
+
<a href="http://mumps.enseeiht.fr"
+ target="_top">MUltifrontal Massively Parallel sparse direct Solver
+ (MUMPS)</a>. For a detailed description of how to compile MUMPS (and
+ some dependencies) and linking with deal.II, see
+
<a href="external-libs/mumps.html" target="body">this page</a>.
+ </dd>
+
+
<a name="functionparser"></a>
+ <dt>FunctionParser</dt>
+ <dd>
+ There is a wrapper for the
+
<a href="http://warp.povusers.org/FunctionParser/">FunctionParser</a>
+ library, which has its own license; if you want to use it with deal.II,
+ please read it and make sure that you agree with it.
+ You can find the license of FunctionParser
+
<a href="http://warp.povusers.org/FunctionParser/">here</a>. We
+ include FunctionParser in the deal.II distributions courtesy of its author,
+
<a href="http://www.students.tut.fi/~warp/">Juha Nieminen</a>.
+ </dd>
+
+ <dt>ARPACK</dt>
+ <dd>
+ There is a wrapper for the eigenvalue solver
+
<a href="http://www.caam.rice.edu/software/ARPACK/">ARPACK</a>
+ library, which has its own license; if you want to use it with deal.II,
+ please read it and make sure that you agree with it.
+ You can find the license of ARPACK
+
<a href="http://www.caam.rice.edu/software/ARPACK/RiceBSD.txt">here</a>.
+ For a detailed description of how to compile ARPACK and linking with deal.II, see
+
<a href="external-libs/arpack.html" target="body">this page</a>.
+ </dd>
+
+ <dt>HDF5</dt>
+ <dd>
+ This adds HDF5/XDMF graphical output capabilities to deal.II. You need to
+
install the <a href="http://www.hdfgroup.org/HDF5/">HDF5 library</a>
+ separately. Configure with <code>--with-hdf5=</code> and point it to
+ the h5pcc or h5cc script inside your hdf5 installation.
+
+ For a detailed description of how to compile HDF5 and linking with
+
deal.II, see <a href="external-libs/hdf5.html" target="body">this
+ page</a>.
+ </dd>
</dl>
<h2>Problems, questions, mailing lists</h2>
<p>
- Some information beyond what is covered in the documentation of
- the library may be found on the
- <a href="http://www.dealii.org" target="_top"><acronym>deal.II</acronym>
- homepage</a>, or in the
- <a href="http://dealii.sourceforge.net/index.php?title=Deal.II_Questions_and_Answers" target="_top">Frequently Asked Questions</a> section.
- If you don't find what you're looking for,
- feel free to ask on our
- <a href="http://www.dealii.org/mail.html" target="body">mailing list</a>.
+ Some information beyond what is covered in the documentation of
+ the library may be found on the
+
<a href="http://www.dealii.org" target="_top"><acronym>deal.II</acronym>
+ homepage</a>, or in the
+
<a href="http://dealii.sourceforge.net/index.php?title=Deal.II_Questions_and_Answers" target="_top">Frequently Asked Questions</a> section.
+ If you don't find what you're looking for,
+ feel free to ask on our
+
<a href="http://www.dealii.org/mail.html" target="body">mailing list</a>.
</p>
<p>
- For specific problems, send email to either
- <tt>Wolfgang.Bangerth</tt>, <tt>Timo.Heister</tt>,
- <tt>Guido.Kanschat</tt>, or simply <tt>authors</tt> at
- <tt>dealii.org</tt>.
+ For specific problems, send email to either
+ <tt>Wolfgang.Bangerth</tt>, <tt>Timo.Heister</tt>,
+ <tt>Guido.Kanschat</tt>, or simply <tt>authors</tt> at
+ <tt>dealii.org</tt>.
</p>
<p>
- We are interested in any feedback, whether positive or negative,
- in order to determine the directions of future work on the
- library. We are also very much interested in incorporating any
- work and bug fixes by third parties into the library. Of course,
- you will be credited for this on our home page.
+ We are interested in any feedback, whether positive or negative,
+ in order to determine the directions of future work on the
+ library. We are also very much interested in incorporating any
+ work and bug fixes by third parties into the library. Of course,
+ you will be credited for this on our home page.
</p>
<p>
- Our institutes are evaluated at regular intervals. Consequently,
- we are interested in documenting the use of the programs and
- libraries we create. To this end, we collect
- publications with results obtained using <acronym>deal.II</acronym>. Please
- let us know if you have publications that we can add
- <a href="publications/index.html">to this page</a>.
+ Our institutes are evaluated at regular intervals. Consequently,
+ we are interested in documenting the use of the programs and
+ libraries we create. To this end, we collect
+
publications with results obtained using <acronym>deal.II</acronym>. Please
+ let us know if you have publications that we can add
+
<a href="publications/index.html">to this page</a>.
</p>
<a name="license"></a>
<h2>License</h2>
<p>
- We have placed <acronym>deal.II</acronym> under an <a
- href="http://www.opensource.org" target="_top">Open Source</a>
- license, which allows you to use the library free of charge. You
- are guaranteed full access to the source code and are encouraged
- to help in the further development of the library. Follow <a
- href="license.html" target="body">this link</a> to read the full
- text of the license,
+
We have placed <acronym>deal.II</acronym> under an <a
+ href="http://www.opensource.org" target="_top">Open Source</a>
+ license, which allows you to use the library free of charge. You
+ are guaranteed full access to the source code and are encouraged
+
to help in the further development of the library. Follow <a
+ href="license.html" target="body">this link</a> to read the full
+ text of the license,
</p>
<p>
- The basics of the license are in short:
- <ul>
- <li>
- The library comes free of charge for all users, but
- we keep a copyright in it. We will grant everyone access to
- the library and its source code, provided they keep to the
- <a href="license.html" target="body">license</a>.
+ The basics of the license are in short:
+ <li>
+ The library comes free of charge for all users, but
+ we keep a copyright in it. We will grant everyone access to
+ the library and its source code, provided they keep to the
+ <a href="license.html" target="body">license</a>.
- <li>
- The libraries may not be stripped of our copyright. We would
- appreciate being contacted if you want to use the library
- commercially.
+ <li>
+ The libraries may not be stripped of our copyright. We would
+ appreciate being contacted if you want to use the library
+ commercially.
- <li>
- We ask that scientific publications presenting results obtained with this
- libraries acknowledge its use. Please cite one of the papers referenced
- <a href="publications/index.html">here</a>.
- </ul>
+ <li>
+ We ask that scientific publications presenting results obtained with this
+ libraries acknowledge its use. Please cite one of the papers referenced
+
<a href="publications/index.html">here</a>.
+ </ul>
<p>
- <acronym>deal.II</acronym> can interface with a number of <a
- href="#external-libs">other packages</a> that you have to install
- yourself. They are, of course, covered by their own licenses. In addition,
- deal.II comes with copies of <a
- href="http://www.cise.ufl.edu/research/sparse/umfpack/">UMFPACK</a> and
- <a href="http://warp.povusers.org/FunctionParser/">FunctionParser</a>,
- courtesy of their authors. UMFPACK and FunctionParser are covered by their
- own licenses; please refer to their webpages to read them.
-
- <hr>
-
- <address>
- <a href="mail.html" target="body">The deal.II Group</a>
- $Date$
- </address>
+
<acronym>deal.II</acronym> can interface with a number of <a
+ href="#external-libs">other packages</a> that you have to install
+ yourself. They are, of course, covered by their own licenses. In addition,
+
deal.II comes with copies of <a
+ href="http://www.cise.ufl.edu/research/sparse/umfpack/">UMFPACK</a> and
+
<a href="http://warp.povusers.org/FunctionParser/">FunctionParser</a>,
+ courtesy of their authors. UMFPACK and FunctionParser are covered by their
+ own licenses; please refer to their webpages to read them.
+
+ <hr>
+
+
<a href="mail.html" target="body">The deal.II Group</a>
+ $Date$
+ </address>
</body>
</html>
projects / dealii-svn.git / commitdiff