Commit b22a1398 authored by Lukas Riedel's avatar Lukas Riedel

Update CHANGELOG.md. Fix filepaths in older logs.

parent 49ae51fd
......@@ -7,7 +7,7 @@
* 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.
* Added an abstract base class
[`SimulationBase`](dune/dorie/interface/base_simulation.hh)
[`SimulationBase`](dune/dorie/common/simulation_base.hh)
that models the concept of simulation steps so that they
can be later coupled with other simulations.
* New classes representing parameterizations. Every parameterization must now
......@@ -23,7 +23,7 @@
### Changed
* `Simulation` is renamed `RichardsSimulation` and moved to
[richards_simulation.hh](dune/dorie/interface/richards_simulation.hh).
[richards.hh](dune/dorie/model/richards/richards.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.
......@@ -44,7 +44,8 @@
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).
subdirectory
[dune/dorie/model/richards/adapters](dune/dorie/model/richards/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
......@@ -87,30 +88,28 @@
* Improved and refurbished `Dorie::H5File`.
The source file was renamed to `dune/dorie/solver/util_h5file.hh`. The
The source file was renamed to `dune/dorie/common/util_h5file.hh`. The
`read_dataset` function is now capable of directly opening dataset paths
that contain groups.
* The following changes were done in order to have a consistent API to support
different models:
* 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 `models`. Each model has its own folder in `models` (i.e
`richards`).
* 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.
* The API has been updated to support several models: from now, categories
that target a specific model has to be preceded by a keyword
identifying the corresponding model (e.g. `richards.initial`,
`richards.output`, etc.), while common categories stay with no prefix
identifying the corresponding model (e.g. `richards.initial`,
`richards.output`, etc.), while common categories stay with no prefix
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
to be able to use the method `sub()` from the `ParameterTree` object.
* Parameter documentation has been split as it was done for folders
(see [source folder for documentation](doc/default_files)).
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.
### Deprecated
* The configuration file key `[parameters.interpolation]` is deprecated due to
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment