CHANGELOG.md 81.7 KB
Newer Older
Timo Koch's avatar
Timo Koch committed
1
2
3
4
5
6
7
Differences Between DuMuX 3.1 and DuMuX 3.0
=============================================

### Important Notes

### Improvements and Enhancements

8
- Added new porous medium model for the energy balance of a porous solid (general heat equation)
9
- __Multidomain__: It is now possible to use the facet coupling module together with the mpfa-o scheme in the bulk domain.
10
- Added a `StaggeredNewtonConvergenceWriter` for the staggered grid discretization scheme
11
- The box scheme works now on grids with prism / wedge elements in 3D
12
13
14
- The GridManager now support reading unstructured grids and data from vtu/vtp files (ASCII, XML format) sequential
  This means for UGGrid and FoamGrid you can now specify a grid in such a format in the input file
  `Grid.File = mygrid.vtu` / `Grid.File = mygrid.vtp` and the associated data is available in the grid data object
Ned Coltman's avatar
Ned Coltman committed
15
16
17
- __Freeflow__: A second order approximation of the convective term of all navier-stokes based models is now available.
  This can be enabled using the property UpwindSchemeOrder. This property defaults to a first order upwinding approximation,
  the method used for all models in release/3.0. If this property is set to `2`, a second order flux limiter method will be used.
18
19
20
21
  Various flux limiter functions have been implemented to maintain the monotonicity of this discretization. Per default the
  `Minmod` flux limiter is used, but `Vanleer`, `Vanalbada`, `Superbee`, `Umist`, `Mclimiter`, and `Wahyd` based flux limiters
  are also available. These can be specified using the input file entry `Flux.DifferencingScheme`. These methods are also
  implemented for non-uniform structured grids (e.g. YaspGrid - TensorProductCoordinates). Per default, a scheme assuming a
Ned Coltman's avatar
Ned Coltman committed
22
  uniform grid is used, but two other methods, `Li` and `Hou`, are both available for adaptations to non-uniform grids.
23
  These can be specified using the input file entry `Flux.TVDApproach`.
Ned Coltman's avatar
Ned Coltman committed
24
- __RANS__: The called RANS model, defined in the properties system, will specify, via the model traits,
25
26
27
28
29
  which RANS problem implementation should be used. In each problem file, the initial and boundary conditions can be
  set using templated functions based on the model type. Examples of these functions exist in the RANS based tests.
  No further preprocessor macros are required.
- __ShallowWater__ Thanks to Leopold Stadler we now have a shallow water equations solver / model. Have a look at freeflow/shallowwater
  and give it a try with the dam break test at test/freeflow/shallowwater.
30
31
32
- __GridManager__ Instead of always including all gridmanager specializations you can now only include the specialization that you need.
  For example, if you only use YaspGrid in your code, you only need to include `dumux/io/grid/gridmanager_yasp.hh`. The convenience header
  `dumux/io/grid/gridmanager.hh` still includes all specializations.
33

Timo Koch's avatar
Timo Koch committed
34
35
### Immediate interface changes not allowing/requiring a deprecation period

36
37
38
39
40
41
- `NewtonConvergenceWriter`'s first template argument has changed from `GridView`, the `FVGridGeometry`. This allows to call the `resize()` method after a grid change without any arguments.
  Here is an example of how to instatiate the convergence writer:
  ```
  using NewtonConvergenceWriter = Dumux::NewtonConvergenceWriter<FVGridGeometry, SolutionVector>;
  auto convergenceWriter = std::make_shared<NewtonConvergenceWriter>(*fvGridGeometry);
  ```
42
43
44
45
- The interface of the abstract `TimeLoopBase` class has been extended by `virtual void advanceTimeStep()`, `virtual void setTimeStepSize(Scalar dt)`,
  `virtual Scalar maxTimeStepSize()`, and `virtual bool finished()`, thus forcing the inheriting classes to implement those functions.
  `TimeLoop` is no longer a template argument in `NewtonSolver`'s `solve()` method, thereby increasing
  type safety and providing better compiler error messages.
46

Timo Koch's avatar
Timo Koch committed
47
48
49
50
### Deprecated classes/files, to be removed after 3.1:

### Deprecated member functions, to be removed after 3.1:

51
52
53
54
- The convergence writer is no longer passed to `NewtonSolver`'s `solve()` method.
  For outputting convergence data, please use `newtonSolver.attachConvergenceWriter(convWriter)` in `main.cc` (directly after instantiating the writer).
  To stop the output, the writer can also be detached again using `newtonSolver.detachConvergenceWriter()`.

Timo Koch's avatar
Timo Koch committed
55
56
57
### Deleted classes/files, property names, constants/enums


58
59
60
Differences Between DuMuX 2.12 and DuMuX 3.0
=============================================

Bernd Flemisch's avatar
Bernd Flemisch committed
61
62
63
64
## Important Notes

- DuMuX 3.0 is a major version update. It is not backward compatible in all aspects to 2.12.
  The following minor version updates will be, as before for the DuMuX 2-series, always backward compatible
65
66
      to at least the last minor version update.

Bernd Flemisch's avatar
Bernd Flemisch committed
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
- The tutorial has been replaced by the new module `dumux-course` which is
  accessible at https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course.
  We recommend new users and also users experienced with DuMuX 2.X to clone
  the course and have a look at the exercises in there.

- DuMuX 3.0 is based on Dune 2.6 and is expected to run with the current Dune master.
  We will try to keep the compatibility with the Dune master
  as long as it is technically feasible and our resources allow it.

- DuMuX 3.0 requires at least GCC 4.9 or Clang 3.5 in their C++-14 mode.
  However, we suggest to use newer compiler versions, as we cannot test against all previous compiler versions.

- For employing corner-point grids by means of opm-grid, the OPM release 2018.10 has to be used.

## Improvements and Enhancements

### General

