- Textupdate for cpp-runtime documentation

SimulationRuntime/cpp/EventHandling.dox

@@ -0,0 +1,7 @@
+/*!
+  \page Eventhandling
+  This page describes the basic workflow of event handling, which is performed by the solver in the c++ simulation runtime. There are several
+  important classes that are part of the workflow.
+    - Solver (e.g. CVode): Will estimate the step width and call the evaluation of state derivatives and zero crossing conditions
+    - Model: Implements the evaluation of state derivatives and zero crossings
+ */

SimulationRuntime/cpp/Flags.dox

@@ -18,7 +18,25 @@
   -I \[\"euler\"\|\"peer\"\|\"rtrk\"\|\"ida\"\|\"cvode\"\|\"dassl\"\] | Time integration algorithm that should be used (default: \"euler\")                                      |
   -L \[\"umfpack\"\|\<NONLINEARSOLVER\>\]                             | Solver for linear equation systems that should be used (default: \"kinsol\")                             |
   -N \[\"newton\"\|\"kinsol\"\|\"hybrj\"\]                            | Solver for non linear equation systems that should be used (default: \"kinsol\")                         |
-  -V \<VALUE\>                                                        | LOGGER SETTINGS MISSING                                                                                  |
+  -V \<VALUE\>                                                        | This flag can be added multiple times. Pass a key=value pair as argument. See the description below.     |
   -A \<VALUE\>                                                        | Timeout in seconds for the simulation (default: 360)                                                     |
-  -O \["all"\|"step"|"none"\]                                         | The time points that should be written to the result file (default: all)                                 |
+  -O \[\"all\"\|\"step\"\|\"none\"\]                                  | The time points that should be written to the result file (default: all)                                 |
+  --emit_protected                                                    | Unused variable                                                                                          |
+  --nls-continue                                                      | The non linear solver will continue if it does not reach the given accuracy                              |
+
+  There are several settings available to control the behavior of the logger. You can specify multiple key-value-pairs to set the log-output for several log-categories. All key-value-pairs have the form LOG_CATEGORY=LOG_LEVEL. The following categories are available:
+   - \b init logger messages related to the initialization phase
+   - \b nls output of the non linear solver
+   - \b ls output of the linear solver
+   - \b solv messages related to the time integration algorithm
+   - \b output information related to the output algorithm (e.g. matfile writer)
+   - \b event logger messages that belong to the event handling part of the simulation
+   - \b model output of the model equations etc. 
+   - \b other messages that belong to other parts, not specified by the categories above
+
+  All logger messages belong to a log level. If a category is set to a certain level, all messages are written that have the given level or a higher one.
+   - \b error One critical errors are displayed.
+   - \b warning Contains messages that can influence the simulation performance or simulation results
+   - \b info Just some information, e.g. the number of steps the time integration algorithm took
+   - \b debug Output related to debug information like function invocations etc.
 */

SimulationRuntime/cpp/Mainpage.dox

@@ -8,6 +8,5 @@ There are some open things TODO!
 
 <ul>
   <li> <a href="_flags.html">Available flags</a></li>
-  <li> Using the logger </li>
 </ul>
 */