.gitignore

-*.log
-*.o
-*.trs
+# SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
+# SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
+
 *~
-.deps/
-.libs/
-/aclocal.m4
-/am
-/autom4te.cache/
-/build-*/
-/compile
-/config.guess
-/config.h
-/config.h.in
-/config.log
-/config.lt
-/config.status
-/config.sub
-/configure
-/configure.lineno
-/depcomp
-/dependencies.m4
-/dune-istl-*.tar.gz
-/dune-istl-?.?/
-/dune-istl.pc
-/install-sh
-/libtool
-/ltmain.sh
-/missing
-/mkinstalldirs
-/stamp-h1
-/test-driver
-Makefile
-Makefile.in
-semantic.cache
\ No newline at end of file
+/build*/
+# ignore files generated during python setup.py sdist
+MANIFEST
+_skbuild/
+dist
+*.egg-info/
+# ignore macOS filesystem
+.DS_Store

.gitlab-ci.yml

+# SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
+# SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
+
+---
+include:
+  - project: 'core/ci-config'
+    ref: master
+    file: 'config/common/master.yml'
+  - project: 'core/ci-config'
+    ref: master
+    file: 'jobs/common/master.yml'
+
+before_script:
+  - duneci-install-module https://gitlab.dune-project.org/core/dune-common.git
+
+variables:
+# Suitesparse, as installed with Debian, is thread-parallel using OpenMP.
+# OpenMP silently assumes, it can spawn as many threads as there are cores.
+# In a worst case scenario, this leads to a number of threads quadratic in
+# the core count, if you also do parallel test execution with the maximum
+# number of cores. We solve the issue by disallowing OpenMP to allocate more
+# than one thread.
+  OMP_NUM_THREADS: 1
+
+# Check for spelling mistakes in text
+code-spelling-check:
+  stage: .pre
+  # Avoid the global 'before_script'
+  before_script: ""
+  image: registry.dune-project.org/docker/ci/debian:11
+  tags: [duneci]
+  script:
+  - codespell
+    --ignore-words-list ba,eiter,equil,fo,parms
+
+reuse:
+  stage: .pre
+  image:
+    name: docker.io/fsfe/reuse:latest
+    entrypoint: [""]
+  tags: [duneci]
+  before_script: ""
+  script:
+    - reuse lint

CHANGELOG.md

