From a0ab7648705a8a9556bd29fddb8514b21c0dd046 Mon Sep 17 00:00:00 2001
From: Hannes Signer <hm.signer@gmail.com>
Date: Tue, 29 Aug 2023 10:38:51 +0200
Subject: [PATCH] add comments for setNumberThreads

---
 include/tug/Simulation.hpp | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/include/tug/Simulation.hpp b/include/tug/Simulation.hpp
index ae67f5f..c5ae677 100644
--- a/include/tug/Simulation.hpp
+++ b/include/tug/Simulation.hpp
@@ -142,6 +142,13 @@ class Simulation {
        */
       void setSolver(SOLVER solver);
 
+      /**
+       * @brief Set the number of desired openMP Threads.
+       *
+       * @param num_threads Number of desired threads. Must have a value between
+       *                    1 and the maximum available number of processors. The maximum number of
+       *                    processors is set as the default case.
+       */
       void setNumberThreads(int num_threads);
 
       /**