CHANGELOG.md 12.2 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 10 11
* New classes representing parameterizations. Every parameterization must now
    derive from `RichardsParameterization`, and return function objects
    representing parameterization functions.
Santiago Ospina's avatar
Santiago Ospina committed
12 13 14
* Added a abstract base class [`SimulationBase`](dune/dorie/interface/base_simulation.hh) 
    that models the concept of simulation steps so that they 
    can be later coupled with other simulations.
Lukas Riedel's avatar
Lukas Riedel committed
15
* Added an abstract base class
16
    [`SimulationBase`](dune/dorie/common/simulation_base.hh)
Santiago Ospina's avatar
Santiago Ospina committed
17 18
    that models the concept of simulation steps so that they 
    can be later coupled with other simulations.
Lukas Riedel's avatar
Lukas Riedel committed
19 20 21
* 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
22 23 24 25 26 27 28
* 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.
29
* New class [`SimulationTransport`](dune/dorie/interface/transport_simulation.hh)
30
    which solves the transport equation with a finite volume scheme for give
31
    grid functions of water content and velocity.
Lukas Riedel's avatar
Lukas Riedel committed
32
* Grid function container to store transient grid functions !115
Lukas Riedel's avatar
Lukas Riedel committed
33
* Infrastructure for the input of Miller scaling fields. !110
Lukas Riedel's avatar
Lukas Riedel committed
34
* Add logging framework 'spdlog' as submodule !106
Lukas Riedel's avatar
Lukas Riedel committed
35
* Support input of boundary segmentations !119
Lukas Riedel's avatar
Lukas Riedel committed
36
* Reconstruction of continuous fluxes using RT finite elements !105
Lukas Riedel's avatar
Lukas Riedel committed
37
* Custom DG finite element map for simplices based on Pk polynomials !125
Lukas Riedel's avatar
Lukas Riedel committed
38 39
* Initial conditions expressed as analytic functions using
    [muparser](http://beltoforion.de/article.php?a=muparser) !131
Lukas Riedel's avatar
Lukas Riedel committed
40
* Coupling between transient models for water flow and solute transport !96
Lukas Riedel's avatar
Lukas Riedel committed
41
* Initial conditions generated from H5 input data !130
Lukas Riedel's avatar
Lukas Riedel committed
42
* Generic Python VTK file reader !143
Lukas Riedel's avatar
Lukas Riedel committed
43 44

### Changed
Lukas Riedel's avatar
Lukas Riedel committed
45
* `Simulation` is renamed `RichardsSimulation` and moved to 
46
	[richards.hh](dune/dorie/model/richards/richards.hh).
Lukas Riedel's avatar
Lukas Riedel committed
47 48 49
* `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
50 51 52 53 54 55 56 57 58 59 60 61 62
* 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.
    
    The old parameterization classes located in
    [`param_base.hh`](dune/dorie/solver/param_base.hh),
    [`param_factory.hh`](dune/dorie/solver/param_factory.hh), and
    [`param_van_genuchten.hh`](dune/dorie/solver/param_van_genuchten.hh)
    are still used for reading in data for the new storage scheme.
    The respective objects are freed once a simulation commences.
63 64 65
* 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
66
    The old parameterization classes have been removed.
Lukas Riedel's avatar
Lukas Riedel committed
67 68 69 70 71 72
* `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 
73 74
    subdirectory
    [dune/dorie/model/richards/adapters](dune/dorie/model/richards/adapters).
Lukas Riedel's avatar
Lukas Riedel committed
75 76 77 78
* `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`.
79 80 81 82 83 84 85 86
* `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).
87
* Swich to the stable release branch `releases/2.6` of `dune-testtools`.
Lukas Riedel's avatar
Lukas Riedel committed
88 89 90
* 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
91
* Merge Python packages into single new package `dorie`.
92
* Executables and files of unit-tests and system-tests are now located in 
93
    [`dune/dorie/test/`](dune/dorie/test/) and [`test/`](test/) respectively.
Lukas Riedel's avatar
Lukas Riedel committed
94 95 96
* 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
97
* Soil architecture and parameter input has been completely revised.
Lukas Riedel's avatar
Lukas Riedel committed
98

Lukas Riedel's avatar
Lukas Riedel committed
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
    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
114

Lukas Riedel's avatar
Lukas Riedel committed
115 116
* Improved and refurbished `Dorie::H5File`.

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

121 122 123
* The following changes were done in order to have a consistent API to support 
    different models:

124 125 126
    * 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.
127 128 129

    * The API has been updated to support several models: from now, categories 
        that  target a specific model has to be preceded by a keyword 
130 131
        identifying the  corresponding model (e.g. `richards.initial`,
        `richards.output`, etc.), while common categories stay with no prefix
132 133 134 135
        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
136 137 138
        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.
139

Lukas Riedel's avatar
Lukas Riedel committed
140
* Use logging framework 'spdlog' for all terminal output !106
141
* DORiE now writes vertex data by default. #129
Lukas Riedel's avatar
Lukas Riedel committed
142
* Switch license from MIT to GPLv3 !135
Lukas Riedel's avatar
Lukas Riedel committed
143
* Specifying scaling field `extensions` and `offset` is now optional !133
Lukas Riedel's avatar
Lukas Riedel committed
144
* Generalized initial condition specification in config file !129
Lukas Riedel's avatar
Lukas Riedel committed
145
* Structure and setup of Sphinx user docs !126
Lukas Riedel's avatar
Lukas Riedel committed
146

147 148 149
### 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
150
* Shape of input datasets was flipped when loading scaling factors !124
151

Lukas Riedel's avatar
Lukas Riedel committed
152 153 154 155
### 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
156

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

Lukas Riedel's avatar
Lukas Riedel committed
162 163
### Removed
* The class `H5File::AttributeReader` was completely removed.
Lukas Riedel's avatar
Lukas Riedel committed
164
* Boundary conditions `evaporation` and `limitedInflux` !120
Lukas Riedel's avatar
Lukas Riedel committed
165 166 167 168 169 170 171 172 173 174

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

Lukas Riedel's avatar
Lukas Riedel committed
179 180 181 182
### 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
183
* Removed CI artifacts of `test` stage from `deploy` jobs.
Lukas Riedel's avatar
Lukas Riedel committed
184 185 186
* 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
187 188 189
* 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.
190 191
* 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
192 193
* Fix a bug in the boundary condition evaluation where an `end()` iterator
    was dereferenced without error.
Lukas Riedel's avatar
Lukas Riedel committed
194 195
* 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
196

197

Lukas Riedel's avatar
Lukas Riedel committed
198
## 1.1.0 (2018-07-27)
Lukas Riedel's avatar
Lukas Riedel committed
199

Lukas Riedel's avatar
Lukas Riedel committed
200
### Added
Lukas Riedel's avatar
Lukas Riedel committed
201 202
* DORiE now employs a `SubsamplingVTKWriter` for higher output precision.
    Subsampling levels are controlled via the new key `output.subsamplingLevel`.
203 204 205
* 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
206
* Add `.gitattributes` for `CHANGELOG.md` to reduce merge conflicts with
207
    `merge=union`.
Lukas Riedel's avatar
Lukas Riedel committed
208
* Public API definition in documentation.
Lukas Riedel's avatar
Lukas Riedel committed
209

Lukas Riedel's avatar
Lukas Riedel committed
210
### Changed
211
* Update code base to *DUNE v2.6*.
Lukas Riedel's avatar
Lukas Riedel committed
212
* Raise software requirements to versions available on Ubuntu 18.04 LTS
213 214
    (Bionic Beaver).
* Switch VTK output from conforming to non-conforming.
Lukas Riedel's avatar
Lukas Riedel committed
215
* Use `multicore` build tag only for `test:parallel` build because the current
216
    GitLab Runner cannot handle the load.
Lukas Riedel's avatar
Lukas Riedel committed
217 218
* 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
219
* Change compilation order which reduces RAM usage when compiling in parallel.
Santiago Ospina's avatar
Santiago Ospina committed
220
* Decentralization of the header system so that in most of the header files are 
221
	independent of each other.
Lukas Riedel's avatar
Lukas Riedel committed
222 223 224 225 226

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

Lukas Riedel's avatar
Lukas Riedel committed
228 229
### Removed
* Complete doxygen documentation from Sphinx docs.
Lukas Riedel's avatar
Lukas Riedel committed
230

Lukas Riedel's avatar
Lukas Riedel committed
231
### Fixed
Lukas Riedel's avatar
Lukas Riedel committed
232 233
* 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
234 235
* 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
236
* Allow warnings on ParMETIS not being available for parallel computations.
Lukas Riedel's avatar
Lukas Riedel committed
237 238


Lukas Riedel's avatar
Lukas Riedel committed
239 240
## 1.0.0 (2018-03-28)

241
First stable version.