From 4a0c5866b37afc22c54ed5f0474e443be4309c23 Mon Sep 17 00:00:00 2001 From: Sebastian Kinnewig Date: Tue, 24 Sep 2024 22:31:38 +0200 Subject: [PATCH] Update the README. --- README.md | 100 ++++++++---------------------------------------------- 1 file changed, 14 insertions(+), 86 deletions(-) diff --git a/README.md b/README.md index d3a9cf654497..67b9a8735610 100644 --- a/README.md +++ b/README.md @@ -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 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 | ![indent](https://github.com/dealii/dealii/workflows/indent/badge.svg) | using GitHub actions | -| Linux serial | [![Build Status](https://ci.tjhei.info/job/dealii-serial/job/master/badge/icon)](https://ci.tjhei.info/job/dealii-serial/job/master/) | See https://ci.tjhei.info | -| Linux MPI | [![Build Status](https://ci.tjhei.info/job/dealii-mpi/job/master/badge/icon)](https://ci.tjhei.info/job/dealii-mpi/job/master/) | See https://ci.tjhei.info | -| MacOS | [![Build Status](https://ci.tjhei.info/job/dealii-OSX/job/master/badge/icon)](https://ci.tjhei.info/job/dealii-OSX/job/master/) | See https://ci.tjhei.info | -| Linux | [![Build Status](https://github.com/dealii/dealii/workflows/github-linux/badge.svg)](https://github.com/dealii/dealii/actions?query=workflow%3Agithub-linux) | See https://github.com/dealii/dealii/actions | -| MacOS | [![Build Status](https://github.com/dealii/dealii/workflows/github-OSX/badge.svg)](https://github.com/dealii/dealii/actions?query=workflow%3Agithub-OSX) | See https://github.com/dealii/dealii/actions | -| MSVC | [![Build status](https://github.com/dealii/dealii/workflows/github-windows/badge.svg)](https://github.com/dealii/dealii/actions?query=workflow%3Agithub-windows) | See https://github.com/dealii/dealii/actions | -| Docker | [![Build status](https://github.com/dealii/dealii/workflows/github-docker/badge.svg)](https://github.com/dealii/dealii/actions?query=workflow%3Agithub-docker) | See https://github.com/dealii/dealii/actions | -| CDash | [![cdash](https://img.shields.io/website?down_color=lightgrey&down_message=offline&label=CDash&up_color=green&up_message=up&url=https%3A%2F%2Fcdash.dealii.org%2Findex.php%3Fproject%3Ddeal.II)](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.