Merge branch 'release/v0.3.0' into development

* release/v0.3.0: preparing The Big Cleanup Release v0.3.0 docu: embedding the new examples in the docu examples: vanderpol: moved to examples namespace examples: scalar: moved to examples namespace examples: advec-diff: moved to examples namespace docu: don't generate documentation for Easylogging++ again fixing compiler warnings (this time: sign-compare) again fixing compiler warnings (this time: unused functions) again fixing compiler warnings (this time: )nused variables) fixing some compiler warnings (finally) docu: update and prepare changelog for upcoming release v0.3.0 Signed-off-by: Torbjörn Klatt <[email protected]>
Parallel-in-Time · Dec 12, 2014 · d7fe9ac · d7fe9ac
2 parents a654bd8 + 0dd81dc
commit d7fe9ac
Show file tree

Hide file tree

Showing 28 changed files with 1,219 additions and 994 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,93 @@
 # Changelog                                                                        {#page_changelog}
 
-## v0.2.0 -- MPI PFASST (2014/08/XX)
+## v0.3.0 -- The Big Cleanup (2014/12/12)
+
+DOI: [10.5281/zenodo.13221](http://dx.doi.org/10.5281/zenodo.13221)
+
+### Notable Features
+
+* Complete rewrite of quadrature functions.
+  ([#103][])
+
+* Addition of iteration control mechanism for SDC and MLSDC. _(extention for PFASST is scheduled)_
+  ([#108][])
+
+* Introduced framework for passing command line parameters to programs using PFASST++.
+  ([#88][])
+
+* Versatile and colourful logging framework based on [Easylogging++](https://github.com/easylogging/easyloggingpp).
+  ([#105][], [#123][])
+
+* New Example: Boris-SDC.
+  ([#113][])
+
+### Details
+
+* Using [Eigen3](http://eigen.tuxfamily.org/) matrix data types and functionality instead of
+  [Boost's uBLAS](http://www.boost.org/doc/libs/1_57_0/libs/numeric/ublas/doc/index.html).
+  ([#82][], [#83][], [#85][])
+
+* Introduced callback interception points in sweepers: `post_step`, `post_sweep` and `post_predict`.
+  ([#107][])
+
+* In sweepers: `state(0)` is not assumed to be same as `start_state`.
+  ([#132][])
+
+* Examples are now in their own namespace `pfasst::examples::`
+  ([#138][])
+
+* Bunch of CMake-related fixes and extentions.
+  ([#83][], [#96][], [#101][], [#109][], [#112][], [#119][], [#121][], [#131][], [#133][], [#135][])
+
+* Example of using PFASST++ with a Makefile project (see advection-diffusion example).
+  ([#129][])
+
+* Support for [HashDist](https://github.com/hashdist/hashdist) to provide dependencies.
+  ([#129][])
+
+* A few corrections and extentions to the documentation.
+  ([#117][], [#120][])
+
+[#82]: https://github.com/Parallel-in-Time/PFASST/pull/82
+[#83]: https://github.com/Parallel-in-Time/PFASST/pull/83
+[#85]: https://github.com/Parallel-in-Time/PFASST/pull/85
+[#88]: https://github.com/Parallel-in-Time/PFASST/pull/88
+[#96]: https://github.com/Parallel-in-Time/PFASST/pull/96
+[#101]: https://github.com/Parallel-in-Time/PFASST/pull/101
+[#103]: https://github.com/Parallel-in-Time/PFASST/pull/103
+[#105]: https://github.com/Parallel-in-Time/PFASST/pull/105
+[#107]: https://github.com/Parallel-in-Time/PFASST/pull/107
+[#108]: https://github.com/Parallel-in-Time/PFASST/pull/108
+[#109]: https://github.com/Parallel-in-Time/PFASST/pull/109
+[#112]: https://github.com/Parallel-in-Time/PFASST/pull/112
+[#113]: https://github.com/Parallel-in-Time/PFASST/pull/113
+[#117]: https://github.com/Parallel-in-Time/PFASST/pull/117
+[#119]: https://github.com/Parallel-in-Time/PFASST/pull/119
+[#120]: https://github.com/Parallel-in-Time/PFASST/pull/120
+[#121]: https://github.com/Parallel-in-Time/PFASST/pull/121
+[#123]: https://github.com/Parallel-in-Time/PFASST/pull/123
+[#129]: https://github.com/Parallel-in-Time/PFASST/pull/129
+[#131]: https://github.com/Parallel-in-Time/PFASST/pull/131
+[#132]: https://github.com/Parallel-in-Time/PFASST/pull/132
+[#133]: https://github.com/Parallel-in-Time/PFASST/pull/133
+[#135]: https://github.com/Parallel-in-Time/PFASST/pull/135
+[#138]: https://github.com/Parallel-in-Time/PFASST/pull/138
+
+### Contributors
+
+* Matthew Emmett, Lawrence Berkeley National Laboratory ([memmett][])
+* Torbjörn Klatt, Jülich Supercomputing Centre ([torbjoernk][])
+* Daniel Ruprecht, Institute of Computational Science, University of Lugano ([danielru][])
+* Robert Speck, Jülich Supercomputing Centre ([pancetta][])
+
+[memmett]: https://github.com/memmett
+[torbjoernk]: https://github.com/torbjoernk
+[danielru]: https://github.com/danielru
+[pancetta]: https://github.com/pancetta
+
+---
+
+## v0.2.0 -- MPI PFASST (2014/08/29)
 
 DOI: [10.5281/zenodo.11517](http://dx.doi.org/10.5281/zenodo.11517)
 
@@ -56,6 +143,7 @@ DOI: [10.5281/zenodo.11517](http://dx.doi.org/10.5281/zenodo.11517)
 [danielru]: https://github.com/danielru
 [pancetta]: https://github.com/pancetta
 
+---
 
 ## v0.1.0 -- First Release (2014/07/25)
 

diff --git a/Doxyfile b/Doxyfile
@@ -698,7 +698,7 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                =
+EXCLUDE                = include/pfasst/easylogging++.h
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded

diff --git a/README.md b/README.md
@@ -10,7 +10,10 @@ spectral deferred correction* (MLSDC) algorithms.
 News
 ----
 
-* August 29, 2014: PFASST v0.2.0 release. Please sse the [release notes](#releases) for more 
+* December 12, 2014: PFASST v0.3.0 release. Please see the [release notes](#releases) for more
+  information.
+
+* August 29, 2014: PFASST v0.2.0 release. Please see the [release notes](#releases) for more
   information.
 
 * July 25, 2014: PFASST v0.1.0 released.  Please see the [release notes](#releases) for more
@@ -41,20 +44,27 @@ Currently, it features the following content:
 Releases
 --------
 
+* **v0.3.0** The Big Cleanup Release (2014/12/12)
+
+  A lot of internal cleanup and usability enhancements.  
+  DOI: [10.5281/zenodo.13221][DOI_v030]  
+  See \subpage #page_changelog "the Changelog" for details.
+
 * **v0.2.0** MPI-PFASST Release (2014/08/29)
 
-  Implementation of PFASST with MPI.
-  DOI: [10.5281/zenodo.11517][DOI_v020]
+  Implementation of PFASST with MPI.  
+  DOI: [10.5281/zenodo.11517][DOI_v020]  
   See \subpage #page_changelog "the Changelog" for details.
 
 * **v0.1.0** First Release (2014/07/25)
 
-  Initial release with basic implementations of SDC and MLSDC.
-  DOI: [10.5281/zenodo.11047][DOI_v010]
+  Initial release with basic implementations of SDC and MLSDC.  
+  DOI: [10.5281/zenodo.11047][DOI_v010]  
   See \subpage #page_changelog "the Changelog" for details.
 
 [DOI_v010]: http://dx.doi.org/10.5281/zenodo.11047
 [DOI_v020]: http://dx.doi.org/10.5281/zenodo.11517
+[DOI_v030]: http://dx.doi.org/10.5281/zenodo.13221
 
 Release tags will be signed by one of the following PGP keys:
 

diff --git a/doc/source/examples.md b/doc/source/examples.md
@@ -2,9 +2,24 @@
 
 ## Simple Advection Diffusion
 
+A solver for simple advection-diffusion equations using FFT.
 See \subpage page_examples_advection_diffusion.
 
 
 ## Scalar
 
+Almost a pen-and-paper example.
 See \subpage page_examples_scalar.
+
+
+## Van-der-Pol Oscillator
+
+A solver for second order ODEs representing the Van-der-Pol oscillator.
+See \subpage page_examples_vanderpol.
+
+
+## Boris-SDC
+
+Another solver for second order ODEs usually occuring in molecular dynamics using a variant of the
+Velocity-Verlet scheme.
+See \subpage page_examples_boris.