CHANGELOG.md 10.5 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
### Added
Lukas Riedel's avatar
Lukas Riedel committed
7 8
* DORiE now depends on [`yaml-cpp`](https://github.com/jbeder/yaml-cpp/), a
    library for reading YAML files. The version required is >=5.2.0.
Lukas Riedel's avatar
Lukas Riedel committed
9
* Added an abstract base class
10
    [`SimulationBase`](dune/dorie/common/simulation_base.hh)
Santiago Ospina's avatar
Santiago Ospina committed
11 12
    that models the concept of simulation steps so that they 
    can be later coupled with other simulations.
Lukas Riedel's avatar
Lukas Riedel committed
13 14 15
* New classes representing parameterizations. Every parameterization must now
    derive from `RichardsParameterization`, and return function objects
    representing parameterization functions.
Lukas Riedel's avatar
Lukas Riedel committed
16 17 18 19 20 21 22
* CMake module `DorieTesting.cmake`. The module contains multiple functions
    which facilitate registering tests in the two new testing categories:
    System tests and Unit tests. Unit tests are compiled with appropriate flags
    for code coverage reports.
* Code coverage reports for unit tests. Detailed reports can be retrieved from
    the artifacts of the `test:unit-tests` test in the folder
    `build-cmake/test/coverage`. The total coverage is reported to GitLab.
23
* New class [`SimulationTransport`](dune/dorie/interface/transport_simulation.hh)
24
    which solves the transport equation with a finite volume scheme for give
25
    grid functions of water content and velocity.
Lukas Riedel's avatar
Lukas Riedel committed
26
* Infrastructure for the input of Miller scaling fields. !110
Lukas Riedel's avatar
Lukas Riedel committed
27
* Add logging framework 'spdlog' as submodule !106
Lukas Riedel's avatar
Lukas Riedel committed
28 29

### Changed
Lukas Riedel's avatar
Lukas Riedel committed
30
* `Simulation` is renamed `RichardsSimulation` and moved to 
31
	[richards.hh](dune/dorie/model/richards/richards.hh).
Lukas Riedel's avatar
Lukas Riedel committed
32 33 34
* `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.
35 36 37
* Grid adaptation now is done in two steps: (1) mark entities of the grid to 
    refine/coarse and (2) adapt the grid and project the degrees of freedom on 
    the new grid.
Lukas Riedel's avatar
Lukas Riedel committed
38 39 40 41 42 43 44
* Data structures for storing and accessing parameters. The new class
    `FlowParameters` maps parameter sets and scaling factors to every grid cell
    on the coarsest grid level, and only stores one set of parameters for
    each soil layer. Before querying the parameterization functions, users need
    to call `FlowParameters::bind` with a grid entity to cache the appropriate
    data. All classes and functions querying parameter data have been updated.
    
Lukas Riedel's avatar
Lukas Riedel committed
45
    The old parameterization classes have been removed.
Lukas Riedel's avatar
Lukas Riedel committed
46 47 48 49 50 51
* `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 
52 53
    subdirectory
    [dune/dorie/model/richards/adapters](dune/dorie/model/richards/adapters).
Lukas Riedel's avatar
Lukas Riedel committed
54 55 56 57
* `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
    `GridFunctionVTKSequenceWriter`.
58 59 60 61 62 63 64 65
* `RichardsSimulation` now models the `SimulationBase` class (See details in
    https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/issues/94). For this, 
    several methods were renamed with basically no change in behaviour.
* `RichardsSimulation` and `TimeController` are able to receive a suggestion for
    the next timestep.
* Static const `bool`s for adaptivity and output writing in `BaseTraits` were 
    removed in favor of run-time policies (See details in
    https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/issues/94).
66
* Swich to the stable release branch `releases/2.6` of `dune-testtools`.
Lukas Riedel's avatar
Lukas Riedel committed
67 68 69
* The `build` CI stage now explicitly builds system tests and unit tests. The
    job `build:main` has been removed. The `build:debug` jobs now build the
    unit test targets.
Lukas Riedel's avatar
Lukas Riedel committed
70
* Merge Python packages into single new package `dorie`.
71
* Executables and files of unit-tests and system-tests are now located in 
72
    [`dune/dorie/test/`](dune/dorie/test/) and [`test/`](test/) respectively.
Lukas Riedel's avatar
Lukas Riedel committed
73 74 75
* The `dorie` CLI has been moved into the DORiE Python package. It can now only
    be invoked after activating the DUNE virtual environment. The usage
    instructions in docs and `README.md` have been updated accordingly.
Lukas Riedel's avatar
Lukas Riedel committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
* Soil architecture and parameter input has been completely revised.

    DORiE now expects a YAML file containing parameterization data and separate
    domain mapping data which can be supplied through the input GMSH file, or as
    H5 dataset. See the documentation for more information. Several keys in the
    main routine config file have been changed.

    See [#86](https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/issues/86).

* The Parameter Field Generator (PFG) module has been revised and does not
    write parameterization data anymore.
    
    It can be used to create mappings for heterogeneous media through the
    binary converter, or continuous scaling fields (feature pending).
    Several keys in the PFG config file have been changed.

    See [#86](https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/issues/86).
Lukas Riedel's avatar
Lukas Riedel committed
93

Lukas Riedel's avatar
Lukas Riedel committed
94 95
* Improved and refurbished `Dorie::H5File`.

96
    The source file was renamed to `dune/dorie/common/util_h5file.hh`. The
Lukas Riedel's avatar
Lukas Riedel committed
97 98
    `read_dataset` function is now capable of directly opening dataset paths
    that contain groups.
Lukas Riedel's avatar
Lukas Riedel committed
99

100 101 102
* The following changes were done in order to have a consistent API to support 
    different models:

103 104 105
    * Folder structure has changed to a model based structure: in the main
        [C++ source directory](dune/dorie/) there now is a `common` folder, and
        a folder for `model` containing the source files for each model.
106 107 108

    * The API has been updated to support several models: from now, categories 
        that  target a specific model has to be preceded by a keyword 
109 110
        identifying the  corresponding model (e.g. `richards.initial`,
        `richards.output`, etc.), while common categories stay with no prefix
111 112 113 114
        at all (e.g. `grid`, `adaptivity`, etc.).

    * The parameter scraper now accepts the argument `--model <model>` which
        adds the prefix `<model>.` to every category in the scraper. This helps
115 116 117
        to be able to use the method `sub()` from the `ParameterTree` object.
        It dumps its data into a YAML file which is then loaded for writing
        the default configuration files and the cheat sheet.
118

Lukas Riedel's avatar
Lukas Riedel committed
119 120
* Use logging framework 'spdlog' for all terminal output !106

121 122 123 124
### Fixed
* Solver in `RichardsSimulation` was using the wrong time variable.
   [!116](https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/merge_requests/116)

Lukas Riedel's avatar
Lukas Riedel committed
125 126 127 128
### Deprecated
* The configuration file key `[parameters.interpolation]` is deprecated due to
    the new scheme for storing parameterization data. DORiE now only supports 
    nearest-neighbor interpolation of parameters and scaling factors.
Lukas Riedel's avatar
Lukas Riedel committed
129

130
* The `adaptivity.useAdaptity` keyword is deprecated, please use the new keyword
131 132
     `adaptivity.policy` (see the 
    [DORiE Configuration File Guide documentation](https://dorie-doc.netlify.com/quickstart-parameters.html#main-routine)
133 134
     for details).

Lukas Riedel's avatar
Lukas Riedel committed
135 136 137
### Removed
* The class `H5File::AttributeReader` was completely removed.

Lukas Riedel's avatar
Lukas Riedel committed
138 139 140 141 142 143 144 145 146 147

## 1.1.1 (2018-08-21)

### 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
148
* The test system folder was renamed from `testing` to [`test`](test).
149 150
* File `operator_DG.hh` is renamed  
    [`richards_operator_DG.hh`](dune/dorie/solver/richards_operator_DG.hh)
Lukas Riedel's avatar
Lukas Riedel committed
151

Lukas Riedel's avatar
Lukas Riedel committed
152 153 154 155
### 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
156
* Removed CI artifacts of `test` stage from `deploy` jobs.
Lukas Riedel's avatar
Lukas Riedel committed
157 158 159
* 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
160 161 162
* 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.
Lukas Riedel's avatar
Lukas Riedel committed
163 164
* 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
165 166
* Fix a bug in the boundary condition evaluation where an `end()` iterator
    was dereferenced without error.
Lukas Riedel's avatar
Lukas Riedel committed
167 168
* Re-introduced deployment of the documentation which can now be found online
    at https://dorie-doc.netlify.com/.
Lukas Riedel's avatar
Lukas Riedel committed
169

Lukas Riedel's avatar
Lukas Riedel committed
170

Lukas Riedel's avatar
Lukas Riedel committed
171
## 1.1.0 (2018-07-27)
Lukas Riedel's avatar
Lukas Riedel committed
172

Lukas Riedel's avatar
Lukas Riedel committed
173
### Added
Lukas Riedel's avatar
Lukas Riedel committed
174 175
* 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
176 177 178
* 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
179
* Add `.gitattributes` for `CHANGELOG.md` to reduce merge conflicts with
Santiago Ospina's avatar
Santiago Ospina committed
180
    `merge=union`.
Lukas Riedel's avatar
Lukas Riedel committed
181
* Public API definition in documentation.
Lukas Riedel's avatar
Lukas Riedel committed
182

Lukas Riedel's avatar
Lukas Riedel committed
183
### Changed
Santiago Ospina's avatar
Santiago Ospina committed
184
* Update code base to *DUNE v2.6*.
Lukas Riedel's avatar
Lukas Riedel committed
185
* Raise software requirements to versions available on Ubuntu 18.04 LTS
Santiago Ospina's avatar
Santiago Ospina committed
186 187
    (Bionic Beaver).
* Switch VTK output from conforming to non-conforming.
Lukas Riedel's avatar
Lukas Riedel committed
188
* Use `multicore` build tag only for `test:parallel` build because the current
Santiago Ospina's avatar
Santiago Ospina committed
189
    GitLab Runner cannot handle the load.
Lukas Riedel's avatar
Lukas Riedel committed
190 191
* 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
192
* Change compilation order which reduces RAM usage when compiling in parallel.
Santiago Ospina's avatar
Santiago Ospina committed
193
* Decentralization of the header system so that in most of the header files are 
Santiago Ospina's avatar
Santiago Ospina committed
194
	independent of each other.
Lukas Riedel's avatar
Lukas Riedel committed
195 196 197 198 199

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

Lukas Riedel's avatar
Lukas Riedel committed
201 202
### Removed
* Complete doxygen documentation from Sphinx docs.
Lukas Riedel's avatar
Lukas Riedel committed
203

Lukas Riedel's avatar
Lukas Riedel committed
204
### Fixed
Lukas Riedel's avatar
Lukas Riedel committed
205 206
* 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
207 208
* 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
209
* Allow warnings on ParMETIS not being available for parallel computations.
Lukas Riedel's avatar
Lukas Riedel committed
210 211


Lukas Riedel's avatar
Lukas Riedel committed
212 213
## 1.0.0 (2018-03-28)

214
First stable version.