add comments for setNumberThreads

This commit is contained in:
Hannes Signer 2023-08-29 10:38:51 +02:00
parent 1dbee6d8d9
commit a0ab764870

View File

@ -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);
/**