CHANGELOG.md 11 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
* Grid function container to store transient grid functions !115
Lukas Riedel's avatar
Lukas Riedel committed
27
* Infrastructure for the input of Miller scaling fields. !110
Lukas Riedel's avatar
Lukas Riedel committed
28
* Add logging framework 'spdlog' as submodule !106
Lukas Riedel's avatar
Lukas Riedel committed
29
* Support input of boundary segmentations !119
Lukas Riedel's avatar
Lukas Riedel committed
30
* Reconstruction of continuous fluxes using RT finite elements !105
Lukas Riedel's avatar
Lukas Riedel committed
31 32

### Changed
Lukas Riedel's avatar
Lukas Riedel committed
33
* `Simulation` is renamed `RichardsSimulation` and moved to 
34
	[richards.hh](dune/dorie/model/richards/richards.hh).
Lukas Riedel's avatar
Lukas Riedel committed
35 36 37
* `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.
38 39 40
* 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
41 42 43 44 45 46 47
* 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
48
    The old parameterization classes have been removed.
Lukas Riedel's avatar
Lukas Riedel committed
49 50 51 52 53 54
* `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 
55 56
    subdirectory
    [dune/dorie/model/richards/adapters](dune/dorie/model/richards/adapters).
Lukas Riedel's avatar
Lukas Riedel committed
57 58 59 60
* `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`.
61 62 63 64 65 66 67 68
* `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).
69
* Swich to the stable release branch `releases/2.6` of `dune-testtools`.
Lukas Riedel's avatar
Lukas Riedel committed
70 71 72
* 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
73
* Merge Python packages into single new package `dorie`.
74
* Executables and files of unit-tests and system-tests are now located in 
75
    [`dune/dorie/test/`](dune/dorie/test/) and [`test/`](test/) respectively.
Lukas Riedel's avatar
Lukas Riedel committed
76 77 78
* 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
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
* 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
96

Lukas Riedel's avatar
Lukas Riedel committed
97 98
* Improved and refurbished `Dorie::H5File`.

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

103 104 105
* The following changes were done in order to have a consistent API to support 
    different models:

106 107 108
    * 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.
109 110 111

    * The API has been updated to support several models: from now, categories 
        that  target a specific model has to be preceded by a keyword 
112 113
        identifying the  corresponding model (e.g. `richards.initial`,
        `richards.output`, etc.), while common categories stay with no prefix
114 115 116 117
        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
118 119 120
        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.
121

Lukas Riedel's avatar
Lukas Riedel committed
122
* Use logging framework 'spdlog' for all terminal output !106
123
* DORiE now writes vertex data by default. #129
Lukas Riedel's avatar
Lukas Riedel committed
124
* Switch license from MIT to GPLv3 !135
Lukas Riedel's avatar
Lukas Riedel committed
125
* Specifying scaling field `extensions` and `offset` is now optional !133
Lukas Riedel's avatar
Lukas Riedel committed
126
* Generalized initial condition specification in config file !129
Lukas Riedel's avatar
Lukas Riedel committed
127

128 129 130
### 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
131
* Shape of input datasets was flipped when loading scaling factors !124
132

Lukas Riedel's avatar
Lukas Riedel committed
133 134 135 136
### 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
137

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

Lukas Riedel's avatar
Lukas Riedel committed
143 144
### Removed
* The class `H5File::AttributeReader` was completely removed.
Lukas Riedel's avatar
Lukas Riedel committed
145
* Boundary conditions `evaporation` and `limitedInflux` !120
Lukas Riedel's avatar
Lukas Riedel committed
146 147 148 149 150 151 152 153 154 155

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

Lukas Riedel's avatar
Lukas Riedel committed
160 161 162 163
### 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
164
* Removed CI artifacts of `test` stage from `deploy` jobs.
Lukas Riedel's avatar
Lukas Riedel committed
165 166 167
* 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
168 169 170
* 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
171 172
* 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
173 174
* Fix a bug in the boundary condition evaluation where an `end()` iterator
    was dereferenced without error.
Lukas Riedel's avatar
Lukas Riedel committed
175 176
* 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
177

Lukas Riedel's avatar
Lukas Riedel committed
178

Lukas Riedel's avatar
Lukas Riedel committed
179
## 1.1.0 (2018-07-27)
Lukas Riedel's avatar
Lukas Riedel committed
180

Lukas Riedel's avatar
Lukas Riedel committed
181
### Added
Lukas Riedel's avatar
Lukas Riedel committed
182 183
* 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
184 185 186
* 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
187
* Add `.gitattributes` for `CHANGELOG.md` to reduce merge conflicts with
Santiago Ospina's avatar
Santiago Ospina committed
188
    `merge=union`.
Lukas Riedel's avatar
Lukas Riedel committed
189
* Public API definition in documentation.
Lukas Riedel's avatar
Lukas Riedel committed
190

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

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

Lukas Riedel's avatar
Lukas Riedel committed
209 210
### Removed
* Complete doxygen documentation from Sphinx docs.
Lukas Riedel's avatar
Lukas Riedel committed
211

Lukas Riedel's avatar
Lukas Riedel committed
212
### Fixed
Lukas Riedel's avatar
Lukas Riedel committed
213 214
* 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
215 216
* 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
217
* Allow warnings on ParMETIS not being available for parallel computations.
Lukas Riedel's avatar
Lukas Riedel committed
218 219


Lukas Riedel's avatar
Lukas Riedel committed
220 221
## 1.0.0 (2018-03-28)

222
First stable version.