forked from dealii/dealii
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
14 additions
and
86 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,86 +1,14 @@ | ||
| What is deal.II? | ||
| ================ | ||
|
|
||
| deal.II is a C++ program library targeted at the computational solution | ||
| of partial differential equations using adaptive finite elements. It uses | ||
| state-of-the-art programming techniques to offer you a modern interface | ||
| to the complex data structures and algorithms required. | ||
|
|
||
| For the impatient: | ||
| ------------------ | ||
|
|
||
| Let's say you've unpacked the .tar.gz file into a directory /path/to/dealii/sources. | ||
| Then configure, compile, and install the deal.II library with: | ||
|
|
||
| $ mkdir build | ||
| $ cd build | ||
| $ cmake -DCMAKE_INSTALL_PREFIX=/path/where/dealii/should/be/installed/to /path/to/dealii/sources | ||
| $ make install (alternatively $ make -j<N> install) | ||
| $ make test | ||
|
|
||
| To build from the repository, execute the following commands first: | ||
|
|
||
| $ git clone https://github.com/dealii/dealii | ||
| $ cd dealii | ||
|
|
||
| Then continue as before. | ||
|
|
||
| A detailed *ReadME* can be found at [./doc/readme.html](https://dealii.org/developer/readme.html), | ||
| [./doc/users/cmake_user.html](https://dealii.org/developer/users/cmake_user.html), | ||
| or at https://www.dealii.org/. | ||
|
|
||
| Getting started: | ||
| ---------------- | ||
|
|
||
| The tutorial steps are located under examples/ of the installation. | ||
| Information about the tutorial steps can be found at | ||
| [./doc/doxygen/tutorial/index.html](https://dealii.org/developer/doxygen/deal.II/Tutorial.html) | ||
| or at https://www.dealii.org/. | ||
|
|
||
| deal.II includes support for pretty-printing deal.II objects inside GDB. | ||
| See [`contrib/utilities/dotgdbinit.py`](contrib/utilities/dotgdbinit.py) or | ||
| the new documentation page (under 'information for users') for instructions | ||
| on how to set this up. | ||
|
|
||
| License: | ||
| -------- | ||
|
|
||
| Please see the file [./LICENSE.md](LICENSE.md) for details | ||
|
|
||
| Further information: | ||
| -------------------- | ||
|
|
||
| For further information have a look at | ||
| [./doc/index.html](https://dealii.org/developer/index.html) or at | ||
| https://www.dealii.org. | ||
|
|
||
| Continuous Integration Status: | ||
| ------------------------ | ||
|
|
||
| | System | Status | More information | | ||
| | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | | ||
| | Indent |  | using GitHub actions | | ||
| | Linux serial | [](https://ci.tjhei.info/job/dealii-serial/job/master/) | See https://ci.tjhei.info | | ||
| | Linux MPI | [](https://ci.tjhei.info/job/dealii-mpi/job/master/) | See https://ci.tjhei.info | | ||
| | MacOS | [](https://ci.tjhei.info/job/dealii-OSX/job/master/) | See https://ci.tjhei.info | | ||
| | Linux | [](https://github.com/dealii/dealii/actions?query=workflow%3Agithub-linux) | See https://github.com/dealii/dealii/actions | | ||
| | MacOS | [](https://github.com/dealii/dealii/actions?query=workflow%3Agithub-OSX) | See https://github.com/dealii/dealii/actions | | ||
| | MSVC | [](https://github.com/dealii/dealii/actions?query=workflow%3Agithub-windows) | See https://github.com/dealii/dealii/actions | | ||
| | Docker | [](https://github.com/dealii/dealii/actions?query=workflow%3Agithub-docker) | See https://github.com/dealii/dealii/actions | | ||
| | CDash | [](https://cdash.dealii.org/index.php?project=deal.II) | Various builds and configurations on https://cdash.dealii.org/index.php?project=deal.II | | ||
|
|
||
| Docker Images: | ||
| ------------- | ||
|
|
||
| Docker images based on the Ubuntu operating system are available on | ||
| [Docker Hub](https://hub.docker.com/repository/docker/dealii/dealii). You can | ||
| use any of the available version | ||
| ([list of available tags](https://hub.docker.com/repository/docker/dealii/dealii/tags)) | ||
| by running, for example: | ||
|
|
||
| $ docker run --rm -t -i dealii/dealii:master-focal | ||
|
|
||
| The above command would drop you into an isolated environment, in which you | ||
| will find the latest version of deal.II (master development branch) installed | ||
| under `/usr/local`. | ||
|
|
||
| # Tpetra Wrappers for deal.II | ||
|
|
||
| This GitHub repository contains the basic Tpetra wrappers, which act as an interface from deal.II to Trilinos. | ||
| The contributions of the TpetraWrappers are listed below. | ||
| Note that the namespace prefix LinearAlgebra:: was neglected on all mentioned TpetraWrappers symbols for readability: | ||
| - An extension of the TpetraWrappers::Vector | ||
| - The TpetraWrappers::Vector class has been overhauled | ||
| - A first version of TpetraWrappers::SparseMatrix and TpetraWrappers::SparsityPattern have been implemented, mirroring the functionality of the corresponding Epetra-based classes. | ||
| - The framework for block classes was added, including TpetraWrappers::BlockVector and the TpetraWrappers::BlockSparseMatrix. | ||
|
|
||
| The starting point for this work was the branch [dealii-9.5](https://github.com/dealii/dealii/tree/dealii-9.5) (based on the commit: 9e847302b21355f355c87890477f4dd485da26b1). | ||
|
|
||
| The Tpetra Wrappers were further developed by the other deal.II developers and are part of the deal.II version 9.6. | ||
| A patch to the cmake files was added so this preview would work. |