From 1c3b6e5edfb28bf6744e24596a3df5040673f602 Mon Sep 17 00:00:00 2001 From: Bernd Flemisch Date: Thu, 22 Sep 2016 10:41:27 +0200 Subject: [PATCH] [doc] adapt CHANGELOG and README files --- CHANGELOG.md | 51 +++++++++++++++++++++++++++++++++++------ README.md | 3 +-- test/multidomain/README | 7 ++---- 3 files changed, 47 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0bae5e8065..3379fe01ff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,25 +7,62 @@ Differences Between DuMuX 2.9 and DuMuX 2.10 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. + - DuMux 2.10 requires at least GCC 4.9 or Clang 3.5 in their C++-14 mode. + - 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: - - Integrated geostatistical tool gstat for generating random fields - - multidomain should now work with all compilers (optimzed) without segfaults - - The computation of the tortuosity tau with the Millington Quirk model - was optimized. Tests show an speedup of up to 5% for a 2p2c simulation. + - 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 + facilitated. See `test_cc1pwithgstat` in + `test/porousmediumflow/1p/implicit`. + + - 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`. * IMMEDIATE INTERFACE CHANGES not allowing/requiring a deprecation period: - The problem class interface needs to provide the method maxTimeStepSize(). This is important if you implement problem classes not deriving from the base - problem classes in Dumux (ImplicitProblem, OneModelProblem, - ImpetProblem, and MultidomainProblem). + problem classes in Dumux (`ImplicitProblem`, `OneModelProblem`, + `ImpetProblem`, and `MultidomainProblem`). * 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 is used. However, a run-time warning should appear in the summary lines after the corresponding run. - - The property tau was renamed to TauTortuosity to make the name more telling. + - The property `tau` was renamed to `TauTortuosity` to make the name more telling. For the models 1p2c, 2p2c, 3p3c it got the default value 0.5. * Deprecated CLASSES/FILES, to be removed after 2.10: diff --git a/README.md b/README.md index fc34161c0f..c554a5b256 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,7 @@ processes in porous media. DuMuX is based on the [DUNE][1] framework and aims to provide a multitude of numerical models as well as flexible discretization methods for complex non-linear phenomena, such as CO2 sequestration, soil remediation, drug delivery in cancer -therapy and more. Multi-scale and multi-physics methods are currently -actively worked on. See [our publication][2] for a more detailed +therapy and more. See [our publication][2] for a more detailed description of the goals and motivations behind DuMuX. diff --git a/test/multidomain/README b/test/multidomain/README index 1ef85f0bfd..c799bf3d72 100755 --- a/test/multidomain/README +++ b/test/multidomain/README @@ -14,9 +14,6 @@ the script located in: Install the external grid manager UG and a direct linear solver like SuperLU or UMFPACK. You need Boost fusion for dune-multidomaingrid. -On some machines, some compilers with full optimization -O3 might produce -executables that yield segmentation faults (we encountered this behavior with -gcc-4.8). In this case, reduce the optimization level or try a different -compiler. If you still encounter segmentation faults, make sure that UG, all -DUNE libraries and the executable in question are built with the same compiler. +If you encounter segmentation faults, make sure that UG, all DUNE libraries and +the executable in question are built with the same compiler. -- GitLab