Skip to content

Latest commit

 

History

History
76 lines (54 loc) · 2.78 KB

README.md

File metadata and controls

76 lines (54 loc) · 2.78 KB

PDELab

Installation instructions

This is version 2.7-git of the PDELab library.

PDELab is a PDE solver toolbox built on top of DUNE, the Distributed and Unified Numerics Environment.

The main intention is to provide a good set of high-level abstractions to allow for a reasonably quick development of simulation codes, while at the same time offering the flexibility to implement new numerical methods and optimize for specific simulation scenarios.

This package contains the PDELab library code. For application examples see the companion package dune-pdelab-howto.

If you have downloaded a release tarball, you can find the autogenerated Doxygen API documentation in doc/doxygen/html. Otherwise, you can build this documentation yourself by calling "make doc". Note that you need Doxygen and GraphViz available at configure time to be able to build the documentation.

If you need help, please ask on our mailinglist. Bugs can also be submitted to the PDELab bugtracker instead.

Dependencies

PDELab depends on the following software packages:

  • DUNE core libraries (dune-common, dune-geometry, dune-grid, dune-istl, dune-localfunctions) version 2.7-git, and their respective dependencies.

  • The dune-typetree library, version 2.7-git. You can obtain a source package or clone the repository.

  • PDELab's compiler requirements differ slightly from the underlying DUNE libraries: We require at least GCC 5 in C++14 mode. PDELab should also work with very recent versions of ICC (icpc 18.0.0+) and current clang (5+).

The following software is optional:

  • Eigen 3.1.0 - there is an experimental backend for Eigen vectors and matrices as well as some solvers. See CHANGELOG.md for details.

For a full explanation of the DUNE installation process please read the installation notes.

License

The PDELab library, headers and test programs are free open-source software, dual-licensed under version 3 or later of the GNU Lesser General Public License and version 2 of the GNU General Public License with a special run-time exception.

See the file LICENSE.md for full copying permissions.

Installation

For installation instructions please see the DUNE website.

Links