docu: embedding the new examples in the docu

Author: torbjoernk

CHANGELOG.md

@@ -33,9 +33,18 @@ DOI: tbd
 * 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][])
 
@@ -57,11 +66,12 @@ DOI: tbd
 [#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
 

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.

examples/boris/README.md

@@ -0,0 +1,8 @@
+# Boris SDC                                                                   {#page_examples_boris}
+
+This directory contains an implementations of a modification to the Boris method to solve second order ODEs with the 
+Velocity-Verlet scheme using the PFASST framework.
+
+The sweeper with it's _Boris magic_ is implemented in `boris_sweeper.hpp`.
+The physical properties of a testbed example with a panning trap are defined in `physics.hpp` and `simple_physics.hpp`,
+while the data structure for the particles are defined in `particle.hpp` and `particle_3d.hpp`.

examples/vanderpol/README.md

@@ -0,0 +1,7 @@
+# Van-der-Pol Oscillator                                                  {#page_examples_vanderpol}
+
+This directory contains an implementations of solver for the Van-der-Pol oscillator using the PFASST framework.
+
+The SDC sweeper is defined in `vdp_sweeper.hpp`.
+As this simple equation does not require any special handling, all the SDC magic is derived and 
+taken from pfasst::encap::IMEXSweeper::sweep().