CHANGELOG.md 4.05 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.
Santiago Ospina's avatar
Santiago Ospina committed
18 19 20 21 22 23 24 25 26 27 28
* `RichardsSimulation` now uses one vector of coefficients instead of two, which
    now is a `shared_ptr` instead a `unique_ptr`.
* Every `VTKAdapter` is now able to be used as `GridFunctionAdapter` of the
    solution vector.
* `GradientFluxAdapter` was reimplemented and renamed `WaterFluxAdapter`.
* Every grid function adapter has its own file and are gathered in the 
    subdirectory [dune/dorie/solver/adapters](dune/dorie/solver/adapters)
* `VTKAdapters` are now managed with `shared_ptr` instead of references.
* `OutputWriter` class is deprecated in favor of an minimal extension of the 
    usual `VTKSequenceWriter` for grid functions called
    `GridFucntionVTKSequenceWriter`.
Lukas Riedel's avatar
Lukas Riedel committed
29

Lukas Riedel's avatar
Lukas Riedel committed
30 31 32 33
### 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
34
* Removed CI artifacts of `test` stage from `deploy` jobs.
Lukas Riedel's avatar
Lukas Riedel committed
35 36 37
* 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
38 39 40
* 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
41
* Adaptivity is done with the _current_ solution instead of the _previous_ one.
Lukas Riedel's avatar
Lukas Riedel committed
42 43
* Path to Pipeline artifacts for `test` stage. The artifacts are now correctly
    captured and can be viewed and downloaded from the GitLab web interface.
Lukas Riedel's avatar
Lukas Riedel committed
44

Lukas Riedel's avatar
Lukas Riedel committed
45

Lukas Riedel's avatar
Lukas Riedel committed
46
## 1.1.0 (2018-07-27)
Lukas Riedel's avatar
Lukas Riedel committed
47

Lukas Riedel's avatar
Lukas Riedel committed
48
### Added
Lukas Riedel's avatar
Lukas Riedel committed
49 50
* 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
51 52 53
* 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
54
* Add `.gitattributes` for `CHANGELOG.md` to reduce merge conflicts with
Santiago Ospina's avatar
Santiago Ospina committed
55
    `merge=union`.
Lukas Riedel's avatar
Lukas Riedel committed
56
* Public API definition in documentation.
Lukas Riedel's avatar
Lukas Riedel committed
57

Lukas Riedel's avatar
Lukas Riedel committed
58
### Changed
Santiago Ospina's avatar
Santiago Ospina committed
59
* Update code base to *DUNE v2.6*.
Lukas Riedel's avatar
Lukas Riedel committed
60
* Raise software requirements to versions available on Ubuntu 18.04 LTS
Santiago Ospina's avatar
Santiago Ospina committed
61 62
    (Bionic Beaver).
* Switch VTK output from conforming to non-conforming.
Lukas Riedel's avatar
Lukas Riedel committed
63
* Use `multicore` build tag only for `test:parallel` build because the current
Santiago Ospina's avatar
Santiago Ospina committed
64
    GitLab Runner cannot handle the load.
Lukas Riedel's avatar
Lukas Riedel committed
65 66
* 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
67
* Change compilation order which reduces RAM usage when compiling in parallel.
Santiago Ospina's avatar
Santiago Ospina committed
68
* Decentralization of the header system so that in most of the header files are 
Santiago Ospina's avatar
Santiago Ospina committed
69
	independent of each other.
Lukas Riedel's avatar
Lukas Riedel committed
70 71 72 73 74

### 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
75

Lukas Riedel's avatar
Lukas Riedel committed
76 77
### Removed
* Complete doxygen documentation from Sphinx docs.
Lukas Riedel's avatar
Lukas Riedel committed
78

Lukas Riedel's avatar
Lukas Riedel committed
79
### Fixed
Lukas Riedel's avatar
Lukas Riedel committed
80 81
* 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
82 83
* 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
84
* Allow warnings on ParMETIS not being available for parallel computations.
Lukas Riedel's avatar
Lukas Riedel committed
85 86


Lukas Riedel's avatar
Lukas Riedel committed
87 88
## 1.0.0 (2018-03-28)

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