+<!--
+SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
+SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
+-->
+
+# Master (will become release 2.11)
+
+- `FastAMG` can now be used with non-nested matrices of type `BCRSMatrix<T>`
+  where `T` is a plain number type instead of `FieldMatrix<T,m,n>`.
+
+# Release 2.10
+
+- Improve testing support on Laplacian matrices with an optional diagonal regularization parameter.
+
+- Base the implementation of `VariableBlockVector` on `std::vector` as the storage type. Note that
+  this prevents from using `bool` as block type that was possible before.
+
+- A method `BCRSMatrix::setIndicesNoSort()` was added. Similar
+  to `BCRSMatrix::setIndices()` this allows to insert all indices
+  of a row at once, but - incontrast to the latter - does not sort them.
+  This allows to speed up insertion if indices are already sorted.
+
+- `UMFPACK` is extended to arbitrary blocked matrix structures. This includes `MultiTypeBlockMatrix`. The external interface is unchanged.
+  However, internally the `BCCSMatrixInitializer` is replaced by direct calls of `flatMatrixForEach` similar to `Cholmod`. This requires a
+  compatible vector field of "ignored" degrees of freedom. The method `setSubMatrix` with a top-level index set is preserved for compatibility.
+
+- The internal storage in `MatrixIndexSet` was changed from `std::set` to a sorted `std::vector`
+  (with a `std::set` fallback for very dense rows) to improve performance. The stored index
+  type was changed from `std::size_t` to `uint32_t` to reduce memory consumption and improve
+  performance. Hence, `MatrixIndexSet` can no longer be used for very large matrices with more
+  than 2^32 columns.
+
+- Added flag 'useFixedOrder' to the coarsen method of AMGs ParallelIndicesCoarsener.
+  If set to true, during the creation of the coarser matrix (by accumulation and restriction
+  to fewer processes) the coarse matrix rows are ordered in a fixed manner, making parallel runs
+  reproducible; the runtime is possibly not ideal though.
+  If set to false (which is the default), the row order depends on the order of messages received from the
+  processes responsible for the respective parts of the finer grid. Then the indices on the coarser grid
+  may differ from run to run.
+
+- Define `field_type` and `real_type` in `MultiTypeBlock[Matrix|Vector]` only if a common type of these
+  types exist over all blocks in the container. Otherwise it is defined as `Std::nonesuch`.
+
+## Deprecations and removals
+
+- The deprecated CMake variables `SUPERLU_INCLUDE_DIRS`, `SUPERLU_LIBRARIES`,
+  `SUPERLU_DUNE_COMPILE_FLAGS`, and `SUPERLU_DUNE_LIBRARIES` are removed, they are
+  replaced by the target `SuperLU::SuperLU`.
+
+- Multiple containers no longer provide the deprecated member function `blocklevel`. Use the free function
+  `blockLevel()`.
+
+- Removed deprecated function `initSolverFactories()`, use `initSolverFactories<O>` instead.
+
+- Removed deprecated `MultyTypeBlockMatrix::size()`, use `N()` instead.
+
+- Removed deprecated `MultyTypeBlockVector::count()`, use `N()` instead.
+
+- Deprecated `writeSVGMatrix` with `std::stream` as the second argument. Use the method
+  with `std::stream` as the first argument.
+
+
+# Release 2.9
+
+- Add `const` qualifier to `LinearOperator` and `ScalarProduct` in
+  `IterativeSolver`. In particular, the constructors of iterative solvers have
+  changed.
+
+- Solvers are more robust if used with multiple right-hand sides and one lane starts with the exact solution.
+
+- Added a function to write nested matrices as SVG objects: `writeSVGMatrix(...)`
+
+- `MultiTypeBlockVector` uses now `std::common_type` of the entries for the `field_type`. The old `double`
+  default is replaced by `Std::nonesuch` of an empty `MultiTypeBlockVector`.
+
+- All vector implementations require a `FieldTraits` class specialization to export `field_type` and `real_type`
+  in order to work with blocked ISTL vector types.
+
+- MINRES: The algorithm computes the preconditioned defect during the iterations. However, the initial
+  defect was computed as the defect of the original/non-preconditioned system. This is now changed so
+  that the initial defect is also computed as the preconditioned defect (this is also in line with GMRes).
+  In some numerical tests with a Stokes system this lead to earlier termination when using the same
+  termination criterion.
+
+- The `Cholmod` class now provides access to the `cholmod_factor` class that is
+  used by `CHOLMOD` itself to store the Cholesky factor.  This can be used to
+  use the more advanced features of `CHOLMOD`.
+
+- The `Cholmod` class now has an additional template parameter `Index`, which specifies the
+  type used by `CHOLMOD` for integers.  The types `int` (the default) and `SuiteSparse_long`
+  (which is usually `long int`) are supported.  Use `SuiteSparse_long` if your problems
+  are too big for `int`.
+
+- You can now multiply objects of type `ScaledIdentityMatrix` by scalars
+  using `operator*`.
+
+- You can now use `std::tuple_element` to get the types of `MultiTypeBlockVector` entries
+  and `MultiTypeBlockMatrix` rows.
+
+- The SPQR solver can now work with non-square matrices (a bug which caused a segfault when previously
+  attempting to do it was found and resolved).
+
+## Deprecations and removals
+
+- The deprecated ILU functions `bilu_backsolve`, `bilu0_decomposition`, `bilu_backsolve`,
+  `firstmatrixelement`, and `bilu_decomposition` are removed. Use their camel case
+  replacements.
+
+- Remove deprecated `ImplicitModeOverflowExhausted`, use
+  `ImplicitModeCompressionBufferExhausted` instead.
+
+
+# Release 2.8
+
+- Extended the MatrixMarket IO functions for reading and writing vectors with
+  SIMD field_type as tall-skinny matrices.
+
+- Added public access of the `cholmod_common` object in class `Cholmod`.
+
+- Python bindings have been moved from the `dune-python` module which is now
+  obsolete.
+  Note that for `dune-istl` bindings are still very much work in progress.
+  To activate Python bindings the CMake flag
+  `DUNE_ENABLE_PYTHONBINDINGS` needs to be turned on (default is off).
+  Furthermore, flags for either shared library or position independent code
+  needs to be used.
+
+- Added new utility functions templates `maxBlockLevel`, `minBlockLevel`, `blockLevel` in `dnue/istl/blocklevel.hh` to
+  automatically determine the block level of possibly nested ISTL vectors & matrices at compile time.
+  The block level cannot be always uniquely determined for `MultiTypeBlockMatrix`/`MultiTypeBlockVector` since the nesting level
+  of different block types might differ. Hence, `maxBlockLevel`, `minBlockLevel` always works
+  but if they yield different results `blockLevel` will not compile.
+  This condition can be checked with the function template `hasUniqueBlockLevel`.
+
+- The internal setup code of the various SuiteSparse solvers (like `UMFPack`)
+  has been cleaned up.  The effects should be invisible to all regular users.
+  However, if you have happened to use the `ColCompMatrix` and `ColCompMatrixInitializer`
+  classes in the past you need to port your code to use `Impl::BCCSMatrix` and
+  `Impl::BCCSMatrixInitializer` instead.  Their interfaces have changed a little bit;
+  please look at the class documentation for details.  The old header `colcompmatrix.hh`
+  is still there, but backward compatibility is only partial.
+
+- More implementation code of the ILU preconditioners (in `ilu.hh`) has moved
+  into the `ILU` namespace.  With the move, some methods have changed their names
+  from std-style to CamelCase.  The old methods are still there, but they are
+  deprecated now. The class `MatrixBlockError` has moved from the file `ilu.hh`
+  to the file `istlexception.hh`, because it is of wider interest.
+
+- Added the routines `flatVectorForEach` and `flatMatrixForEach` that traverse a (blocked) vector or matrix container.
+  At each entry a functor is called taking the entry and the (flat) index offset.
+
+- `Cholmod` solver can now be used with each blocked matrix/vector type compatible with `flatVectorForEach` and `flatMatrixForEach`.
+
+## Deprecations and removals
+- Drop deprecated bindings of direct solver Pardiso.
+
+- Remove deprecated preconditioner implementations `SeqILU0` and `SeqILUn`. Use
+  `SeqILU` instead, which implements incomplete LU decomposition of any order.
+
+- Remove deprecated methods 'BlockVector::resize' and 'BlockVector::reserve'
+  with two arguments.
+
+- Drop support SuperLU 4.
+
+- Rename the exception `ImplicitModeOverflowExhausted` to `ImplicitModeCompressionBufferExhausted`,
+  to better reflect its meaning.  The old exception is still there, but it triggers
+  a deprecation warning.
+
+- Remove deprecated `SequentialInformation::getSolverCategory()`, use
+  `category()` instead.
+
+## Known issues
+
+- SuiteSparse's threading tends to conflict with the threading from OpenBLAS. The
+  author of SuiteSparse reports cases of an
+  [100 fold slowdown](https://github.com/DrTimothyAldenDavis/SuiteSparse/issues/1)
+  for cholmod. See also
+  [dune-istl #91](https://gitlab.dune-project.org/core/dune-istl/-/issues/91).
+
+# Release 2.7
+
+- New `SolverFactory` for generating sequential direct or iterative solvers and
+  preconditioners from a `ParameterTree` configuration.
+
+- `BDMatrix` objects now have the method `solve`, which implements that
+  canonical way to solve block-diagonal linear systems.
+
+- The class `VariableBlockVector::CreateIterator` is a true STL output iterator now.
+  This means that you can use STL algorithms like `std::fill` or `std::copy`
+  to set the block sizes.
+
+- `MultiTypeBlockVector<Args...>` now inherits the constructors from its
+  parent type (`std::tuple<Args...>`). This means you can now also construct
+  `MultiTypeBlockVector`s from values or references of BlockVectors.
+
+- All matrix and vector classes can now be instantiated with number types
+  directly (A number type is any type for which `Dune::IsNumber<T>::value`
+  is true).  For example, you can now use `BlockVector<double>` instead of
+  the more cumbersome `BlockVector<FieldVector<double,1> >`.  Similarly, you can use
+  `BCRSMatrix<double>` instead of `BCRSMatrix<FieldMatrix<double,1,1>>`.
+  The old forms still work, and `FieldVector` and `FieldMatrix` types with
+  a single entry can still be cast to their `field_type`.  Therefore, the
+  change is completely backward-compatible.
+
+- Added a right-preconditioned flexible restarted GMRes solver
+
+- The UMFPack binding use the long int functions to compute larger systems.
+  With the \*_dl_\* versions instead of the \*_di_\* versions UMFPACK will not
+  have a memory limit of just 2 GiB.
+
+- Support for SuiteSparse's CHOLMOD providing a sparse Cholesky
+  factorization.
+
+- The interface methods `dot()` and `norm()` of ScalarProduct are now `const`. You will
+  have to adjust the method signatures in your own scalar product implementations.
+
+- `MultiTypeBlockVector` now implements the interface method `N()`, which
+  returns the number of vector entries.
+
+- `MultiTypeBlockVector` now implements the interface method `dim()`, which
+  returns the number of scalar vector entries.
+
+- `MultiTypeBlockVector::count()` is now `const`
+
+- `SeqILU` can now be used with SIMD data types.
+
+## Deprecations and removals
+
+- Deprecated support for SuperLU 4.x. It will be removed after Dune 2.7.
+
+- Deprecated the preconditioner implementations `SeqILU0` and `SeqILUn`.
+  Use `SeqILU` instead, which implements incomplete LU decomposition
+  of any order.
+
+- The method `setSolverCategory` of `OwnerOverlapCopyCommunication` is deprecated and
+  will be removed after Dune 2.7. The solver category can only be set in the constructor.
+
+- The method `getSolverCategory` of `OwnerOverlapCopyCommunication` is deprecated and
+  will be removed after Dune 2.7. Use `category()` instead.
+
+- The method `MultiTypeBlockVector::count()` has been deprecated, because its name
+  is inconsistent with the name mandated by the `dune-istl` vector interface.
+
+- The method `MultiTypeBlockMatrix::size()` has been deprecated, because its name
+  is inconsistent with the name mandated by the `dune-istl` vector interface.
+
+# Release 2.6
+
+- `BDMatrix` objects can now be constructed and assigned from `std::initializer_list`.
+
+- `BDMatrix` and `BTDMatrix` now implement the `setSize` method, which allows to
+  resize existing matrix objects.
+
+- The solver infrastructure was updated to support SIMD data types (see
+  current changes in `dune-common`). This allows to solve multiple systems
+  simultaneously using vectorization.

CMakeLists.txt

-# set up project
-project("dune-istl" C CXX)
+# SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
+# SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
 
-# general stuff
-cmake_minimum_required(VERSION 2.8.6)
+cmake_minimum_required(VERSION 3.16)
+project(dune-istl C CXX)
 
 # guess build tree of dune-common
 if(NOT (dune-common_DIR OR dune-common_ROOT OR
@@ -20,13 +20,32 @@ list(APPEND CMAKE_MODULE_PATH ${dune-common_MODULE_PATH}
 #include the dune macros
 include(DuneMacros)
 
+# deactivate global include-directories
+dune_policy(SET DP_DEFAULT_INCLUDE_DIRS NEW)
+
+# deactivate global calls to add_dune_all_flags in tests
+dune_policy(SET DP_TEST_ADD_ALL_FLAGS NEW)
+
 # start a dune project with information from dune.module
 dune_project()
 
-add_subdirectory("cmake/modules")
-add_subdirectory("m4")
-add_subdirectory("dune")
-add_subdirectory("doc")
+# create library target and export it as Dune::ISTL
+dune_add_library(duneistl INTERFACE
+  EXPORT_NAME ISTL
+  LINK_LIBRARIES Dune::Common)
+
+# set include directories to target
+dune_default_include_directories(duneistl INTERFACE)
+
+add_subdirectory(cmake/modules)
+add_subdirectory(dune)
+add_subdirectory(doc)
+add_subdirectory(src)
+
+# if Python bindings are enabled, include necessary sub directories.
+if( DUNE_ENABLE_PYTHONBINDINGS )
+  add_subdirectory(python)
+endif()
 
 # finalize the dune project, e.g. generating config.h etc.
-finalize_dune_project(GENERATE_CONFIG_H_CMAKE)
+finalize_dune_project()

COPYING

-Copyright holders:
-
-2003--2013    Peter Bastian
-2004--2014    Markus Blatt
-2014          Ansgar Burchardt
-2004--2005    Adrian Burri
-2008--2014    Andreas Dedner
-2003--2014    Christian Engwer
-2005--2012    Jorrit Fahlke
-2008--2013    Bernd Flemisch
-2005--2013    Carsten Gräser
-2012--2014    Christoph Grüninger
-2012--2013    Olaf Ippisch
-2013--2014    Dominic Kempf
-2004--2013    Robert Klöfkorn
-2013--2014    Arne Morten Kvarving (SINTEF)
-2009--2013    Andreas Lauser
-2012--2014    Tobias Malkmus
-2007--2009    Sven Marnach
-2013          Rene Milk
-2013--2014    Steffen Müthing
-2003--2005    Thimo Neubauer
-2010--2012    Rebecca Neumann
-2012--2014    Andreas Nüßing
-2008--2014    Martin Nolte
-2014          Marian Piatkowski
-2011--2013    Elias Pipping
-2013          Jurgis Pods
-2007          Sreejith Pulloor Kuttanikkad
-2009          Atgeirr Rasmussen
-2008--2013    Uli Sack
-2004--2014    Oliver Sander
-2013          Bård Skaflestad
-2006--2010    Martin Weiser
-2011--2012    Matthias Wohlmuth
-2014          Jonathan Youett
-
-The DUNE library and headers are licensed under version 2 of the GNU
-General Public License (see below), with a special exception for
-linking and compiling against DUNE, the so-called "runtime exception."
-The license is intended to be similar to the GNU Lesser General
-Public License, which by itself isn't suitable for a template library.
-
-The exact wording of the exception reads as follows:
-
-   As a special exception, you may use the DUNE source files as part
-   of a software library or application without restriction.
-   Specifically, if other files instantiate templates or use macros or
-   inline functions from one or more of the DUNE source files, or you
-   compile one or more of the DUNE source files and link them with
-   other files to produce an executable, this does not by itself cause
-   the resulting executable to be covered by the GNU General Public
-   License.  This exception does not however invalidate any other
-   reasons why the executable file might be covered by the GNU General
-   Public License.
-
-
-		    GNU GENERAL PUBLIC LICENSE
-		       Version 2, June 1991
-
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.
- 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-			    Preamble
-
-  The licenses for most software are designed to take away your
-freedom to share and change it.  By contrast, the GNU General Public
-License is intended to guarantee your freedom to share and change free
-software--to make sure the software is free for all its users.  This
-General Public License applies to most of the Free Software
-Foundation's software and to any other program whose authors commit to
-using it.  (Some other Free Software Foundation software is covered by
-the GNU Library General Public License instead.)  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
-if you want it, that you can change the software or use pieces of it
-in new free programs; and that you know you can do these things.
-
-  To protect your rights, we need to make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
-These restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must give the recipients all the rights that
-you have.  You must make sure that they, too, receive or can get the
-source code.  And you must show them these terms so they know their
-rights.
-
-  We protect your rights with two steps: (1) copyright the software, and
-(2) offer you this license which gives you legal permission to copy,
-distribute and/or modify the software.
-
-  Also, for each author's protection and ours, we want to make certain
-that everyone understands that there is no warranty for this free
-software.  If the software is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original, so
-that any problems introduced by others will not reflect on the original
-authors' reputations.
-
-  Finally, any free program is threatened constantly by software
-patents.  We wish to avoid the danger that redistributors of a free
-program will individually obtain patent licenses, in effect making the
-program proprietary.  To prevent this, we have made it clear that any
-patent must be licensed for everyone's free use or not licensed at all.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-		    GNU GENERAL PUBLIC LICENSE
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-  0. This License applies to any program or other work which contains
-a notice placed by the copyright holder saying it may be distributed
-under the terms of this General Public License.  The "Program", below,
-refers to any such program or work, and a "work based on the Program"
-means either the Program or any derivative work under copyright law:
-that is to say, a work containing the Program or a portion of it,
-either verbatim or with modifications and/or translated into another
-language.  (Hereinafter, translation is included without limitation in
-the term "modification".)  Each licensee is addressed as "you".
-
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope.  The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
-Whether that is true depends on what the Program does.
-
-  1. You may copy and distribute verbatim copies of the Program's
-source code as you receive it, in any medium, provided that you
-conspicuously and appropriately publish on each copy an appropriate
-copyright notice and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
-
-You may charge a fee for the physical act of transferring a copy, and
-you may at your option offer warranty protection in exchange for a fee.
-
-  2. You may modify your copy or copies of the Program or any portion
-of it, thus forming a work based on the Program, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
-    a) You must cause the modified files to carry prominent notices
-    stating that you changed the files and the date of any change.
-
-    b) You must cause any work that you distribute or publish, that in
-    whole or in part contains or is derived from the Program or any
-    part thereof, to be licensed as a whole at no charge to all third
-    parties under the terms of this License.
-
-    c) If the modified program normally reads commands interactively
-    when run, you must cause it, when started running for such
-    interactive use in the most ordinary way, to print or display an
-    announcement including an appropriate copyright notice and a
-    notice that there is no warranty (or else, saying that you provide
-    a warranty) and that users may redistribute the program under
-    these conditions, and telling the user how to view a copy of this
-    License.  (Exception: if the Program itself is interactive but
-    does not normally print such an announcement, your work based on
-    the Program is not required to print an announcement.)
-
-These requirements apply to the modified work as a whole.  If
-identifiable sections of that work are not derived from the Program,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works.  But when you
-distribute the same sections as part of a whole which is a work based
-on the Program, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
-
-In addition, mere aggregation of another work not based on the Program
-with the Program (or with a work based on the Program) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
-  3. You may copy and distribute the Program (or a work based on it,
-under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you also do one of the following:
-
-    a) Accompany it with the complete corresponding machine-readable
-    source code, which must be distributed under the terms of Sections
-    1 and 2 above on a medium customarily used for software interchange; or,
-
-    b) Accompany it with a written offer, valid for at least three
-    years, to give any third party, for a charge no more than your
-    cost of physically performing source distribution, a complete
-    machine-readable copy of the corresponding source code, to be
-    distributed under the terms of Sections 1 and 2 above on a medium
-    customarily used for software interchange; or,
-
-    c) Accompany it with the information you received as to the offer
-    to distribute corresponding source code.  (This alternative is
-    allowed only for noncommercial distribution and only if you
-    received the program in object code or executable form with such
-    an offer, in accord with Subsection b above.)
-
-The source code for a work means the preferred form of the work for
-making modifications to it.  For an executable work, complete source
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable.  However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
-
-If distribution of executable or object code is made by offering
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
-  4. You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License.  Any attempt
-otherwise to copy, modify, sublicense or distribute the Program is
-void, and will automatically terminate your rights under this License.
-However, parties who have received copies, or rights, from you under
-this License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-  5. You are not required to accept this License, since you have not
-signed it.  However, nothing else grants you permission to modify or
-distribute the Program or its derivative works.  These actions are
-prohibited by law if you do not accept this License.  Therefore, by
-modifying or distributing the Program (or any work based on the
-Program), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
-
-  6. Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the
-original licensor to copy, distribute or modify the Program subject to
-these terms and conditions.  You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
-this License.
-
-  7. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Program at all.  For example, if a patent
-license would not permit royalty-free redistribution of the Program by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
-
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is
-implemented by public license practices.  Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
-  8. If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded.  In such case, this License incorporates
-the limitation as if written in the body of this License.
-
-  9. The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-Each version is given a distinguishing version number.  If the Program
-specifies a version number of this License which applies to it and "any
-later version", you have the option of following the terms and conditions
-either of that version or of any later version published by the Free
-Software Foundation.  If the Program does not specify a version number of
-this License, you may choose any version ever published by the Free Software
-Foundation.
-
-  10. If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author
-to ask for permission.  For software which is copyrighted by the Free
-Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this.  Our decision will be guided by the two goals
-of preserving the free status of all derivatives of our free software and
-of promoting the sharing and reuse of software generally.
-
-			    NO WARRANTY
-
-  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
-OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
-PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
-REPAIR OR CORRECTION.
-
-  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
-TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
-YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
-PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
-
-		     END OF TERMS AND CONDITIONS
-
-	    How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
-
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program is interactive, make it output a short notice like this
-when it starts in an interactive mode:
-
-    Gnomovision version 69, Copyright (C) year name of author
-    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, the commands you use may
-be called something other than `show w' and `show c'; they could even be
-mouse-clicks or menu items--whatever suits your program.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the program, if
-necessary.  Here is a sample; alter the names:
-
-  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
-  `Gnomovision' (which makes passes at compilers) written by James Hacker.
-
-  <signature of Ty Coon>, 1 April 1989
-  Ty Coon, President of Vice
-
-This General Public License does not permit incorporating your program into
-proprietary programs.  If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.

COPYING

+LICENSE.md
\ No newline at end of file

INSTALL

+<!--
+SPDX-FileCopyrightInfo: Copyright © DUNE Project contributors, see file LICENSE.md in module root
+SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
+-->
+
 Installation Instructions
 =========================
 
@@ -14,8 +19,8 @@ list of available modules.
 
 To compile the modules Dune has to check several components of
 your system and whether prerequisites within the modules are met. For
-the ease of users we have designed a custom build system on top of the
-automake tools. Run
+the ease of users we have designed a custom build system on top of CMake.
+Run
 
   ./dune-common/bin/dunecontrol all
 
@@ -37,7 +42,7 @@ need to run
 to install Dune (you may need root-permissions for the install
 part depending on the prefix set)
 
-A more comprehensive introduction to the build system can be found in [2].
+A more comprehensive introduction to the build system can be found in [0].
 
 Passing options to the build process
 ------------------------------------
@@ -45,50 +50,31 @@ Passing options to the build process
 Using the dunecontrol script the following atomic commands can be
 executed:
 
-- autogen (runs autogen in each module, only needed when downloaded
-  via svn)
-- configure (runs the configure tests for each module
-- exec (executes a command in each module directory)
-- make (runs make for each module)
-- update (updates the svn version)
+- configure (runs the CMake configuration tests for each module)
+- exec (executes a command in each module source directory)
+- bexec (executes a command in each module build directory)
+- make (builds each module)
+- update (updates the Git or Subversion version)
 
-The composite command all simply runs autogen, configure and make for
+The composite command all simply runs configure and make for
 each module.
 
-As it is often not convenient (and for the target all impossible) to
-specify the options for each command as parameters after the call, one
-can pass the options via file specified by the --opts=<file>
-option. For each atomic command one specify the options via a ine
-
-<COMMANY_UPPERCASE>_FLAGS=<flags> # e.g.: MAKE_FLAGS=install
-
-The available options for make and svn are the natural ones. The
-configure commands available can be found by issuing
-
-dunecontrol --only=dune-common configure --help
-
-and for autogen by
-
-dunecontrol --only=dune-common autogen --help
-
-(In the svn version this has to be calles after running autogen.)
+As it is often not convenient to specify the desired options after
+the duncontroll call, one can pass the options via a file specified
+by the --opts=<file> option. Specify the options via the variable
 
+  CMAKE_FLAGS=<flags>
 
 An example of an options file is
 
-  # use a special compiler (g++ version 3.4) and install to a custom
-  # directory, default is /usr/local/bin
-  CONFIGURE_FLAGS="CXX=g++-3.4 --prefix='/tmp/Hu Hu'"
-  # Set the default target of make to install. Now the call above will
-  # not just build the DUNE modules but also install it
-   MAKE_FLAGS=install
-  # The default versions of automake and autogen are not sufficient
-  # therefore we need to specify what versions to use
-  AUTOGEN_FLAGS="--ac=2.59 --am=1.9
+  # use a special compiler (g++ version 5.0),
+  # install to a custom directory, default is /usr/local/bin,
+  # disable the external library SuperLU,
+  # and use Ninja-build instead of make as the build-tool
+  CMAKE_FLAGS="-DCMAKE_CXX_COMPILER=g++-5 -DCMAKE_INSTALL_PREFIX='/tmp/HuHu' -DCMAKE_DISABLE_FIND_PACKAGE_SuperLU=true -GNinja"
 
 Links
 -----
 
-0. http://www.dune-project.org/doc/installation-notes.html
-1. http://www.dune-project.org/download.html
-2. http://dune-project.org/doc/buildsystem/buildsystem.pdf
+0. https://www.dune-project.org/doc/installation
+1. https://www.dune-project.org/releases

LICENSES/LicenseRef-GPL-2.0-only-with-DUNE-exception.txt

+The DUNE library and headers are licensed under version 2 of the GNU
+General Public License (see below), with a special exception for
+linking and compiling against DUNE, the so-called "runtime exception."
+The license is intended to be similar to the GNU Lesser General
+Public License, which by itself isn't suitable for a template library.
+
+The exact wording of the exception reads as follows:
+
+   As a special exception, you may use the DUNE source files as part
+   of a software library or application without restriction.
+   Specifically, if other files instantiate templates or use macros or
+   inline functions from one or more of the DUNE source files, or you
+   compile one or more of the DUNE source files and link them with
+   other files to produce an executable, this does not by itself cause
+   the resulting executable to be covered by the GNU General Public
+   License.  This exception does not however invalidate any other
+   reasons why the executable file might be covered by the GNU General
+   Public License.
+
+
+        GNU GENERAL PUBLIC LICENSE
+           Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+          Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+        GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+          NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+         END OF TERMS AND CONDITIONS
+
+      How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

Makefile.am

-# we need the module file to be able to build via dunecontrol
-EXTRA_DIST= CMakeLists.txt dune.module
-
-# don't follow the full GNU-standard
-# we need automake 1.9 or newer
-AUTOMAKE_OPTIONS = foreign 1.9
-
-SUBDIRS = cmake dune doc lib m4
-
-# use configured compiler for "make distcheck"
-# doxygen is difficult to convince to build in a special directory...
-DISTCHECK_CONFIGURE_FLAGS = --with-dune-common="$(DUNE_COMMON_ROOT)" CXX="$(CXX)" CC="$(CC)" --enable-parallel=@ENABLE_PARALLEL@ MPICC="$(MPICC)"
-
-include $(top_srcdir)/am/global-rules
-include $(top_srcdir)/am/top-rules
-
-# Distribute and install config.h.cmake
-configdir = $(datadir)/dune-istl
-dist_config_DATA = config.h.cmake
-
-include $(top_srcdir)/am/cmake-pkg-config

README

-DUNE-library
-============
-
-DUNE, the Distributed and Unified Numerics Environment is a modular toolbox
-for solving partial differential equations with grid-based methods.
-
-The main intention is to create slim interfaces allowing an efficient use of
-legacy and/or new libraries. Using C++ techniques DUNE allows to use very
-different implementation of the same concept (i.e. grid, solver, ...) under
-a common interface with a very low overhead.
-
-DUNE was designed with flexibility in mind. It supports easy discretization
-using methods, like Finite Elements, Finite Volume and also Finite
-Differences. Through separation of data structures DUNE allows fast Linear
-Algebra like provided in the ISTL module, or usage of external libraries
-like blas.
-
-This package contains the basic DUNE istl classes.
-
-Dependencies
-------------
-
-dune-istl depends on the following software packages
-
-- pkg-config
-- icc (C/C++) >= 7.0 or GNU C, C++ >=3.4
-- dune-common module
-
-The following software is recommend but optional:
-
-- MPI (either lam or mpich suffice)
-
-For a full explanation of the DUNE installation process please read
-the installation notes [0]. The following introduction is meant for
-the impatient.
-
-
-Known Bugs
-----------
-
-Due to a bug in all currently available OpenMPI versions, ISTL will
-crash when used with OpenMPI. For details see flyspray issue 497 http://www.dune-project.org/flyspray/index.php?do=details&task_id=497&project=1
-
-Please use either lam or mpich if you want to use the parallel version of ISTL.
-
-License
--------
-
-The DUNE-library and headers are licensed under version 2 of the GNU
-General Public License, with the so-called "runtime exception", as
-follows:
-
-   As a special exception, you may use the DUNE source files as part
-   of a software library or application without restriction.
-   Specifically, if other files instantiate templates or use macros or
-   inline functions from one or more of the DUNE source files, or you
-   compile one or more of the DUNE source files and link them with
-   other files to produce an executable, this does not by itself cause
-   the resulting executable to be covered by the GNU General Public
-   License.  This exception does not however invalidate any other
-   reasons why the executable file might be covered by the GNU General
-   Public License.
-
-This licence clones the one of the libstc++ library. For further
-implications of this library please see their licence page [3]
-
-See the file COPYING for full copying permissions.
-
-Installation
-------------
-
-Short installation instructions can be found in file INSTALL. For the
-full instructions please see [0].
-
-Links
------
-
-0. http://www.dune-project.org/doc/installation-notes.html
-1. http://www.dune-project.org/download.html
-2. http://dune-project.org/doc/buildsystem/buildsystem.pdf
-3. http://gcc.gnu.org/onlinedocs/libstdc++/faq.html#faq.license

README.SVN

-Preparing the SVN-sources
-=========================
-
-Additional to the software mentioned in README you'll need the
-following programs installed on your system:
-
-  automake >= 1.5
-
-  autoconf >= 2.50
-
-  libtool
-
-For the documentation to build you'll need doxygen, wml, convert and latex
-installed.
-
-Dune also features a self-test. As some grid-components (e.g. Albert,
-UG) depend on external libraries their self-tests will only run if
-those libraries are found. The pathes would then need to be passed via
---with-...= parameters.
-
-Important!  If you don't want to develop Dune itself you won't need to
-provide external components! The Dune-library and -headers are
-independent of other libraries, instead the applications can choose
-what parts to use.

README.md

+<!--
+SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
+SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
+-->
+
+DUNE-library
+============
+
+DUNE, the Distributed and Unified Numerics Environment is a modular toolbox
+for solving partial differential equations with grid-based methods.
+
+The main intention is to create slim interfaces allowing an efficient use of
+legacy and/or new libraries. Using C++ techniques DUNE allows to use very
+different implementation of the same concept (i.e. grid, solver, ...) under
+a common interface with a very low overhead.
+
+DUNE was designed with flexibility in mind. It supports easy discretization
+using methods, like Finite Elements, Finite Volume and also Finite
+Differences. Through separation of data structures DUNE allows fast Linear
+Algebra like provided in the ISTL module, or usage of external libraries
+like blas.
+
+This package contains the basic DUNE istl classes.
+
+More information
+----------------
+
+Check dune-common for more details concerning dependencies, known bugs,
+license and installation.

cmake/Makefile.am

-SUBDIRS= modules
-
-include $(top_srcdir)/am/global-rules

cmake/modules/AddARPACKPPFlags.cmake

+# SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
+# SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
+
 # Defines the functions to use ARPACKPP
 #
 # .. cmake_function:: add_dune_arpackpp_flags
@@ -9,15 +12,20 @@
 #
 #       A list of targets to use ARPACKPP with.
 #
+include_guard(GLOBAL)
+
+set_package_properties("ARPACK" PROPERTIES
+  PURPOSE "Solve large scale eigenvalue problems")
+
+set_package_properties("ARPACKPP" PROPERTIES
+  PURPOSE "C++ interface for ARPACK")
 
 function(add_dune_arpackpp_flags _targets)
   if(ARPACKPP_FOUND)
     foreach(_target ${_targets})
-      target_link_libraries(${_target} ${ARPACKPP_DUNE_LIBRARIES})
-      get_target_property(_props ${_target} COMPILE_FLAGS)
-      string(REPLACE "_props-NOTFOUND" "" _props "${_props}")
-      set_target_properties(${_target} PROPERTIES COMPILE_FLAGS
-        "${_props} ${ARPACKPP_DUNE_COMPILE_FLAGS} -DENABLE_ARPACKPP=1")
+      target_link_libraries(${_target} PUBLIC ${ARPACKPP_DUNE_LIBRARIES})
+      target_compile_definitions(${_target} PUBLIC HAVE_ARPACKPP=1)
+      target_compile_options(${_target} PUBLIC ${ARPACKPP_DUNE_COMPILE_FLAGS})
     endforeach()
   endif()
 endfunction(add_dune_arpackpp_flags)

cmake/modules/AddSuperLUFlags.cmake

+# SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
+# SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
+
 # Defines the functions to use SuperLU
 #
 # .. cmake_function:: add_dune_superlu_flags
@@ -9,19 +12,28 @@
 #
 #       A list of targets to use SuperLU with.
 #
+include_guard(GLOBAL)
+
+set_package_properties("SuperLU" PROPERTIES
+  PURPOSE "Direct solver for linear system, based on LU decomposition")
+
+# set HAVE_SUPERLU for config.h
+set(HAVE_SUPERLU ${SuperLU_FOUND})
+
+# register all SuperLU related flags
+if(SuperLU_FOUND)
+  dune_register_package_flags(
+    COMPILE_DEFINITIONS "HAVE_SUPERLU=1"
+    LIBRARIES SuperLU::SuperLU)
+endif()
 
-function(add_dune_superlu_flags)
-  if(SUPERLU_FOUND)
-    cmake_parse_arguments(_add_superlu "OBJECT" "" "" ${ARGN})
-    foreach(_target ${_add_superlu_UNPARSED_ARGUMENTS})
-      if(NOT _add_superlu_OBJECT)
-        target_link_libraries(${_target} ${SUPERLU_DUNE_LIBRARIES})
-      endif()
-      get_target_property(_props ${_target} COMPILE_FLAGS)
-      string(REPLACE "_props-NOTFOUND" "" _props "${_props}")
-      set_target_properties(${_target} PROPERTIES COMPILE_FLAGS
-        "${_props} ${SUPERLU_DUNE_COMPILE_FLAGS} -DENABLE_SUPERLU=1")
+# Provide function to set target properties for linking to SuperLU
+function(add_dune_superlu_flags _targets)
+  if(SuperLU_FOUND)
+    foreach(_target ${_targets})
+      target_link_libraries(${_target} PUBLIC SuperLU::SuperLU)
+      target_compile_definitions(${_target} PUBLIC HAVE_SUPERLU=1)
     endforeach()
-  endif(SUPERLU_FOUND)
+  endif()
 endfunction(add_dune_superlu_flags)
 

cmake/modules/CMakeLists.txt

+# SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
+# SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
+
 set(modules
   AddARPACKPPFlags.cmake
   AddSuperLUFlags.cmake

cmake/modules/DuneIstlMacros.cmake

+# SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
+# SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
+
 # .. cmake_module::
 #
 #    This modules content is executed whenever a module required or suggests dune-istl!
@@ -6,9 +9,11 @@
 find_package(METIS)
 find_package(ParMETIS)
 include(AddParMETISFlags)
-find_package(SuperLU)
+find_package(SuperLU 5.0)
 include(AddSuperLUFlags)
-find_package(SuiteSparse OPTIONAL_COMPONENTS UMFPACK)
-include(AddSuiteSparseFlags)
 find_package(ARPACKPP)
 include(AddARPACKPPFlags)
+
+# enable / disable backwards compatibility w.r.t. category
+set(DUNE_ISTL_SUPPORT_OLD_CATEGORY_INTERFACE 1
+  CACHE BOOL "Enable/Disable the backwards compatibility of the category enum/method in dune-istl solvers, preconditioner, etc. '1'")

cmake/modules/FindARPACK.cmake

+# SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
+# SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
+
 # .. cmake_module::
 #
 #    Module that checks whether ARPACK is available and usable.
@@ -22,15 +25,10 @@
 #    system paths.
 #
 
-# check for Fortran support which is required by ARPACK
-if(NOT(Fortran_Works))
-  message(WARNING "Fortran doesn't seem to be supported, skipping search for ARPACK.")
-  # log errornous result
-  file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
-    "Determing location of ARPACK failed:\n"
-    "Fortran support is required but could not be detected\n\n")
-  return()
-endif()
+# text for feature summary
+set_package_properties("ARPACK" PROPERTIES
+  URL "https://www.arpack.org"
+  DESCRIPTION "ARnoldi PACKage")
 
 # look for library, only at positions given by the user
 find_library(ARPACK_LIBRARY
@@ -78,13 +76,13 @@ if(ARPACK_FOUND)
   set(ARPACK_LIBRARIES ${ARPACK_LIBRARY})
   # log result
   file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeOutput.log
-    "Determing location of ARPACK succeded:\n"
+    "Determining location of ARPACK succeeded:\n"
     "Libraries to link against: ${ARPACK_LIBRARIES}\n\n")
   set(ARPACK_DUNE_LIBRARIES ${ARPACK_LIBRARIES}
     CACHE STRING "Libraries used by DUNE when linking ARPACK programs")
 else()
-  # log errornous result
+  # log erroneous result
   file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
-    "Determing location of ARPACK failed:\n"
+    "Determining location of ARPACK failed:\n"
     "Libraries to link against: ${ARPACK_LIBRARIES}\n\n")
 endif()

cmake/modules/FindARPACKPP.cmake

+# SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
+# SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
+
 # .. cmake_module::
 #
 #    Module that checks whether ARPACK++ is available and usable.
@@ -25,6 +28,11 @@
 #    system paths.
 #
 
+# text for feature summary
+set_package_properties("ARPACKPP" PROPERTIES
+  URL "https://github.com/m-reuter/arpackpp"
+  DESCRIPTION "ARPACK++")
+
 # find ARPACK which is required by ARPACK++
 find_package(ARPACK)
 
@@ -97,27 +105,35 @@ if(ARPACKPP_FOUND)
   endif(ARPACKPP_LIBRARY)
   # log result
   file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeOutput.log
-    "Determing location of ARPACK++ succeded:\n"
+    "Determining location of ARPACK++ succeeded:\n"
     "Include directory: ${ARPACKPP_INCLUDE_DIRS}\n"
     "Libraries to link against: ${ARPACKPP_LIBRARIES}\n\n")
-  set(ARPACKPP_DUNE_COMPILE_FLAGS "-I${ARPACKPP_INCLUDE_DIRS}"
+
+  # the following is a pretty roundabout way of setting include directories, but it's the
+  # only way we can force -isystem. And we want the compiler to treat ARPACK++ as a system
+  # library to avoid scaring our users with the horrible warnings triggered by the bitrotted
+  # ARPACK++ sources.
+  #
+  # For this to work, only set the COMPILE_OPTIONS (those replaced COMPILE_FLAGS a while ago), never
+  # the INCLUDE_DIRECTORIES!
+  set(ARPACKPP_DUNE_COMPILE_FLAGS "$<$<BOOL:${ARPACKPP_INCLUDE_DIRS}>:-isystem$<JOIN:${ARPACKPP_INCLUDE_DIRS}, -isystem>>"
     CACHE STRING "Compile flags used by DUNE when compiling ARPACK++ programs")
   set(ARPACKPP_DUNE_LIBRARIES ${ARPACKPP_LIBRARIES}
     CACHE STRING "Libraries used by DUNE when linking ARPACK++ programs")
 else()
-  # log errornous result
+  # log erroneous result
   file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
-    "Determing location of ARPACK++ failed:\n"
+    "Determining location of ARPACK++ failed:\n"
     "Include directory: ${ARPACKPP_INCLUDE_DIRS}\n"
     "Libraries to link against: ${ARPACKPP_LIBRARIES}\n\n")
 endif()
 
-# set HAVE_ARPACKPP for config.h
+# set HAVE_ARPACKPP for conditional tests
 set(HAVE_ARPACKPP ${ARPACKPP_FOUND})
 
 # register all ARPACK++ related flags
 if(ARPACKPP_FOUND)
-  dune_register_package_flags(COMPILE_DEFINITIONS "ENABLE_ARPACKPP=1"
+  dune_register_package_flags(COMPILE_DEFINITIONS "HAVE_ARPACKPP=1"
                               LIBRARIES "${ARPACKPP_LIBRARIES}"
-                              INCLUDE_DIRS "${ARPACKPP_INCLUDE_DIRS}")
+                              COMPILE_OPTIONS "${ARPACKPP_DUNE_COMPILE_FLAGS}")
 endif()