- __New style main files:__ 3.0 comes which a major overhaul of how the sequence of simulation steps is specified.
  Until 2.12 there was the start.hh header including the free function `start` that contained a predefined sequence of
  steps. Customization of the sequence was possible by many hooks implemented in classes used in this sequence. This
  made it hard to follow the course of the program and hard to implement customization at points where this was not previously envisioned.
  In contrast, in the new approach the sequence of simulation steps was linearized, meaning that each step is visible
  in the program's main file. In the new main files, one can clearly see the io, initialization, assembly, solving, update, time loop, etc.,
  of the program. Many parts of the simulation that were previously mandatory, i.e. simulations in 2.12 always contained a time loop,
  are now optional (stationary simulations just don't need a time loop). The new style main files make it easier two follow the course
  of the program, are easier to customize, and offer more flexibility concerning the customization of steps and components of a simulation.
  All tests and examples in the dumux repository have been adapted to the new style main files.
- __Property system:__ The property system is now usable without preprocessor macros. To this end it was completely reimplemented using C++14 techniques and
  variadic templates. The hierarchies can now be arbitrarily deep instead of being limited to 5 levels. The new implementation does not use
  C++ inheritance. Properties and TypeTag now have to be properly qualified with the namespaces `Properties::`, `TTag::`. Types that share the
  name with properties have to properly qualified with the `Dumux::` namespace. This update makes it hopefully more readable
  and removes the "magic" part from the property system.
- __Runtime parameters:__ Runtime parameters are no longer accessed with preprocessor macros. They have been replaced by C++ function templates
  `Dumux::getParam`, `Dumux::hasParam`, `Dumux::getParamFromGroup`. The `..FromGroup` version has been redesigned to allow the specification
  of parameters for different models in one input file. The concept of a parameter group string was extended to make it possible to
  use a single input file for complex multidomain simulation setups.
- __Restarting simulations:__ The old restart module was replaced by an implementation based on a VTK backend (other formats might be added later such as HDF5).
  Restarted simulations can read solutions from vtk files. For parallel runs, there is currently the restriction that the number of processors has to be the same
  as before the restart. Restarted simulations can read grids from vtk (currently only sequential, non-adaptive grids, support for parallel and adaptive
  will be added in a future version).
- __Assembly__: The assembler can now assemble implicit and explicit Euler time discretizations. An interface for implementing analytical Jacobians was added.
  The CCTpfa assembler has been significantly improved for complex models that spend a lot of time computing constitutive laws. Also the numerical
  differentiation scheme was improved by altering the order in which derivatives are computed.
- __TypeTag templates:__ Implementers of code in DuMuX 3.0 are advised to avoid TypeTag as a template argument for class templates.
  Many classes in the DuMuX core have been changed to have a small number of specific template arguments, including `GridGeometry`,
  `TimeLoop`, `Newton`, `LinearSolver`, `SpatialParams`. This makes it possible to share objects of these types between models using
  different TypeTags. This was not possible before as `Class<TypeTag1>` and `Class<TypeTag2>` are different types, even if they contain
  exactly the same implementation code.
  Furthermore, having TypeTag as a template argument leads to bad programming, and unnecessary dependencies that should be avoided in
  every object-oriented code.
- __The grid geometry concept:__ In version 3.0, discretization methods use grid geometries which are wrappers or adapters around a `Dune::GridView`,
  providing data structures and interfaces necessary to implement these discretization methods easily. In particular, the
  abstraction of sub-control-volumes (scv) and sub-control-volume-faces (scvf) are now separate classes and the grid geometry provides means to iterate
  over all scvs and scvfs of an element, using range-based-for loops.
- __The caching concept:__ Version 3.0 introduces a caching concept for the new grid geometry, the volume variables and the flux variables.
  There are classes with a `Grid` prefix, that store data for the current grid view, and classes with the `Element` prefix that store data locally
  for an element or element stencil. Depending on the caching concept used, data will be either stored completely in the `Grid` objects
  (e.g. `GridGeometry`) and the `Element` objects (e.g. `ElementGeometry`) are mere accessor objects, or, data will be partly only cached locally.
  Local caching uses less memory but might result in an increased runtime. Grid caching is memory intensive
  but can provide a significant run-time speedup. Choose whatever concept fits your available resources,
  the default being local caching.
- __Support__ for grid managers `dune-subgrid` (a meta grid selecting only certain elements from a host grid)
  and `dune-spgrid` (a structured parallel grid manager, supporting periodic boundaries).

### Models, Physics and Methods

- __MPFA schemes:__ The new design of the DuMuX core facilitates the incorporation of new finite-volume schemes. In particular, the new core comes with
  a framework for MPFA schemes, in which currently the only available scheme is the MPFA-O scheme. It can be used in conjunction with any DuMuX model and
  also works on surface grids. More schemes will be added in the future.
- __Box-dfm:__ The `2pdfm` model from version 2.12 has been generalized such that it can be used on any DuMuX model and in both two and three dimensions.
- __Tracer transport__: A new model for tracer transport with a given flow field has been added. The model can be also used to implement sequentially
  coupled simulations, or iterative solvers where flow and transport are decoupled / weakly coupled.
- __Mineralization__: An adapter model for mineralization has been added and can be used with all porousmediumflow models. A balance for the solid
  volume fraction of precipitating, adsorbed, or absorbed substances is added to the existing equations.
- __Solution-dependent spatial params:__ A redesign of the spatial params interface allows now to define spatial parameters such as permeability
  and porosity that depend on the solution. This makes it easier to implement mineralization models altering the solid structure of the porous medium.
- __Solid systems:__ DuMuX 3.0 introduces solid systems similar to fluid systems but for solid components. This allows a consistent
  implementation of mineralization models including reactions, dissolution, precipitation and other processes altering the solid
  phase of the porous medium.
- __Multidomain:__ DuMuX 3.0 introduces a new multidomain framework which does no longer depend on `dune-multidomain` and can be used for the coupling
  of an arbitrary number of subdomains. The sub-domains can be regions in which different sets of equations are solved and/or which have different
  dimensionalities. The implementation is such that any of the existing DuMuX models can be used in the subdomains, while the data and functionality
  required for the coupling of the sub-domains is implemented in a `CouplingManger` class. Three different coupling concepts are available, for which
  there are a number of available `CouplingManager` class implementations:
    - _Boundary:_ coupling across sub-domain boundaries
    - _Embedded:_ Coupling between a bulk domain and an embedded lower-dimensional sub-domain which has an independent grid
    - _Facet:_ Coupling betweeen a bulk domain and a codimension-one sub-domain, which is conforming with the element facets of the bulk domain
- __Free-flow models:__ The previous Navier-Stokes model using the box method has been replaced by one that employs a staggered grid discretization.
  The new method does not  require any stabilization techniques while those were necessary for the box method in order to avoid spurious oscillations.
  The free-flow models in DuMuX 3.0 consider single phase flow with or without component/energy transport. So far, only regular Cartesian grids are supported
  but local grid refinement will be added in a future release.
  Several RANS models for turbulent flow have been added: k-omega, k-epsilon, low-Re-k-epsilon, one-eq, zero-eq. The RANS models might be subject to further (interface)
  changes.
- __Thermal and chemical non-equilibrium:__ The possibility to consider thermal and/or chemical non-equilibrium of several types has been enabled for all
  porous medium models.
- __Interface solver:__ For the two-phase flow model in conjunction with the box scheme, an interface solver can now be used to reconstruct the saturations
  in the sub-control volumes adjacent to vertices that lie on material discontinuities. This allows a sharper representation of the saturation front evolving
  in heterogeneous porous media.
- __Components:__ Components can now derive from different base classes, `Base`, `Liquid`, `Solid`, `Gas`, depending on which
  phase states are implemented. This can be used to determine at compile time if a component supports a certain phase state.
- __Tabulation of fluid parameter laws:__ The tabulation of fluid parameter laws has been improved to only tabulate those functions actually used during the
  simulation. To this end, the tabulation is done on the first call of a corresponding fluid parameter.
- __MPNC:__ The general m-phase n-component model has been adapted in structure to the other porous medium flow models.
- __Different wettability:__ The 2p models can now model materials with different wettability (hydrophobic, hydrophilic) in different parts of the domain.
- __Maxwell-Stefan-diffusion:__ Most models can now use Maxwell-Stefan diffusion for multi-component diffusion instead of Fickian diffusion.
  There are also a few tests demonstrating how to use it.

## Immediate interface changes not allowing/requiring a deprecation period

- Many classes have been completely redesigned. See the numerous example applications included in 3.0 showcasing all new classes.
- The `GridCreator` has been replaced by the `GridManager`, which no longer uses a singleton for the grid object.
  This makes it possible to create two grids of the exact same type. The `GridManager` also handles user data provided in grid files.

## Deprecated classes/files, to be removed after 3.0
- All classes of the sequential models are deprecated. The sequential models will be ported to the new structure
  of porous medium models (formerly called implicit models). This way sequential and implicit model implementations
  no longer differ and use the same numerical infrastructure.
- The `TimeManager` class is to be replaced by the class `TimeLoop`.
- The `VtkMultiWriter` class is to be replaced by the class `VtkOutputModule`.
- The file `start.hh` is replaced by new style main files.

## Deleted classes/files/functions... which have been deprecated in DuMuX 2.12
- Everything listed as deprecated below has been removed.
191
192


193
194
195
196
Differences Between DuMuX 2.11 and DuMuX 2.12
=============================================

* IMPORTANT NOTES:
197
    - DuMuX 2.12 is expected to run based on Dune 2.4.1, 2.5, 2.6 and the Dune
198
199
200
201
      master. We will try to keep the compatibility with the Dune master
      as long as it is technically feasible and our resources allow it. If
      you want to use Dumux multidomain models, you have to stick with the
      Dune 2.4 core and specific versions of other modules, see
202
203
      [test/multidomain/README](test/multidomain/README) for details.
      Also the geomechanics models require Dune 2.4 and PDELab 2.0.
204

Bernd Flemisch's avatar
Bernd Flemisch committed
205
    - DuMuX 2.12 requires at least GCC 4.9 or Clang 3.5 in their C++-14 mode.
206
207

    - For employing corner-point grids by means of opm-grid (former
208
      dune-cornerpoint), the OPM releases 2017.04 or 2017.10 have to be used.
209
210

* IMPROVEMENTS and ENHANCEMENTS:
211
212
213
214
215
216
217
218
    - Four new tutorial exercises have been added in the folder
      [tutorial](tutorial). They can be built by executing
      `make build_tutorials` in the build folder. Each exercise
      comes with detailed instructions:
        1. [Exercise 1](tutorial/ex1/README.md)
        2. [Exercise 2](tutorial/ex2/README.md)
        3. [Exercise 3](tutorial/ex3/README.md)
        4. [Exercise 4](tutorial/ex4/README.md)
219

220
221
222
223
224
225
    - Fixed bug in heatCapacity() of component air and replace
      the use of a constant value in  gasEnthalpy() by calling
      heatCapacity().

    - The GnuplotInterface now supports in-simulation generation of image
      files (*.png).
226

227
228
    - A paraview python script for exporting 2d pictures from *.vtu files
      has been added.
229

230
231
    - A class for estimating turbulence properties has been added with
      turbulenceproperties.hh.
232

233
234
235
236
* IMMEDIATE INTERFACE CHANGES not allowing/requiring a deprecation period:
    - gnuplotinterface.hh: The add...ToPlot() functions have changed signature,
      the curve name/title is not mandatory anymore and can be specified together
      with the curve options.
237
238

* DELETED classes/files, property names, constants/enums,
239
  member functions, which have been deprecated in DuMuX 2.11:
240
241
242
    - Everything listed as deprecated below has been removed.


Christoph Grüninger's avatar
Christoph Grüninger committed
243
244
245
246
247
248
249
250
251
252
253
Differences Between DuMuX 2.10 and DuMuX 2.11
=============================================

* IMPORTANT NOTES:
    - DuMuX 2.11 is expected to run based on Dune 2.4.1, 2.5 and the Dune
      master. We will try to keep the compatibility with the Dune master
      as long as it is technically feasible and our resources allow it. If
      you want to use Dumux multidomain models, you have to stick with the
      Dune 2.4 core and specific versions of other modules, see
      `test/multidomain/README` for details.

Bernd Flemisch's avatar
Bernd Flemisch committed
254
    - DuMuX 2.11 requires at least GCC 4.9 or Clang 3.5 in their C++-14 mode.
Christoph Grüninger's avatar
Christoph Grüninger committed
255
256
257
258
259
260
261

    - For employing corner-point grids by means of opm-grid (former
      dune-cornerpoint), the OPM release 2016.04 has to be used.

* IMPROVEMENTS and ENHANCEMENTS:

* IMMEDIATE INTERFACE CHANGES not allowing/requiring a deprecation period:
262
263
264
265
    - A gridcreator for piece-of-cake-type grids has been added. It is capable
      of creating meshes with gradually in- and decreasing distances between nodes.
      It also allows the creation of a 360° cake where the last elements are
      connected to the first elements.
266
267
268
269
    - shouldWriteRestartFile() is now, as shouldWriteOutput() already was,
      called before the time level is advanced. So it might be necessary to use
      ...WillBeFinished instead of ...IsFinished for writing restart files at
      the correct time.
270
271
272
    - In the ZeroEq models, the properties BBoxMinIsWall and BBoxMaxIsWall have
      been replaced by the functions bBoxMaxIsWall() and bBoxMaxIsWall() in the
      problem file.
273
274
275
276
277
278
    - In the TwoPNC (and, consequently the TwoPNCMin) models, the old formulations
      pgSl, plSg as well as pnSw and pwSg have been replaced by the pnsw and pwsn,
      to satify the naming convention and be consistent with TwoPTwoC.
    - In the TwoPTwoC model, the indices are no longer dependent on the
      formulation. Further, the values of "nPhaseOnly" and "bothPhases"
      have been harmonized with those in TwoPNC
Christoph Grüninger's avatar
Christoph Grüninger committed
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293

* Deprecated PROPERTY and PARAMETER NAMES, to be removed after 2.11: BEWARE: The
  compiler will not print any warning if a deprecated property or parameter name
  is used. If possible, a run-time warning will appear in the summary lines
  after the corresponding run.

* Deprecated CLASSES/FILES, to be removed after 2.11:

* Deprecated MEMBER FUNCTIONS, to be removed after 2.11:

* DELETED classes/files, property names, constants/enums,
  member functions, which have been deprecated in DuMuX 2.10:
    - Everything listed as deprecated below has been removed.


294
295
296
297
Differences Between DuMuX 2.9 and DuMuX 2.10
===================================================

* IMPORTANT NOTES:
298
299
300
301
302
303
    - DuMuX 2.10 is expected to run based on Dune 2.4.1, 2.5 and the Dune
      master. We will try to keep the compatibility with the Dune master
      as long as it is technically feasible and our resources allow it. If
      you want to use Dumux multidomain models, you have to stick with the
      Dune 2.4 core and specific versions of other modules, see
      `test/multidomain/README` for details.
304

Bernd Flemisch's avatar
Bernd Flemisch committed
305
    - DuMuX 2.10 requires at least GCC 4.9 or Clang 3.5 in their C++-14 mode.
306

307
308
309
    - For employing corner-point grids by means of opm-grid (former
      dune-cornerpoint), the OPM release 2016.04 has to be used.

310
* IMPROVEMENTS and ENHANCEMENTS:
311
312
313
314
315
316
317
318
319
320
321
    - Two new fully-implicit models have been added: `ThreePWaterOil` and
      `TwoPOneC`. The first one admits two components water and oil that may be
      present in two liquid and one gaseous phase, see `test_box3pwateroil` in
      `test/porousmediumflow/3pwateroil/implicit` for details. The second one is
      dedicated to one generic component that may be present in liquid and
      gaseous state, see `test_boxsteaminjection` in
      `test/porousmediumflow/2p1c/implicit` for an example.

    - Numbering of the VTK files starts with `0` now.

    - Using the geostatistical tool gstat for generating random fields has been
322
323
      facilitated. See `test_cc1pwithgstat` in `test/porousmediumflow/1p/implicit`.
      This tool can be installed using the `bin/installexternal.sh` script.
324
325
      If cmake does not find gstat, one has to specify the GSTAT_ROOT variable,
      see the standard optim.opts or debug.opts.
Christoph Grüninger's avatar
Christoph Grüninger committed
326

327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
    - The multidomain models should now run with all compilers without
      segfaults, both with optimization and debug options.

    - Computation for two-dimensional fracture networks in three-dimensional
      space has been fixed and is tested now in
      `test/porousmediumflow/2p/implicit/test_fracture_box2p`.

    - The `bin` folder containing various helper scripts has been restructured.
      For example, the scripts `fuzzycompare.py` and `runtest.py` are now
      contained in the subfolder `testing`.

    - Two new scripts `extractlinedata.py` and `extractpointdataovertime.py`
      have been added to `bin/postprocessing`. They realize what their names
      suggest.

    - The computation of the tortuosity tau with the Millington-Quirk model has
      been optimized. Tests show a speedup of up to 5% for a 2p2c simulation.

    - The fully-implicit box scheme now fully supports prism-shaped elements.

    - Convenience functions for reading values from a file to a container and
      for writing values to a file from a container have been added, see
      `test_container_io` in `test/io/container`.
350
351

* IMMEDIATE INTERFACE CHANGES not allowing/requiring a deprecation period:
352
353
    - The problem class interface needs to provide the method maxTimeStepSize().
      This is important if you implement problem classes not deriving from the base
354
355
      problem classes in Dumux (`ImplicitProblem`, `OneModelProblem`,
      `ImpetProblem`, and `MultidomainProblem`).
356
357
358
359
    - All name-related methods that previously returned / received `const char*`
      do now use the type-safe alternative `std::string`. An example is
      `FluidSystem::componentName()`. If you need a
      `const char*` for special operation use the string member `c_str()`.
360
361
362

* Deprecated PROPERTY and PARAMETER NAMES, to be removed after 2.10: BEWARE: The
  compiler will not print any warning if a deprecated property or parameter name
363
364
365
366
367
  is used. If possible, a run-time warning will appear in the summary lines
  after the corresponding run.
    - The pure run-time parameter `tau` has been renamed to the property and
      run-time parameter `TauTortuosity`. For the models 1p2c, 2p2c, 3p3c it got
      the default value 0.5.
368
369

* Deprecated CLASSES/FILES, to be removed after 2.10:
370
371
372
    - The class `DiffusivityConstantTau<TypeTag, Scalar>` was renamed to
      `DiffusivityConstant<TypeTag>` and is located in a according new header. The
      old class, its header and the property `tau` are deprecated.
373

374
375
376
377
378
379
    - `PointSourceHelper<TypeTag>` has been deprecated. Use
      `BoundingBoxTreePointSourceHelper<TypeTag>` instead.

    - The classes `Dumux::Liquid/GasPhase<Scalar, Component>` have been moved to
      the namespace `Dumux::FluidSystems`.

380
* Deprecated MEMBER FUNCTIONS, to be removed after 2.10:
381
382
    - `checkEffectiveSaturation` of the classes `PlotMaterialLaw<TypeTag>` in
      `dumux/io`.
383

384
385
    - `concentrationGrad` of the class `TwoPNCFluxVariables<TypeTag>`. Use
      `moleFractionGrad` instead, with the obviously different physical meaning.
386
387
388
389
390
391

* DELETED classes/files, property names, constants/enums,
  member functions, which have been deprecated in DuMuX 2.9:
    - Everything listed as deprecated below has been removed.


392
393
394
395
Differences Between DuMuX 2.8 and DuMuX 2.9
===================================================

* IMPORTANT NOTES:
Bernd Flemisch's avatar
Bernd Flemisch committed
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
    - DuMuX 2.9 is expected to run based on either Dune 2.4 or Dune 3.0. We will
      try to keep the compatibility with Dune 3.0 as long as it is technically
      feasible and our resources allow it. If you want to use Dumux multidomain
      models, you have to stick with the Dune 2.4 core and specific versions of
      other modules, see `test/multidomain/README` for details.

    - The ALUGrid stand-alone library cannot be used any longer. Use the module
      [dune-alugrid](https://gitlab.dune-project.org/extensions/dune-alugrid)
      instead. Both the `releases/2.4` branch and the `master` should work.

    - The above is not true if you like to run a sequential MPFA model on an
      `ALUGrid`. Then, you currently have to use the `master-old` branch of
      dune-alugrid. We will try to fix this as soon as possible. Alternatively,
      `UGGrid` or `YaspGrid` can be chosen as grid managers.

    - Instead of using AlbertaGrid for the tests where dim < dimWorld, we now
      employ
      [dune-foamgrid](https://gitlab.dune-project.org/extensions/dune-foamgrid).
      Dune-foamgrid provides 1d and 2d simplex grids embedded in an arbitrary
      dimension world space. It features element parametrizations, runtime growth,
      runtime-movable vertices. You might still use AlbertaGrid, but it is not
      supported by our GridCreator.

    - If you like/have to use corner-point grids by means of the module
      dune-cornerpoint, you have to use (and partially patch) the 2015.10 release
      of [OPM](http://opm-project.org/?page_id=36). See `patches/README` for
      details.
423
424

* IMPROVEMENTS and ENHANCEMENTS:
Bernd Flemisch's avatar
Bernd Flemisch committed
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
    - The folder structure has been changed according to
      [FS#250](http://www.dumux.org/flyspray/index.php?do=details&task_id=250).
      This has been a rather massive change affecting more than 1000 files. Close
      to 400 files have been moved and/or renamed.
      We made everything backwards-compatible, the worst thing that should happen
      after switching to Dumux 2.9, will be some warnings when including headers
      from old destinations/names. You can fix the include statements and get rid
      of the warnings by applying the bash script `bin/fix_includes.sh` to your
      source files, for example by executing
      ```
      bash ../dumux/bin/fix_includes.sh file1 [file2 ...]
      ```
      or
      ```
      find . -name '*.[ch][ch]' -exec bash ../dumux/bin/fix_includes.sh {} \;
      ```
441
      inside the folder that contains your files.
442
443
444
445
      A patch is available to remove deprecated header files:
      ```
      patch -p1 < patches/dumux-2.9-no-deprecated-headers.patch
      ```
Bernd Flemisch's avatar
Bernd Flemisch committed
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
      The benefits are hopefully:
        + A clearer structure in terms of the problems that you want to apply Dumux
          for. Three main application areas on the top level: `porousmediumflow`,
          `freeflow` and `geomechanics`. The different numerical treatments "fully
          implicit" or "sequential" appear as discretization detail after the
          choice of the physical model. That's of course currently rather wishful
          thinking, but nevertheless where we are headed. The folder `implicit` on
          the top level now only contains physics-agnostic classes that can be used
          by any class of an application area.  Please note the change from
          "decoupled" to "sequential" according to the related task
          [FS#252](http://www.dumux.org/flyspray/index.php?do=details&task_id=252).

        + Nicer include statements due to relaxation of the naming conventions for
          the header files. Compare the old
          ```
          #include <dumux/multidomain/2cnistokes2p2cni/2cnistokes2p2cnilocaloperator.hh>
          ```
          with the new
          ```
465
          #include <dumux/multidomain/2cnistokes2p2cni/localoperator.hh>
Bernd Flemisch's avatar
Bernd Flemisch committed
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
          ```
      The structure change is reflected in the `test` folder:
        + The tests from`test/implicit/particular_model` have been moved to
          `test/porousmediumflow/particular_model/implicit`. For example,
          `test/implicit/2p` has been moved to `test/porousmediumflow/2p/implicit`.

        + Analogously, the tests from `test/decoupled/particular_model` have been
          moved to `test/porousmediumflow/particular_model/sequential`.

        + The subfolders `decoupled` and `implicit` of `test` have been removed.

        + If you have cloned the Dumux Git repository and have local changes in the
          folders `test/implicit` or `test/decoupled`, you can expect merge
          conflicts for your next `git pull`. You can either deal with these
          conflicts directly or create a patch, remove the local changes, pull, and
          apply the patch afterwards with some care to respect the changed
          structure.

    - A two-phase multiple-interacting-continua (MINC) model has been added to
      the Dumux model portfolio. See `test/porousmediumflow/2pminc/implicit` for
      details.

    - The multidomain models have been restructured. Duplicated code has been
      reduced; isothermal and non-isothermal models are treated in a more
      consistent manner.

    - It is now possible to specify point sources for implicit models. A point
      source is a source term specified at any point location in e.g. kg/s. Dumux
      will compute the correct control volume the source belongs to for you. Point
      sources can be e.g. solution and/or time-dependent. See tests
      (1p/implicit/pointsources, 2p/implicit/pointsources) for examples.

    - All tests use our standard `GridCreator` now. If it is possible to specify
      the grid entirely in the input-file, the corresponding DGF files have been
      deleted. In particular, a YaspGrid tensor grid can now also be specified via
      the input file only.

    - Several sections on our fluid/material framework have been moved from the
      handbook to the Doxygen documentation.

    - The three-phase constitutive relations from
      `material/fluidmatrixinteractions` have been reworked to be consistent with
      their two-phase analogues. In particular, an `EffToAbsLaw` and
      regularization classes have been implemented.

    - In case of a simulation stop due to too many timestep subdivisions, restart
      files of both the current and the old solution are automatically generated.
513

514
* IMMEDIATE INTERFACE CHANGES not allowing/requiring a deprecation period:
Bernd Flemisch's avatar
Bernd Flemisch committed
515
516
517
518
    - All flux variables are now default-constructible. While the non-trivial
      constructors are deprecated, model implementers might be required to make
      their flux variables default-constructible too. In particular, this affects
      you if you develop your own flux variables that
519
        + inherit from flux variables from dumux-stable, such as the
Bernd Flemisch's avatar
Bernd Flemisch committed
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
          `ImplicitDaryFluxVariables`,
        + and/or are used in a local residual from dumux-stable.
      See the
      [mailing list](https://listserv.uni-stuttgart.de/pipermail/dumux/2016q1/001551.html)
      for details.

    - For the multidomain models, the notation of the boundary condition types
      has changed. This is especially important for all momentum boundary
      conditions. In general:
        + `couplingInflow`  -> `couplingNeumann`
        + `couplingOutflow` -> `couplingDirichlet`
    - But for the momentum balances:
        + `couplingInflow`  -> `couplingDirichlet`
        + `couplingOutflow` -> `couplingNeumann`

    - Due to the change in the three-phase fluid-matrix-interactions, you might
      have to adjust your spatial parameters. You should get a compiler warning
      message that gives you more details.

    - The TypeTags `ImplicitModel` and `ExplicitModel` have been deleted. They
      haven't been used apart from one internal inheritance. See FS#304 for
      details.
542

Timo Koch's avatar
Timo Koch committed
543
* Deprecated PROPERTY and PARAMETER NAMES, to be removed after 2.9: BEWARE: The
544
545
546
  compiler will not print any warning if a deprecated property or parameter name
  is used. However, a run-time warning should appear in the summary lines after
  the corresponding run.
Bernd Flemisch's avatar
Bernd Flemisch committed
547
548
549
550
551
552
    - The word `Decoupled` in the TypeTags has been replaced by `Sequential`:
        + `DecoupledModel` -> `SequentialModel`
        + `DecoupledOneP` -> `SequentialOneP`
        + `DecoupledTwoP` -> `SequentialTwoP`
        + `DecoupledTwoPTwoC` -> `SequentialTwoPTwoC`
        + `DecoupledTwoPTwoCAdaptive` -> `SequentialTwoPTwoCAdaptive`
553

554

Timo Koch's avatar
Timo Koch committed
555
* Deprecated CLASSES/FILES, to be removed after 2.9:
Bernd Flemisch's avatar
Bernd Flemisch committed
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
    - Self-written parallel linear solvers and corresponding infrastructure,
      according to
      [FS#293](http://www.dumux.org/flyspray/index.php?do=details&task_id=293).
      For parallel runs, use the `AMGBackend` instead. For sequential runs,
      direct replacements are:
        + `BoxBiCGStabILU0Solver` -> `ILU0BiCGSTABBackend`
        + `BoxBiCGStabSORSolver` -> `SORBiCGSTABBackend`
        + `BoxBiCGStabSSORSolver` -> `SSORBiCGSTABBackend`
        + `BoxBiCGStabJacSolver` -> `JacBiCGSTABBackend`
        + `BoxBiCGStabGSSolver` -> `GSBiCGSTABBackend`
        + `BoxCGILU0Solver` -> `ILUnCGBackend`
        + `BoxCGSORSolver` -> `SORCGBackend`
        + `BoxCGSSORSolver` -> `SSORCGBackend`
        + `BoxCGJacSolver` -> `JacCGBackend`
        + `BoxCGGSSolver` -> `GSCGBackend`
        + `IMPETBiCGStabILU0Solver` -> `ILU0BiCGSTABBackend`

    - `CubeGridCreator`, functionality available in default `GridCreator`

    - `SimplexGridCreator`, functionality available in default `GridCreator`

    - `DgfGridCreator`, functionality available in default `GridCreator` (since 2.8)

    - `Decoupled...Indices` -> `Sequential...Indices` (BEWARE: maybe no compiler
    warnings)
581

Timo Koch's avatar
Timo Koch committed
582
* Deprecated MEMBER FUNCTIONS, to be removed after 2.9:
583

Timo Koch's avatar
Timo Koch committed
584
* Deprecated protected MEMBER VARIABLES, to be removed after 2.9: BEWARE: Older
585
586
587
588
  compilers will not print any warning if a deprecated protected member variable
  is used.

* DELETED classes/files, property names, constants/enums,
Timo Koch's avatar
Timo Koch committed
589
  member functions, which have been deprecated in DuMuX 2.8:
Bernd Flemisch's avatar
Bernd Flemisch committed
590
591
    - Everything listed as deprecated below has been removed.

592

Thomas Fetzer's avatar
Thomas Fetzer committed
593
594
595
596
Differences Between DuMuX 2.7 and DuMuX 2.8
===================================================

* IMPORTANT NOTES:
Bernd Flemisch's avatar
Bernd Flemisch committed
597
598
599
600
601
602
  - DuMuX 2.8 is expected to run based on either Dune 2.3 or Dune 2.4. However,
    no attempt has been made to fix the warnings arising from the deprecation of
    EntityPointer in Dune 2.4. This will be made during the next release cycle.
    Moreover, using the multidomain models based on Dune 2.4 is currently only
    possible by patching dune-multidomaingrid. See test/multidomain/README for
    details.
Thomas Fetzer's avatar
Thomas Fetzer committed
603

604
605
606
* DELETED BUILD SYSTEM: The Autotools based build system was removed, use the
  CMake based build system as it is default since Dune 2.4.

Thomas Fetzer's avatar
Thomas Fetzer committed
607
* IMPROVEMENTS and ENHANCEMENTS:
Bernd Flemisch's avatar
Bernd Flemisch committed
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
  - New fully-implicit porous-media models for two fluid phases that may consist
    of an arbitrary number of components have been added. The basic one is
    associated with the property TwoPNC, see test/implicit/2pnc. A more advanced
    one that incorporates solid-fluid phase changes is indicated by TwoPNCMin,
    see test/implicit/2pncmin.

  - The implicit cell-centered models now can use adaptive grid refinement. To
    make a test problem adaptive, just set the property AdaptiveGrid to true and
    choose corresponding indicators via AdaptionInitializationIndicator and
    AdaptionIndicator, see test/implicit/2p/lensproblem.hh for an example. So
    far, indicators are only provided for the TwoPModel. Indicators for other
    models will be provided in the future, as well as parallelization and box
    discretization.

  - With the CpGridCreator, a grid creator has been introduced that reads from a
    Petrel output / Eclipse input file and generates a CpGrid that is offered by
    the OPM module dune-cornerpoint. The fully-implicit cell-centered models are
    now able to deal with cornerpoint grids. See
    test/implicit/2p/test_cc2pcornerpoint for a test of the functionality. A
    realistic corner-point grid will be provided in dumux-lecture soon. The OPM
    modules need to be patched to be compatible with Dune's CMake based build
    system, see patches/README for details.

Thomas Fetzer's avatar
[docu]    
Thomas Fetzer committed
631
  - Zero equation turbulence models (zeroeq) have been added as new models
Bernd Flemisch's avatar
Bernd Flemisch committed
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
    to the freeflow folder. Tests for coupling a turbulent free flow using
    zeroeq turbulence models with flow in a porous medium have been added.

  - A new class GridCreator is now the new standard grid creator replacing
    DgfGridCreator. It comprises all functionality from the DgfGridCreator (see
    also immediate interface changes), plus the ability to read gmsh, or to
    build a structured grid (only with Dune 2.4) by merely changing the input
    file.

  - Multidomain problems can now be run by using the general start routine,
    just as most other problems. For this, the constructor of the multidomain
    problems has been changed and the InterfaceMeshCreator has been replaced by
    the InterfaceGridCreator, see below.

  - The Richards model has now an additional flag useHead, which can be used to
    switch between a pressure-saturation and a pressureHead-watercontent
    formulation. The primary variables are either pressure in [Pa] or pressure
    head in [cm], respectively. Default is useHead = false. See
    test/implicit/richards for details.

  - A bug in the diffusion term in the freeflow models has been fixed.

  - A lot of work has been devoted to improving the testing environment, adding
    new tests, restructuring the handbook and improving the documentation.
Thomas Fetzer's avatar
Thomas Fetzer committed
656
657

* IMMEDIATE INTERFACE CHANGES not allowing/requiring a deprecation period:
Bernd Flemisch's avatar
Bernd Flemisch committed
658

659
660
  - The (new standard) GridCreator's public method gridPtr has been removed. For
    using PARAMETERS from DGF files use the GridCreators parameters method via
Bernd Flemisch's avatar
Bernd Flemisch committed
661
662
663
664
    GridCreator::parameters(...). See test/implicit/co2 for an example.

  - The use and support for SGrid is dropped. SGrid is deprecated in Dune 2.4.
    Use YaspGrid instead.
Thomas Fetzer's avatar
Thomas Fetzer committed
665

666
* Deprecated PROPERTY and PARAMETER NAMES, to be removed after 2.8: BEWARE: The
Thomas Fetzer's avatar
Thomas Fetzer committed
667
668
669
670
  compiler will not print any warning if a deprecated property or parameter name
  is used. However, a run-time warning should appear in the summary lines after
  the corresponding run.

671
* Deprecated CLASSES/FILES, to be removed after 2.8:
Thomas Fetzer's avatar
[io]    
Thomas Fetzer committed
672
673
674
  - The InterfaceMeshCreator has been moved to InterfaceGridCreator and adapted
    to the structure of other grid creators, it can simply be used by specifying
    the GridCreator TypeTag.
Thomas Fetzer's avatar
Thomas Fetzer committed
675

676
* Deprecated MEMBER FUNCTIONS, to be removed after 2.8:
Bernd Flemisch's avatar
Bernd Flemisch committed
677
678
679
680
  - The constructor of the multidomain problems has changed. They will now be
    called directly from the start.hh, identical to the other problems. The new
    parameters are the TimeManager and the HostGrid.

681
  - The method simulate(Scalar dtInitial, Scalar tEnd) from MultiDomainProblem,
Bernd Flemisch's avatar
Bernd Flemisch committed
682
683
684
685
686
687
688
    is unused and will be dropped.

  - The GnuplotInterface functions are now called without giving a window
    number. If plots should be plotted in different windows, different
    GnuplotInterface objects are now required. This affects also all other plots
    in the "io" folder.

Thomas Fetzer's avatar
[io]    
Thomas Fetzer committed
689
690
  - The write() function in plotoverline2d.hh now has an append function, to be
    able to decide whether the previously written file should be kept or not.
Thomas Fetzer's avatar
Thomas Fetzer committed
691

692
693
* Deprecated protected MEMBER VARIABLES, to be removed after 2.8: BEWARE: Older
  compilers will not print any warning if a deprecated protected member variable
Thomas Fetzer's avatar
Thomas Fetzer committed
694
695
696
  is used.

* DELETED classes/files, property names, constants/enums,
697
  member functions, which have been deprecated in DuMuX 2.7:
Thomas Fetzer's avatar
Thomas Fetzer committed
698
699
  Everything listed as deprecated below has been removed.

Bernd Flemisch's avatar
Bernd Flemisch committed
700
701
Differences Between DuMuX 2.6 and DuMuX 2.7
===================================================
Bernd Flemisch's avatar
Bernd Flemisch committed
702

703
704
705
706
707
708
* IMPORTANT NOTES:
  - DuMuX 2.7 should work with DUNE 2.3 as well as 2.4. However, at the time of
    writing, DUNE-multidomain(grid) doesn't work with DUNE 2.4. Therefore, if a
    DuMuX multidomain model should be used, DUNE 2.3 is required. See
    test/multidomain/README for details.

709
710
711
  - The 2.3 branch of dune-alugrid has no CMake support, use dune-alugrid master
    respectivly 2.4. Or you can fall back to Autotools or use legacy ALUGrid
    1.52.
712

Bernd Flemisch's avatar
Bernd Flemisch committed
713
* IMPROVEMENTS and ENHANCEMENTS:
Bernd Flemisch's avatar
Bernd Flemisch committed
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
  - Since 2.6, all isothermal implicit porous-media models (except 2pdfm) can be
    easily enhanced with the energy equation. For 2.7, this has been also
    carried out for the models that were only isothermal before, namely, 1p, 3p
    and richards. Tests have been written and are provided in test/implicit. In
    order to keep the number of subfolders bearable, isothermal as well as
    thermal tests are gathered in the model folders "1p", "1p2c", ..., "3p3c",
    "mpnc", "richards" (without the "ni") and the corresponding "ni"-folders
    have been deleted.

  - All implicit porous-media models (except 2pdfm) are now able to run on grids
    with dim < dimWorld. In implicit/1p, four new tests are added that run the
    1p test problem on 1d-3d and 2d-3d Alberta grids with box and cell-centered,
    respectively. Compilation has been tested also for all other models, but no
    runtime testing has been performed.

Bernd Flemisch's avatar
Bernd Flemisch committed
729
730
731
732
733
734
  - The terminology for the Newton method has been improved according to FS#238.
    In particular, what has been referred to as "relative error" is now termed
    "maximum relative shift", while "absolute error" has been renamed to
    "residual reduction". This is particularly important, if corresponding
    parameters or properties are set, see below.

735
736
737
738
  - The geomechanics ElTwoPModel runs in parallel now. This is made possible by
    a dedicated solver, the El2PAMGBackend which has to be set for the property
    LinearSolver in the problem file. See test/geomechanics/el2p for details.

Bernd Flemisch's avatar
Bernd Flemisch committed
739
740
741
742
  - Before, velocity output for the implicit porous-media models only worked for
    cube grids. This has been generalized to simplices (box and cc) and prisms/
    pyramids (box only).

Thomas Fetzer's avatar
Thomas Fetzer committed
743
744
745
746
747
748
749
750
751
752
753
  - Revised and fixed restart capability for the multidomain models.

  - A gnuplot interface has been added (works only with CMake). With
    this interface it is possible to plot material laws (like in the 2p2cni test),
    or to generate live-updating output (like in test_2cnistokes2p2cni).
    The gnuplot interface reads analytical functions, data file or data arrays.

  - The fuzzycompare script for automatic testing has been improved. Instead of
    printing only the first deviation from the reference solution, it now
    prints the maximum deviation in each field/variable.

754
755
756
757
758
759
* DEPRECATED BUILD SYSTEM: DuMuX 2.7 will be the last release which can be built
    with the Autotools based build system. It is deprecated and will be removed
    for DuMuX 2.8. We encourage the change towards CMake, especially with the
    upcoming DUNE 2.4.
    The warning can be suppressed with --disable-dumux-deprecated-autotools

Bernd Flemisch's avatar
Bernd Flemisch committed
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
* IMMEDIATE INTERFACE CHANGES not allowing/requiring a deprecation period:
  - Before, the "heatCapacity" function in the spatial parameters and volume
    variables of the implicit nonisothermal models was a misnomer, since it
    returned an effective quantity, namely,
    heatCapacity*density*(1 - porosity) in [J/(K m^3)].
    Except for mpnc, which resulted in an additional inconsistency.
    Corresponding to the decision documented in FS#216, the function has been
    renamed to "solidHeatCapacity" and returns always the "true" (non-effective)
    heat capacity in [J/(kg K)]. This requires an additional function
    "solidDensity" which returns the mass density of the porous matrix.
    Moreover, the functions "thermalConductivitySolid/Fluid" are renamed to
    "solid/fluidThermalConductivity". The decision to prepend with "solid/fluid"
    rather than to append is motivated by consistency with components and fluid
    systems, where "gas" and "liquid" are always prepended to the corresponding
    function names.
    Therefore, it might be necessary to adapt your thermal solid parameters in
    the spatialparams file such that they offer functions "solidHeatCapacity",
    "solidDensity" and "solidThermalConductivity". See
    test/implicit/2p2c/injectionspatialparams.hh for an example.

Bernd Flemisch's avatar
Bernd Flemisch committed
780
781
782
783
784
785
786
787
788
789
  - Due to the change in the Newton terminology (see above), there exist two
    backward-compatibility breakages:
    . If a model re-implements the function "relativeErrorDof", it has to be
      renamed to "relativeShiftAtDof". See dumux/implicit/implicitmodel.hh for
      an example.

    . If a NewtonController re-implements the function "newtonUpdateRelError",
      it has to be renamed to "newtonUpdateShift". See
      dumux/nonlinear/newtoncontroller.hh for an example.

790
791
792
  - The properties "AMGPDELabBackend" and "AMGLocalFemMap" have been unified to
    "AmgTraits".

Bernd Flemisch's avatar
Bernd Flemisch committed
793
794
795
796
797
798
799
800
801
802
803
804
805
* Deprecated PROPERTY and PARAMETER NAMES, to be removed after 2.7: BEWARE: The
  compiler will not print any warning if a deprecated property or parameter name
  is used. However, a run-time warning should appear in the summary lines after
  the corresponding run.
  - Corresponding to the improved Newton terminology, the following properties
    (prepended with "Newton") and parameters (in the group "Newton") are
    renamed:
    AbsTolerance -> ResidualReduction
    EnableAbsoluteCriterion -> EnableResidualCriterion
    RelTolerance -> MaxRelativeShift
    EnableRelativeCriterion -> EnableShiftCriterion
    SatisfyAbsAndRel -> SatisfyResidualAndShiftCriterion

Bernd Flemisch's avatar
Bernd Flemisch committed
806
* Deprecated CLASSES/FILES, to be removed after 2.7:
807
808
809
810
811
  - SeqAMGBackend and ScaledSeqAMGBackend, replaced by AMGBackend.

  - P0LocalFiniteElementMap.

  - CellData2P2Cmultiphysics, replaced by CellData2P2CMultiPhysics.
812

813
814
  - BoxLocalOperator from dumux/multidomain/common/pdelablocaloperator.hh.

Bernd Flemisch's avatar
Bernd Flemisch committed
815
816
817
818
819
820
821
* Deprecated MEMBER FUNCTIONS, to be removed after 2.7:
  - The functions "heatCapacity", "densitySolid" (mpnc only) and
    "thermalConductivitySolid/Fluid" in the VolumeVariables of the nonisothermal
    implicit porous-media models: use "solidHeatCapacity", "solidDensity" and
    "solid/fluidThermalConductivity" instead. See also the immediate interface
    changes above.

Bernd Flemisch's avatar
Bernd Flemisch committed
822
823
824
825
826
827
828
829
830
  - In dumux/implicit/common/implicitmodel.hh and
    dumux/geomechanics/el2p/elp2basemodel.hh:
    "relativeErrorDof" -> "relativeShiftAtDof"

  - In dumux/nonlinear/newtoncontroller.hh:
    "setRelTolerance" -> "setMaxRelativeShift"
    "setAbsTolerance" -> "setResidualReduction"
    "newtonUpdateRelError" -> "newtonUpdateShift"

831
832
833
834
  - The 1p2c volume variables no longer use the method tortuosity() from
    spatial params class, the value is now calculated within the effective
    diffusivity model. Thus the method is deprecated in the spacial params
    classes FVSpatialParamsOneP and ImplicitSpatialParamsOneP.
Bernd Flemisch's avatar
Bernd Flemisch committed
835

Bernd Flemisch's avatar
Bernd Flemisch committed
836
* Deprecated protected MEMBER VARIABLES, to be removed after 2.7: BEWARE: Older
837
  compilers will not print any warning if a deprecated protected member variable
Bernd Flemisch's avatar
Bernd Flemisch committed
838
839
840
841
842
843
844
845
846
847
848
849
850
  is used.
  - In dumux/nonlinear/newtoncontroller.hh:
    "error_" -> "shift_"
    "lastError_" -> "lastShift_"
    "tolerance_" -> "shiftTolerance_"
    "absoluteError_" -> "reduction_"
    "lastAbsoluteError_" -> "lastReduction_"
    "initialAbsoluteError_" -> "initialResidual_"
    "absoluteTolerance_" -> "reductionTolerance_"
    "enableRelativeCriterion_" -> "enableShiftCriterion_"
    "enableAbsoluteCriterion_" -> "enableResidualCriterion_"
    "satisfyAbsAndRel_" -> "satisfyResidualAndShiftCriterion_"

Bernd Flemisch's avatar
Bernd Flemisch committed
851
* DELETED classes/files, property names, constants/enums,
Bernd Flemisch's avatar
Bernd Flemisch committed
852
853
854
855
  member functions, which have been deprecated in DuMuX 2.6:
  Everything listed as deprecated below has been removed.


856
857
858
859
Differences Between DuMuX 2.5 and DuMuX 2.6
===================================================

* IMPROVEMENTS and ENHANCEMENTS:
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
  - For the non-isothermal porous media models, the energy equation is
    implemented in a more generic way for all models in
    dumux/implicit/nonisothermal. The existing TypeTag names like TwoPNI stay
    the same. If a new non-isothermal model should be used, it is important
    to NOT include anything from the old model-specific implementation like
    from dumux/implicit/2pni, but to include from the model folder without the
    "ni". See test/implicit/2pni for details. In principle, any isothermal
    porous media model can be enhanced with the energy equation. Ideally, only
    the corresponding property files have to be augmented. See
    dumux/implicit/2p/2ppropert*.hh for details. The 1p2c model already has
    been enhanced, the remaining models will follow in 2.7.

  - The AMG backend is based directly on dune-istl now. No PDELab is required
    anymore. The tests so far exhibit an improved robustness. Thanks to Markus
    Blatt for the work.

  - The multidomain models can now be used with the 2.3 release versions of the
    DUNE core modules and dune-multidomaingrid, and the 2.0 release versions
    of dune-pdelab and dune-multidomain. See test/multidomain/README for
    details.

  - In the fully implicit mpnc model, a further specialization allows now to
    describe two-phase flow with two energy equations.

  - The free flow models now include the component enthalpy fluxes transported
    by diffusion processes (h^k D grad x), which was not considered before.

  - UMFPack is a new direct linear solver and can be use as a drop-in
    replacement for SuperLU. Some users claim a speed-up up to a factor of
    seven. We know cases where it was 10% slower, so please measure for your
    problems.
891
892

* IMMEDIATE INTERFACE CHANGES not allowing/requiring a deprecation period:
893
894
895
896
897
898
899
900
901
  - The 3p3cni model now also uses an effective thermal conductivity model
    (ETCM). The ETCM is easily exchangeable. The default one is
    ThermalConductivitySomerton, which is implemented in
    dumux/material/fluidmatrixinteractions/3p. The ETCM requires that 3p3cni
    spatial parameters provide a function thermalConductivitySolid instead of
    matrixHeatFlux. See test/implicit/3p3cni/columnxylolspatialparams.hh for
    details. Moreover, the employed fluid system has to actually implement the
    function thermalConductivity. See
    dumux/material/fluidsystems/h2oairxylenefluidsystem.hh for details.
902

903
904
905
906
907
908
909
910
911
  - The non-isothermal flux variables call the effective thermal conductivity
    models (ETCM) in a different way. If you used a self-written ETCM and want
    to use a new non-isothermal model, the ETCM has to be adapted. See
    material/fluidmatrixinteractions/2p/thermalconductivitysomerton.hh for
    details.

  - Fully implicit mpnc model: in order to account for the possibility of using
    two energy equations, the boolean property EnableKineticEnergy has been
    changed to the integer property NumEnergyEquations.
912

913
914
915
* Deprecated way of setting command line parameters, to be removed after 2.6:
  - To set paramaters from the command line, the notation --parameterFile=NAME
    is deprecated. Use from now on -ParameterFile NAME.
916

917
918
919
* Deprecated CLASSES/FILES, to be removed after 2.6:
  - The old non-isothermal porous media models are deprecated. Technically,
    including a ..niproperties.hh file triggers a deprecation warning.
920

921
922
923
924
925
  - FVPressure2P2CAdaptive, use dimension-specific implementations
    FV2dPressure2P2CAdaptive and FV3dPressure2P2CAdaptive instead.

  - FVTransport2P2CAdaptive, use dimension-specific implementations
    FV2dTransport2P2CAdaptive and FV3dTransport2P2CAdaptive instead.
926
927

* Deprecated MEMBER FUNCTIONS, to be removed after 2.6:
928
929
930
931
932
  - In the Stokes flux variables, the method eddyViscosity() is deprecated, use
    dynamicEddyViscosity() instead.

  - In the Stokes non-isothermal flux variables, the method eddyConductivity()
    is deprecated, use thermalEddyConductivity() instead.
933

934
935
936
  - Already in 2.5, the following member functions of MultiDomainModel/Problem
    have been deprecated: subProblemX, subModelX, subIDX, gridViewX with X=1,2.
    They are replaced by sdProblemX, sdModelX, sdIDX, sdGridViewX.
937

938
* DELETED classes/files, property names, constants/enums,
939
940
941
942
  member functions, which have been deprecated in DuMuX 2.5:
  Everything listed as deprecated below has been removed.


943
944
945
946
Differences Between DuMuX 2.4 and DuMuX 2.5
===================================================

* IMPROVEMENTS and ENHANCEMENTS:
947
  - The three-dimensional implementation of the MPFA L-method is made
948
    available for the decoupled compositional 2p2c models. It also allows
949
    for simulation on an adaptive grid.
950
  - Coupling of 2c2p with stokesnc and 2p2cNI with Stokesncni was
951
952
953
    added. The stokes2c and stokes2cni are now DEPRECATED and will be kicked
    out by the next release. Instead generalized stokesnc and stokesncni
    models are introduced. Unlike 2c models the transport equations in
954
    the nc models are capapable of using both mass and mole fractions.
955
    NOTE: For coupling test examples be aware of the harsh version
956
    restrictions mentioned in dumux/test/modelcoupling/README.
957

958
* IMMEDIATE INTERFACE CHANGES not allowing/requiring a deprecation period:
959
  - Dropped support for PDELab 1.0.1, PDELab 1.1 is required.
960
961

* Deprecated CLASSES/FILES, to be removed after 2.5:
962
963
  - Stokes2cModel was replaced by StokesNCModel, similar for more
    Stokes2c* classes.
964

965
* DELETED classes/files, property names, constants/enums,
966
967
968
969
  member functions, which have been deprecated in DuMuX 2.4:
  Everything listed as deprecated below has been removed.


970
971
972
Differences Between DuMuX 2.3 and DuMuX 2.4
===================================================

973
974
975
976
977
978
979
* IMPORTANT NOTES:
  - If the current trunk version of DUNE (2.3) is used, the co2 and co2ni tests
    require that the DUNE_GRID_EXPERIMENTAL_GRID_EXTENSIONS flag is set. This
    flag is needed in order to be able to use the function boundaryId(). An
    error is thrown during compilation if the flag is not set. For reference see
    the commented part in optim.opts and debug.opts.

980
981
  - All two-component models (1p2c, 2p2c, 2p2cni, co2, co2ni) can now be used
    with either mole or mass fractions. The property useMoles has to be set in
982
    the problem file and the boundary conditions have to be choosen accordingly.
983
984
985
    . 1p2c, 2p2c, 2p2cni use MOLE fractions by default.
    . co2, co2ni use MASS fractions by default.
    . For completeness: 3p3c, 3p3cni and mpnc use MOLE fractions only.
986

987
* IMPROVEMENTS and ENHANCEMENTS:
988
989
990
991
992
993
994
995
996
  - Three geomechanics models have been added, thanks to the previous PhD work
    of Melanie Darcis. The models are located in dumux/geomechanics, a test for
    each model is provided in test/geomechanics:
    . elastic: linear elasticity equations that account only for the solid
               mechanics.
    . el1p2c:  poroelasticity equations for one solid and one fluid phase, where
               the fluid phase is admitted to consist of two components.
    . el2p:    poroelasticity equations for one solid phase and two immiscible
               fluid phases.
997

998
999
1000
  - A three-dimensional implementation of the MPFA L-method is added and made
    available for the decoupled 2p models. It also allows for simulation on
    an adaptive grid.
1001

Bernd Flemisch's avatar
Bernd Flemisch committed
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
  - The MPNC model now allows to drop the assumptions of local thermal and/or
    chemical equilibrium. Dropping the local chemical equilibrium assumption
    leads to mole fractions in different phases that are not determined via
    equilibrium relations. If the local thermal equilibrium assumption is
    dropped, phases (fluids and solid) are locally allowed to have different
    temperatures. See test/implicit/mpnc/test_boxmpnckinetic for an example.

  - A fully-implicit three-phase immiscible model has been added. The headers
    are contained in dumux/implicit/3p, tests are provided in test/implicit/3p.

1012
1013
1014
1015
1016
1017
  - The handling of Dirichlet boundary conditions for the fully-implicit cell-
    centered models has been improved. Now, the conditions are evaluated at the
    centers of the corresponding boundary faces. In general, they are
    incorporated into the local residual in a weak sense. Only for mixed
    Dirichlet/Neumann conditions and for the MPNC model, they still are
    incorporated in a strong sense.
1018

1019
1020
1021
  - The sequential models can use a sub-timestepping in the transport scheme, if
    the property "SubCFLFactor" is chosen smaller than "CFLFactor", which in
    that case specifies the CFL factor used in the pressure equation.
1022
1023
1024

  - All fully-implicit porous-media models now provide the possibility to write
    the velocities to the VTK output. This can be achieved by setting the
1025
    parameter "AddVelocity" of the group "Vtk" or the corresponding property
1026
1027
    "VtkAddVelocity." See test/implicit/1p2c for an example.

1028
1029
1030
  - The CMake build system support uses the experimental mechanisms from DUNE.
    Recent versions of Dune 2.3-svn or newer are required to use CMake.

1031
1032
1033
1034
1035
1036
1037
1038
1039
  - Our naming rules have been refined and enforced for member functions and
    variables. Many inconsistencies could be removed, especially the special
    status of the capitalized "S" indicating saturation. See the deprecation
    listings below or FS#180 for details.

  - Misleading names in the fully-implicit models that still contained "b/Box"
    have been replaced by more generic ones. See the deprecation listings below
    or FS#194 for details.

1040
  - The ...FVElementGeometry classes have been cleaned up a bit. See the
1041
    deprecation listings below or FS#192 for details.
1042

1043
1044
  - Added compiler support for Clang 3.2, Clang 3.3, and GCC 4.8.

1045
* Deprecated CLASSES/FILES, to be removed after 2.4:
1046
  - OnePBoxModel, OnePTwoCBoxModel -> OnePModel, OnePTwoCModel
1047

Bernd Flemisch's avatar
Bernd Flemisch committed
1048
  - Headers containing capitalized letters are replaced by their non-capitalized
1049
1050
    analogs.
    In dumux/decoupled: 1p/cellData1p.hh, 1p/fluxData1p.hh,
Bernd Flemisch's avatar
Bernd Flemisch committed
1051
1052
1053
1054
1055
1056
    2p/cellData2padaptive.hh, 2p/fluxData2p.hh, 2p/cellData2p.hh,
    2p2c/cellData2p2c.hh, 2p2c/cellData2p2cadaptive.hh, 2p2c/fluxData2p2c.hh,
    2p2c/cellData2p2cmultiphysics.hh.
    In dumux/material/fluidmatrixinteractions/3p: parkerVanGen3p.hh,
    parkerVanGen3pparams.hh.

1057
* Deprecated CONSTANTS/ENUMS, to be removed after 2.4: BEWARE: Older compilers
1058
  will not print any warning if a deprecated constant/enum is used.
1059
  - saturation indices: S0Idx, SnIdx, SnOrXIdx, SOrX1Idx, SOrX2Idx, SwIdx,
1060
1061
    SwOrXIdx
    -> s0Idx, snIdx, snOrXIdx, sOrX1Idx, sOrX2Idx, swIdx, swOrXIdx
1062

1063
1064
  - two-phase formulations: pnSn, pnSw, pwSn, pwSw -> pnsn, pnsw, pwsn, pwsw

1065
  - DecoupledTwoPCommonIndices: pressureNW, saturationNW, velocityNW
1066
1067
1068
1069
1070
1071
1072
1073
    -> pressureNw, saturationNw, velocityNw

  - DecoupledTwoPIndices: pressEqIdx -> pressureEqIdx

  - MPNCIndices: NumPrimaryEnergyVars, NumPrimaryVars
    -> numPrimaryEnergyVars, numPrimaryVars

* Deprecated public MEMBER VARIABLES, to be removed after 2.4: BEWARE: Older
1074
  compilers will not print any warning if a deprecated public member variable
1075
  is used.
1076
1077
1078
1079
  - ...FVElementGeometry: numEdges, numFaces, numFap, numVertices
    -> numScvf, -, numFap of each subcontrolvolume face, numScv

  - BoxFVElementGeometry: edgeCoord, faceCoord
1080

1081
1082
1083
1084
* Deprecated MACROS, to be removed after 2.4: BEWARE: The compiler will not
  print any warning if a deprecated macro is used.
  - DUMUX_ALWAYS_INLINE whether the according attribute is supported

1085
* Deprecated MEMBER FUNCTIONS, to be removed after 2.4:
1086
1087
1088
1089
1090
  - all problems: bboxMin/Max() -> bBoxMin/Max()

  - ImplicitProblem: boxSDNeumann(), boxSDSource()
    -> solDependentNeumann(), solDependentSource()

1091
  - ImplicitPorousMediaProblem: boxGravity(), boxTemperature()
1092
1093
    -> gravityAtPos(), temperatureAtPos() (different signatures!)

1094
  - fluid-matrix-interactions: dkrn_dSw(), dkrw_dSw(), dpc_dSw(), pC(),
1095
    dSw_dpC(), Sgr(), Snr(), SnToSne(), Sw(), Swr(), SwToSwe()
1096
    -> dkrn_dsw(), dkrw_dsw(), dpc_dsw(), pc(), dsw_dpc(), sgr(), snr(),
1097
1098
    snToSne(), sw(), swr(), swToSwe()

1099
  - LinearMaterial(Params): entryPC(), maxPC(), setEntryPC(), setMaxPC()
1100
1101
    -> entryPc(), maxPc(), setEntryPc(), setMaxPc()

1102
  - RegularizedVanGenuchten(Params): pCHighSw(), pCLowSw()
1103
1104
1105
1106
1107
    -> pcHighSw(), pcLowSw()

  - VanGenuchtenParams, ParkerVanGen3PParams: setVgM(), setVgN(), vgM(), vgN()
    -> setVgm(), setVgn(), vgm(), vgn()

1108
  - ParkerVanGen3P(Params): betaGN(), betaGW(), betaNW(), pCAlpha(), pCGN(),
1109
    pCGW(), pCNW(), setBeta..., setkrRegardsSnr(), Swrx()
1110
    -> betaGn(), betaGw(), betaNw(), pcAlpha(), pcgn(), pcgw(), pcnw(),
1111
1112
1113
1114
1115
1116
    setBeta..., setKrRegardsSnr(), swrx()

  - MPLinearMaterialParams: Sreg() -> sReg()

  - EvalCflFlux...: getCFLFluxFunction() -> getCflFluxFunction

1117
  - FVMPFAOInteractionVolume: getNTKNu_by_dF(), getNTKNu(), getNTKrKNu_by_dF(),
1118
1119
1120
1121
1122
1123
1124
    getNTKrKNu()
    -> getNtkNu_df(), getNtkNu(), getNtkrkNu_df(), getNtkrkNu()

  - TwoPDFMVolumeVariables: dSM_dSF() -> dsm_dsf()

  - Stokes...Variables: viscosity() -> dynamicViscosity()

1125
1126
1127
  - IAPWS water: ddgamma_ddpi, ddgamma_ddtau, ddgamma_dtaudpi, dgamma_dpi,
    dgamma_dtau, dp_dpi, dpi_dp, dtau_dt
    -> ddGamma_ddPi, ddGamma_ddTau, ddGamma_dTaudPi, dGamma_dPi, dGamma_dTau,
1128
    dp_dPi, dPi_dp, dTau_dt
1129

1130
* DELETED classes/files, property names, constants/enums,
1131
1132
1133
1134
  member functions/variables, which have been deprecated in DuMuX 2.3:
  Everything listed as deprecated below has been removed.


1135
Differences Between DuMuX 2.2 and DuMuX 2.3
Christoph Grueninger's avatar
Christoph Grueninger committed
1136
1137
1138
===================================================

* IMPROVEMENTS and ENHANCEMENTS:
1139
  - A fully implicit two-phase discrete-fracture-matrix model has been added,
1140
1141
1142
1143
1144
1145
1146
    see test/implicit/2pdfm.

  - Almost all porous media fully implicit models now can either use a
    vertex-centered (box) or a cell-centered spatial discretization. The choice
    of the spatial discretization method is controlled by deriving the problem
    type tag either from BoxModel or CCModel. This allows for a uniform problem
    description, as long as the boundaryTypesAtPos and dirichletAtPos methods
1147
1148
1149
1150
    can be used. By evaluating the compile-time property ImplicitIsBox, it is
    easily possible to separately handle the different discretizations inside
    am common method. See the tests in test/implicit for examples.
    Correspondingly, the directory structure has been adapted.
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
    Old:             New:
    dumux/           dumux/
      boxmodels/       implicit/
        common/          common/
        1p/              box/
        1p2c/            cellcentered/
        2p/              1p/
        ...              ...
    test/            test/
      boxmodels/       implicit/
        1p/              1p/
          test_1p          test_box1p
        ...                test_cc1p
                         ...

  - A backend for the ISTL AMG solver has been included, based on the
1167
1168
1169
1170
1171
    corresponding DUNE-PDELab backends. It can be used for the fully
    implicit and the decoupled models, see test_*1pwithamg in
    test/implicit/1p and test_impeswithamg in test/decoupled/2p.
    DUNE-PDELab and possibly DUNE-ISTL have to be patched, see the file
    README in the patches directory.
1172

1173
1174
1175
  - The decoupled models have been parallelized, see test_impeswithamg in
    test/decoupled/2p. They work in parallel only if the AMGBackend is used
    as linear solver. No dynamic loadbalancing can be done yet.
1176
1177

  - The MPNC model can use either the most wetting or the most non-wetting phase
1178
    pressure as primary variable. This is controlled via the property
1179
1180
    "PressureFormulation."

1181
  - The table of available parameters has been improved, see
1182
    http://www.dumux.org/doxygen-stable/html-2.2/a00838.php
Klaus Mosthaf's avatar
Klaus Mosthaf committed
1183

1184
  - Improved handling of the conductive heat fluxes in the non-isothermal implicit
1185
    two-phase models, see the problem files in test/implicit/2p(2c)ni.
Klaus Mosthaf's avatar
Klaus Mosthaf committed
1186

1187
  - Introduced new selection of start/stop messages.
1188
1189

* IMMEDIATE INTERFACE CHANGES not allowing/requiring a deprecation period:
1190
1191
  - The property Salinity used in the BrineCO2FluidSystem
    has been renamed to ProblemSalinity.
1192

Klaus Mosthaf's avatar
Klaus Mosthaf committed
1193
  - The matrixHeatFlux(...) and boundaryMatrixHeatFlux(...) methods in the spatial
1194
    parameters of nonisothermal implicit twophase models have been removed.
1195
1196
    Instead, the computation of the effective thermal conductivity has been sourced
    out to the fluidmatrixinteractions in a separate file
1197
    dumux/material/fluidmatrixinteractions/thermalconductivitysomerton.hh, which
1198
    can be exchanged. The spatial parameters file needs a method
1199
1200
1201
    thermalConductivitySolid(...), where the thermal conductivity of the solid
    material only is specified. The rest is computed in the respective
    flux variables.
Christoph Grueninger's avatar
Christoph Grueninger committed
1202
1203

* Deprecated CLASSES/FILES, to be removed after 2.3:
1204
1205
  - The following headers in dumux/boxmodels/ have been deprecated and forward
    to the corresponding headers in dumux/implicit/box:
1206
1207
1208
1209
    boxassembler.hh, boxelementvolumevariables.hh, boxlocalresidual.hh,
    boxpropertydefaults.hh, boxelementboundarytypes.hh, boxfvelementgeometry.hh,
    boxproperties.hh, intersectiontovertexbc.hh

1210
1211
  - All headers in the following subdirectories of dumux/boxmodels have been
    deprecated and forward to the headers in the corresponding subdirectories
1212
    of dumux/implicit:
1213
    1p, 1p2c, 2p, 2p2c, 2p2cni, 2pdfm, 2pni,
1214
1215
    3p3c, 3p3cni, co2, co2ni, mpnc, richards

1216
1217
1218
1219
1220
  - Some box-specific classes "Box..." in dumux/boxmodels/common could be
    completely replaced by unified "Implicit..." classes in
    dumux/implicit/common:
    ...DarcyFluxVariables, ...darcyfluxvariables.hh
    ...ForchheimerFluxVariables, ...forchheimerfluxvariables.hh
1221
1222
1223
1224
1225
1226
    ...LocalJacobian, ...localjacobian.hh
    ...Model, ...model.hh
    ...PorousMediaProblem, ...porousmediaproblem.hh
    ...Problem, ...problem.hh
    ...VolumeVariables, ...volumevariables.hh

1227
1228
  - The box-specific spatial parameter classes BoxSpatialParams... in
    dumux/material/boxspatialparams....hh have been deprecated in favor of
1229
1230
    ImplicitSpatialParams... in dumux/material/implicitspatialparams....hh.

1231
  - The GridCreatorheaders from dumux/common have been moved to dumux/io:
1232
1233
1234
1235
1236
1237
1238
    cubegridcreator.hh, dgfgridcreator.hh, simplexgridcreator.hh

* Deprecated PROPERTY NAMES, to be removed after 2.3: BEWARE: The compiler will
  not print any warning if a deprecated property name is used.
  - CompositionFromFugacitiesSolver has been renamed to Constraintsolver.

* Deprecated public MEMBER VARIABLES, to be removed after 2.3: BEWARE: The
1239
  compiler will not print any warning if a deprecated public member variable
1240
  is used.
1241
  - numFAP and numSCV in Box(CC)FVElementGeometry have been renamed to
1242
1243
    numFap and numScv, respectively.

1244
* Deprecated MEMBER FUNCTIONS, to be removed after 2.3:
1245
1246
1247
1248
1249
  - boundaryMatrixHeatFlux, markVertexRed and relativeErrorVertex
    from ImplicitSpatialParams, ImplicitAssembler and ImplicitModel,
    respectively. In favor of using
    thermalConductivitySolid (see above), markDofRed and relativeErrorDof,
    respectively.
1250

1251
* DELETED classes/files, property names, constants/enums,
1252
1253
  member functions, which have been deprecated in DuMuX 2.2:
  Everything listed as deprecated below has been removed.
Christoph Grueninger's avatar
Christoph Grueninger committed
1254
1255


1256
1257
1258
Differences Between DuMuX 2.1 and DuMuX 2.2
===================================================

1259
* IMPROVEMENTS and ENHANCEMENTS:
1260
  - Two new fully implicit models dedicated to simulate compositional
1261
1262
1263
1264
    (non-isothermal) CO2-brine systems have been added, together with
    corresponding components and a fluid system. See test/boxmodels/co2(ni)
    for details. These tests also illustrate the usage of element and vertex
    parameters as well as boundary ids provided by DGF files for setting
1265
1266
1267
    permeability and porosity as well as boundary conditions.

  - Decoupled Models: An h-adaptive model using an MPFA L-method was added
1268
    that simulates 2p and 2p2c flow on unstructured grids with hanging nodes
1269
    in two dimensions. See test/decoupled/2p(2c) for details.
1270

1271
1272
1273
  - All fully implicit porous media models are now capable of employing
    the Forchheimer equation as an alternative to the commonly used
    Darcy law. See test_forchheimer*p in test/boxmodels/mpnc for details.
1274

1275
1276
  - The Stokes models are now able to simulate the full Navier-Stokes
    equations for momentum transport. See test/freeflow/navierstokes
1277
    for details.
1278

1279
1280
1281
1282
1283
  - The fully implicit models have been (partially) generalized to allow
    for a cell-centered discretization in addition to the default
    vertex-centered (box) one. Cell-centered fully implicit 2p and 2p2c
    models are already available in the developers part of Dumux. Further
    generalizations and the inclusion in the stable part are planned for
1284
1285
    Dumux 2.3.

1286
1287
1288
  - Several model-specific features and classes have been unified, like
    the calculation of the Darcy velocity for the fully implicit flux
    variables, or the temperature, gravity, and spatial parameter
1289
    functionalities of the fully implicit problems. Moreover, many
1290
1291
1292
1293
    names have been made more consistent. This includes the naming
    and grouping of several parameters and corresponding properties,
    the indexing of phases and components, and the preference of the
    partial name "params" over "parameters." For details, see also the
1294
    deprecations listed below.
1295

1296
  - Added compiler support for GCC 4.7 and Clang 3.1.
1297

Christoph Grueninger's avatar
Christoph Grueninger committed
1298
1299
1300
1301
* IMMEDIATE INTERFACE CHANGES not allowing a deprecation period:
  - From Dune 2.2 on, FieldVector::size is a method rather than an enum value.
    It is mandatory to add the flag --enable-fieldvector-size-is-method to the
    CONFIGURE_FLAGS. An example is given in the opts file dumux/debug.opts.
1302
1303
  - Implicit models: TwoPIndices, TwoPNIIndices, and RichardsIndices
    additionally get TypeTag as template parameter. If the Indices are not
1304
    obtained via the property, this has to be adapted.
1305

1306
1307
1308
1309
1310
  - Implicit models: All model-specific computeFlux functions in
    ...localresidual.hh have to get an additional bool parameter onBoundary,
    which is by default set to false. If outflow conditions should
    be properly implemented, also the constructor of the flux variables in
    ...fluxvariables.hh has to get the additional argument and the
1311
1312
    class has to be adapted to deal with boundary faces. See FS#117 and #99
    for details.
1313

1314
* Deprecated CLASSES/FILES, to be removed after 2.2:
1315
1316
1317
1318
  - Model specific base box problems: The common functionality has been
    collected in PorousMediaBoxProblem in
    dumux/boxmodels/common/porousmediaboxproblem.hh. The problem can be derived
    from PorousMediaBoxProblem, instead of the model specific base problem:
1319
1320
1321
1322
1323
1324
1325
1326
1327
    OnePBoxProblem, dumux/boxmodels/1p/1pproblem.hh,
    OnePTwoCBoxProblem, dumux/boxmodels/1p2c/1p2cproblem.hh,
    TwoPProblem, dumux/boxmodels/2p/2pproblem.hh,
    TwoPNIProblem, dumux/boxmodels/2pni/2pniproblem.hh,
    TwoPTwoCProblem, dumux/boxmodels/2p2c/2p2cproblem.hh,
    TwoPTwoCNIProblem, dumux/boxmodels/2p2cni/2p2cniproblem.hh,
    ThreePThreeCProblem, dumux/boxmodels/3p3c/3p3cproblem.hh,
    ThreePThreeCNIProblem, dumux/boxmodels/3p3cni/3p3cniproblem.hh,
    MPNCProblem, dumux/boxmodels/mpnc/mpncproblem.hh.
1328
1329

  - All "...SpatialParameters" base classes have been replaced by
1330
1331
1332
1333
1334
    "...SpatialParams" classes:
    BoxSpatialParameters, dumux/material/spatialparameters/boxspatialparameters.hh,
    BoxSpatialParametersOneP, dumux/material/spatialparameters/boxspatialparameters1p.hh,
    FVSpatialParameters, dumux/material/spatialparameters/fvspatialparameters.hh,
    FVSpatialParametersOneP, dumux/material/spatialparameters/fvspatialparameters1p.hh.
1335

1336
1337
  - Due to the unification of flux variables for the fully implicit models,
    some model-specific flux variables have become obsolete:
1338
1339
1340
1341
    OnePFluxVariables, dumux/boxmodels/1p/1pfluxvariables.hh,
    TwoPFluxVariables, dumux/boxmodels/2p/2pfluxvariables.hh,
    RichardsFluxVariables, dumux/boxmodels/richards/richardsfluxvariables.hh.

1342
  - Two components have new names and locations in dumux/material/components:
1343
1344
1345
    SimpleDNAPL, simplednapl.hh -> DNAPL, napl.hh
    Oil, oil.hh -> LNAPL, lnapl.hh

1346
1347
  - Some MPFA-O method files/classes have been moved to a new subdirectory
    "omethod" in dumux/decoupled/2p/diffusion/fvmpfa:
1348
1349
    fvmpfaopressure2p.hh, fvmpfaovelocity2p.hh, fvmpfaopressureproperties2p.hh

1350
  - DUMUX_UNUSED is deprecated and will be removed after 2.2. It should be
1351
    replaced by the upstream version DUNE_UNUSED.
1352

1353
1354
  - DUMUX_DEPRECATED_MSG is deprecated and will be removed after 2.2. It should
    be replaced by the upstream version DUNE_DEPRECATED_MSG.
1355

1356
* Deprecated PROPERTY NAMES, to be removed after 2.2: BEWARE: The compiler will
1357
  not print any warning if a deprecated property name is used.
1358
  - The "SpatialParameters" property has been renamed to "SpatialParams".
1359

1360
1361
  - The model specific "...Indices" property has been renamed to "Indices".

1362
1363
* Deprecated CONSTANTS/ENUMS, to be removed after 2.2: BEWARE: The compiler will
  not print any warning if a deprecated constant/enum is used.
1364
1365
1366
  - In the 2p2c/ni and 3p3c/ni models, all indices related to phase and
    components can be pre/suffixed with "w", "n" and,
    for three phases, with "g".
1367
1368
    boxmodels/2p2c/...: "l", "g" pre/suffixes have been replaced by "w", "n".
    boxmodels/3p3c/...: "c", "a" pre/suffixes have been replaced by "n", "g".
1369
1370

* Deprecated MEMBER FUNCTIONS, to be removed after 2.2:
1371
1372
1373
  - Spatial parameters: The spatialParameters member functions of the base
    problems have been replaced by spatialParams:
    dumux/boxmodels/common/porousmediaboxproblem.hh,
1374
1375
1376
    dumux/decoupled/1p/diffusion/diffusionproblem...hh,
    dumux/decoupled/2p/impes/impesproblem2p.hh,
    dumux/decoupled/2p/transport/transportproblem2p.hh.
1377
1378
1379

  - Flux variables: Renaming of members
    "...AtIP" -> "...",
1380
1381
    "concentration..." -> "massFraction...",
    "molarConc..." -> "moleFraction..."
1382
    The "massFraction..." members have been deprecated, instead
1383
1384
    "moleFraction..." should be used.
    Affected files:
1385
    dumux/boxmodels/1p2c/1p2cfluxvariables.hh,
1386
1387
1388
1389
    dumux/boxmodels/2p2c/2p2cfluxvariables.hh,
    dumux/boxmodels/mpnc/.../...fluxvariables.hh,
    dumux/freeflow/stokes.../stokes...fluxvariables.hh.

1390
1391
  - Box models: The primaryVarWeight() functions are no longer used for the
    evaluation of the relative error.
1392

1393
  - Element and FVElementGeometry: The elem_() and fvElemGeom_() member function
1394
1395
    of BoxLocalResidual have been replaced by element_() and fvGeometry_().

1396
  - Primary variables: All "...primaryVar/s" member functions have been replaced
1397
1398
    by "...priVar/s":
    dumux/boxmodels/common/boxlocalresidual.hh,
1399
1400
    dumux/boxmodels/common/boxvolumevariables.hh.

1401
  - Start functionality in dumux/common/start.hh: printUsageDGF and
1402
    printUsageGrid are no longer needed.
1403
1404

* DELETED member functions, which have been deprecated in DuMuX 2.1:
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
  - dumux/material/spatialparameters/boxspatialparameters1p.hh:
    extrusionFactorScv and extrusionFactorScvf, now part of the volume variables

  - dumux/material/idealgas.hh:
    concentration, replaced by molarDensity

  - dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh:
    pC(const Params &params, Scalar Sw, const Scalar temperature)

  - dumux/common/start.hh:
    startFromDGF, startWithGrid, startWithParameters, all replaced by start

  - dumux/common/spline.hh:
    set(const ScalarArray&, const ScalarArray&, Scalar, Scalar), replaced by setXYArrays,
    set(const PointArray&, Scalar, Scalar), replaced by setArrayOfPoints

  - dumux/common/variablelengthspline_.hh, dumux/common/fixedlengthspline_.hh:
    various set routines, replaced by more descriptive names

  - dumux/io/vtkmultiwriter.hh:
    VtkMultiWriter(const std::string&, std::string), replaced by VtkMultiWriter(const GridView&, ...),
    beginTimeStep, replaced by beginWrite,
    createField, replaced by allocateManagedBuffer,
    addVertexData, replaced by attachVertexData,
    addCellData, replaced by attachCellData,
    endTimeStep, replaced by endWrite

  - dumux/decoupled/2p2c/2p2cproblem.hh:
    IMPETProblem2P2C(const GridView&, bool) replaced by IMPETProblem2P2C(TimeManager&, ...),
    IMPETProblem2P2C(..., SpatialParameters&, ...) replaced by IMPETProblem2P2C(TimeManager&, ...),
    initSat(const GlobalPosition&, const Element&) replaced by initSat(const Element&)
    initConcentration(const GlobalPosition&, const Element&) replaced by initConcentration(const Element&)
1437

1438
  - DUMUX_DEPRECATED has been removed.
1439
1440


1441
Notable Differences Between DuMuX 2.0 and DuMuX 2.1
1442
===================================================
1443

1444
1445
- The thermodynamics framework has been overhauled:
  - The programming interfaces for fluid systems, fluid states and
1446
    components has been formalized and cleaned up.
Klaus Mosthaf's avatar
Klaus Mosthaf committed
1447
  - Fluid systems now have the option to cache computationally
1448
    expensive parameters if they are needed for several relations.
1449
  - Fluid systems are not charged with the computation of the
1450
1451
    chemical equilibrium anymore.
  - Fluid states are now centralized infrastructure instead of being