Update to version 2.0.1

Author: ikorotkin

docs/CHANGELOG.md

@@ -8,11 +8,18 @@ nav_order: 11
 
 All notable user-facing changes to the `dae-cpp` project are documented in this page.
 
-## v2.0.0
+## v2.0.1
 
 New
 {: .label .label-green }
 
+- Added [Flame Propagation](https://github.com/dae-cpp/dae-cpp/blob/master/examples/flame_propagation/flame_propagation.cpp) example (stiff equation)
+- Added `daecpp::dual_type` for automatic differentiation of the vector function (used in [Flame Propagation](https://github.com/dae-cpp/dae-cpp/blob/master/examples/flame_propagation/flame_propagation.cpp) example)
+- Added integration test based on the "Flame Propagation" example
+- Updated build instructions
+
+## v2.0.0
+
 Redesigned version of the library. Consider this version as a public beta.
 Please report any bugs using GitHub [issues](https://github.com/dae-cpp/dae-cpp/issues).
 

docs/examples.md

@@ -32,3 +32,13 @@ Perovskite model source file example: [perovskite.cpp](https://github.com/dae-cp
 A more sophisticated example, where we solve a big DAE system that describes the potential distribution and ion concentration in a perovskite solar cell.
 We show how to add parameters to the user-defined mass matrix, vector function, and Jacobian.
 This example also demonstrates a custom [Solution Manager](solution-manager.html) implementation that can work as an observer and event function.
+
+## Flame propagation model
+
+Flame propagation source file example: [flame_propagation.cpp](https://github.com/dae-cpp/dae-cpp/blob/master/examples/flame_propagation/flame_propagation.cpp)
+{: .fs-5 .fw-400 }
+
+When you light a match, the ball of flame grows rapidly until it reaches a critical size.
+Then it remains at that size because the amount of oxygen being consumed by the combustion
+in the interior of the ball balances the amount of oxigen available through the surface.
+This example solves **stiff** equation of flame propagation for the scalar variable $$y(t)$$ which represents the radius of the ball.

docs/index.md

@@ -4,7 +4,7 @@ layout: home
 nav_order: 1
 ---
 
-![version](https://img.shields.io/badge/version-2.0.0-blue)
+![version](https://img.shields.io/badge/version-2.0.1-blue)
 
 <p align="center">
 <img src="../assets/images/logo.png" alt="dae-cpp logo" width="250"/>

docs/installation.md

@@ -25,7 +25,7 @@ Then build and run the tests:
 
 ```bash
 mkdir build && cd build
-cmake ..
+cmake .. -DCMAKE_BUILD_TYPE=Release
 make
 ctest
 ```

docs/prerequisites.md

@@ -30,3 +30,4 @@ using namespace daecpp;
 | `daecpp::float_type` | `double` (default), <br> `float` if `DAECPP_SINGLE` is defined | Floating point scalar, used for sparse matrix coefficients |
 | `daecpp::state_vector` | `std::vector<float_type>` | State vector, used, for example, to define the initial condition |
 | `daecpp::state_type` | `autodiff::VectorXreal` | State vector, used for the [vector function](vector-function.html) definition so that it can be automatically (algorithmically) differentiated using [`autodiff`](https://autodiff.github.io/) package |
+| `daecpp::dual_type` | `autodiff::real` | Floating point "dual" number, used in the vector function for automatic differentiation |