Adding solver overview to User's Guide (#14349)

- Adding overview table to integration methods section
- Clarifing that DASSL is using dense solvers
- Adding path to omc on default CMake build
- Updating C++ Readme a bit

Author: AnHeuermann

OMCompiler/SimulationRuntime/cpp/README

@@ -0,0 +1,59 @@
+# Build the C++ runtime
+
+Set `OM_OMC_ENABLE_CPP_RUNTIME=ON` when compiling with CMake.
+Check [README.cmake.md](../../../README.cmake.md) for details.
+
+## Configuration arguments
+
+```cmake
+  BOOST_STATIC_LINKING="true"
+  BOOST_REALPATHS="true"
+  RUNTIME_PROFILING="true"
+  SCOREP="true"
+  SCOREP_HOME=”...”
+  FMU_SUNDIALS="true"
+  PARALLEL_OUTPUT="true"
+  USE_LOGGER="false"
+  BUILDTYPE=[Release,Debug]
+  USE_KLU=["true","false"]
+```
+
+The boost static libraries can be used for the build, by passing the
+`BOOST_STATIC_LINKING` argument to make. Take care that all boost- libraries are
+linked statically.
+
+Sometimes it's necessary to link boost against it's real path libraries. This
+means for example, that instead of linking against “-lboost_filesystem”, the
+makefiles will link against “-lboost1.55_filesystem”. Use the `BOOST_REALPATHS`
+argument for this purpose.
+
+If profiling informations for the runtime are required, they can be turned on
+with the `RUNTIME_PROFILING` command.
+
+Profiling can additionally be handled by Score-P. This gives the possibility to
+use tracing besides profiling for performance analysis. Maybe it's necessary to
+give the `SCOREP_HOME` directory to make as well. This is the directory
+containing `include/scorep/SCOREP_User.h`. Turn the Score-P support on, by
+passing the `SCOREP` argument.
+
+The FMU export usually creates executables that use the Newton algorithm to
+solve equation systems. The KINSOL solver can be used as well, by passing the
+`FMU_SUNDIALS` argument to configure.
+
+Simulation results can be written asynchronously with the help of boost
+threads and a consumer producer algorithm (experimental). This feature is
+available after passing `PARALLEL_OUTPUT` to configure.
+
+For performance reasons it can be necessary to disable the logger-code completely.
+This can be done by passing the `USE_LOGGER` argument.
+
+The build-type of cmake can be directly controlled by passing the `BUILDTYPE`
+argument. If debug librariers should be created, set this value to `debug`.
+If release libraries are required, pass `release` instead.
+
+The Windows build does not support C++11 at the moment. Therfore a lot of C++11
+features are replaced with boost equivalents. Sometimes it is necessary to check
+this build on Linux-systems as well. Therefore the argument `CPP_03` can be
+passed, to prevent the usage of C++11 features.
+
+Author: Marcus Walther 20.11.2015

OMCompiler/SimulationRuntime/cpp/README.md

@@ -2,5 +2,5 @@
 
 There are different documentations available for OpenModelica.
 
-  - The User's Guide, see [UsersGuide/README.md](https://github.com/OpenModelica/OpenModelica/blob/master/doc/UsersGuide/README.md)
-  - Doxygen documentation for parts of the C, C++ and OMSI documentation
+  - The User's Guide, see [UsersGuide/README.md](./UsersGuide/README.md)
+  - Doxygen documentation for parts of the C, C++ and OMSI documentation

doc/README.md

@@ -3,14 +3,18 @@
 
 OPENMODELICA_ROOT = $(CURDIR)/../..
 # OMPython needs this
-OPENMODELICAHOME := $(shell                                 \
-	if [ -d $(OPENMODELICA_ROOT)/build_cmake/install ];       \
-		then echo '$(OPENMODELICA_ROOT)/build_cmake/install';   \
-	elif [ -d $(OPENMODELICA_ROOT)/install_cmake ];           \
-		then echo '$(OPENMODELICA_ROOT)/install_cmake';         \
-	else                                                      \
+OPENMODELICAHOME := $(shell                                     \
+	if [ -d $(OPENMODELICA_ROOT)/build_cmake/install ];           \
+		then echo '$(OPENMODELICA_ROOT)/build_cmake/install';       \
+	elif [ -d $(OPENMODELICA_ROOT)/build_cmake/install_cmake ];   \
+		then echo '$(OPENMODELICA_ROOT)/build_cmake/install_cmake'; \
+	elif [ -d $(OPENMODELICA_ROOT)/install_cmake ];               \
+		then echo '$(OPENMODELICA_ROOT)/install_cmake';             \
+	else                                                          \
 		echo '$(OPENMODELICA_ROOT)/build/'; fi)
 
+OPENMODELICAHOME := $(shell realpath $(OPENMODELICAHOME))
+
 OMSUSERSGUIDE = $(OPENMODELICA_ROOT)/OMSimulator/doc/UsersGuide
 
 # You can set these variables from the command line.

doc/UsersGuide/Makefile

@@ -5,27 +5,38 @@ OpenModelica User's Guide using Sphinx (Python Documentation Generator).
 ## Dependencies
 
 Getting all dependencies right is a nightmare. Just use the dev container
-`build-deps:v1.22.0` from [.devcontainer/README.md](./../../.devcontainer/README.md) and
-set `GITHUB_AUTH`.
+`build-deps:v1.22.0` from
+[.devcontainer/README.md](./../../.devcontainer/README.md) and set
+`GITHUB_AUTH`.
+
+- omc, omc-diff and omsimulator
+- Inkscape > v1.0
+- [Sphinx](http://sphinx-doc.org/)
+- pandoc
+- gnuplot
+- Python3 and packages from [source/requirements.txt](./source/requirements.txt)
 
- - omc, omc-diff and omsimulator
- - Inkscape > v1.0
- - [Sphinx](http://sphinx-doc.org/)
- - Python3 and packages from [source/requirements.txt](./source/requirements.txt)
    ```bash
-   pip3 install --upgrade -r source/requirements.txt
+   pip install --upgrade -r source/requirements.txt
+   ```
+
+- Python PyGithub package
+
+   ```bash
+   pip install PyGithub
    ```
- - Python PyGithub package
 
 ### GITHUB_AUTH
 
 Create a read-only personal access token (API token) on GitHub.com and define an
 environment variable `GITHUB_AUTH` with your secret API token.
+
 ```bash
 export GITHUB_AUTH=XXXXXXXXXXX
 ```
+
 This is needed to read release information from
-https://github.com/OpenModelica/OpenModelica with the PyGithub package.
+<https://github.com/OpenModelica/OpenModelica> with the PyGithub package.
 
 ## Build instructions
 
@@ -36,5 +47,5 @@ make html
 ## Preview build
 
 ```bash
-python3 -m http.server --directory build/html
+python -m http.server --directory build/html
 ```

doc/UsersGuide/README.md

@@ -25,6 +25,8 @@
 if not 'OPENMODELICAHOME' in os.environ:
   if os.path.isdir('../../../build_cmake/install'):
     os.environ['OPENMODELICAHOME'] = os.path.realpath('../../../build_cmake/install')
+  elif os.path.isdir('../../../build_cmake/install_cmake'):
+    os.environ['OPENMODELICAHOME'] = os.path.realpath('../../../build_cmake/install_cmake')
   elif os.path.isdir('../../../install_cmake'):
     os.environ['OPENMODELICAHOME'] = os.path.realpath('../../../install_cmake')
   else: