CHANGELOG.md 3.21 KB
Newer Older
Lukas Riedel's avatar
Lukas Riedel committed
1 2
# DORiE Changelog

Lukas Riedel's avatar
Lukas Riedel committed
3

Lukas Riedel's avatar
Lukas Riedel committed
4 5
## Unreleased

Lukas Riedel's avatar
Lukas Riedel committed
6 7 8 9 10 11 12
### Added
* Documentation of Docker images and their usage in the CI/CD pipeline.

### Changed
* Rebuilds of the DUNE environment Docker image are now triggered by setting the
    CI variable `REBUILD_BASE_IMAGE` to a non-empty value. Previously, the
    builds in stage `setup` where triggered by any manual pipeline run.
Lukas Riedel's avatar
Lukas Riedel committed
13 14 15 16 17
* `Simulation` is renamed `RichardsSimulation` and moved to 
	[richards_simulation.hh](dune/dorie/interface/richards_simulation.hh).
* `RichardsSimulation` now has its own `RichardsSimulationTraits` derived from
    `BaseTraits`, which defines all its member types. `BaseTraits` now have
    reduced content and are intended to be shared between models/simulations.
Lukas Riedel's avatar
Lukas Riedel committed
18

Lukas Riedel's avatar
Lukas Riedel committed
19 20 21 22
### Fixed
* Removed VTK output from `dorie_mass_conservation` executable, which would
    cause the corresponding test to fail if the designated output directory did
    not exist.
Lukas Riedel's avatar
Lukas Riedel committed
23
* Removed CI artifacts of `test` stage from `deploy` jobs.
Lukas Riedel's avatar
Lukas Riedel committed
24 25 26
* Correctly estimate the number of row entries in the matrix backend based on
    the DG discretization and proper static blocking. This can lead to a
    performance improvement for large problems.
Lukas Riedel's avatar
Lukas Riedel committed
27 28 29
* VTK output is now written _before_ the grid is adapted. Previously, the output
    displayed the adapted grid and not the one the solution was computed on.
* Grid adaptation is skipped after computing the final solution.
Santiago Ospina's avatar
Santiago Ospina committed
30
* CI artifacts folder od `test` now is exporting the right files.
Lukas Riedel's avatar
Lukas Riedel committed
31

Lukas Riedel's avatar
Lukas Riedel committed
32

Lukas Riedel's avatar
Lukas Riedel committed
33
## 1.1.0 (2018-07-27)
Lukas Riedel's avatar
Lukas Riedel committed
34

Lukas Riedel's avatar
Lukas Riedel committed
35
### Added
Lukas Riedel's avatar
Lukas Riedel committed
36 37
* DORiE now employs a `SubsamplingVTKWriter` for higher output precision.
    Subsampling levels are controlled via the new key `output.subsamplingLevel`.
Santiago Ospina's avatar
Santiago Ospina committed
38 39 40
* Automatic deployment of `devel` and stable DORiE Docker Images to Docker Hub.
* Automatic update of the DUNE environment Docker Image for `master` builds.
* CI pipeline now also compiles a Debug build with the LLVM Clang compiler.
Lukas Riedel's avatar
Lukas Riedel committed
41
* Add `.gitattributes` for `CHANGELOG.md` to reduce merge conflicts with
Santiago Ospina's avatar
Santiago Ospina committed
42
    `merge=union`.
Lukas Riedel's avatar
Lukas Riedel committed
43
* Public API definition in documentation.
Lukas Riedel's avatar
Lukas Riedel committed
44

Lukas Riedel's avatar
Lukas Riedel committed
45
### Changed
Santiago Ospina's avatar
Santiago Ospina committed
46
* Update code base to *DUNE v2.6*.
Lukas Riedel's avatar
Lukas Riedel committed
47
* Raise software requirements to versions available on Ubuntu 18.04 LTS
Santiago Ospina's avatar
Santiago Ospina committed
48 49
    (Bionic Beaver).
* Switch VTK output from conforming to non-conforming.
Lukas Riedel's avatar
Lukas Riedel committed
50
* Use `multicore` build tag only for `test:parallel` build because the current
Santiago Ospina's avatar
Santiago Ospina committed
51
    GitLab Runner cannot handle the load.
Lukas Riedel's avatar
Lukas Riedel committed
52 53
* Use the `OVLP_AMG_4_DG` linear solver for all computations, including
    sequential ones. This significantly improves performance for large problems.
Lukas Riedel's avatar
Lukas Riedel committed
54
* Change compilation order which reduces RAM usage when compiling in parallel.
Santiago Ospina's avatar
Santiago Ospina committed
55
* Decentralization of the header system so that in most of the header files are 
Santiago Ospina's avatar
Santiago Ospina committed
56
	independent of each other.
Lukas Riedel's avatar
Lukas Riedel committed
57 58 59 60 61

### Deprecated
* `output.subsamplingLevel` is optional and defaults to 0 if not given
    explicitly in the config file. The key will become mandatory in future
    versions.
Lukas Riedel's avatar
Lukas Riedel committed
62

Lukas Riedel's avatar
Lukas Riedel committed
63 64
### Removed
* Complete doxygen documentation from Sphinx docs.
Lukas Riedel's avatar
Lukas Riedel committed
65

Lukas Riedel's avatar
Lukas Riedel committed
66
### Fixed
Lukas Riedel's avatar
Lukas Riedel committed
67 68
* The source code is now compatible to the Clang LLVM compiler.
    DORiE can now be compiled with the onboard compiler on macOS.
Lukas Riedel's avatar
Lukas Riedel committed
69 70
* Fix finite element map used for simplex grids. The old one did not implement
    a discontinuous function space.
Lukas Riedel's avatar
Lukas Riedel committed
71
* Allow warnings on ParMETIS not being available for parallel computations.
Lukas Riedel's avatar
Lukas Riedel committed
72 73


Lukas Riedel's avatar
Lukas Riedel committed
74 75
## 1.0.0 (2018-03-28)

Santiago Ospina's avatar
Santiago Ospina committed
76
First stable version.