added doc string

Fusion-Power-Plant-Framework · Dec 14, 2023 · 306f309 · 306f309
1 parent 8fc8594
commit 306f309
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/bluemira/equilibria/optimisation/problem/_minimal_current.py b/bluemira/equilibria/optimisation/problem/_minimal_current.py
@@ -51,6 +51,10 @@ class MinimalCurrentCOP(CoilsetOptimisationProblem):
         Optimiser conditions
     opt_algorithm:
         optimiser algorithm
+    opt_parameters:
+        Optimiser specific parameters,
+        see https://nlopt.readthedocs.io/en/latest/NLopt_Reference/#algorithm-specific-parameters
+        Otherwise, the parameters can be founded by digging through the source code.
     constraints:
         List of optimisation constraints to apply to the optimisation problem
     """

diff --git a/bluemira/equilibria/optimisation/problem/_nested_position.py b/bluemira/equilibria/optimisation/problem/_nested_position.py
@@ -83,7 +83,12 @@ class NestedCoilsetPositionCOP(CoilsetOptimisationProblem):
         for defaults see
         :class:`~bluemira.optimisation._algorithm.AlgorithDefaultTolerances`
         along with `max_eval=100`
-
+    opt_parameters:
+        Optimiser specific parameters,
+        see https://nlopt.readthedocs.io/en/latest/NLopt_Reference/#algorithm-specific-parameters
+        Otherwise, the parameters can be founded by digging through the source code.
+    constraints:
+        List of optimisation constraints to apply to the optimisation problem
 
     Notes
     -----

diff --git a/bluemira/equilibria/optimisation/problem/_position.py b/bluemira/equilibria/optimisation/problem/_position.py
@@ -70,9 +70,12 @@ class CoilsetPositionCOP(CoilsetOptimisationProblem):
         for defaults see
         :class:`~bluemira.optimisation._algorithm.AlgorithDefaultTolerances`
         along with `max_eval=100`
-
+    opt_parameters:
+        Optimiser specific parameters,
+        see https://nlopt.readthedocs.io/en/latest/NLopt_Reference/#algorithm-specific-parameters
+        Otherwise, the parameters can be founded by digging through the source code.
     constraints:
-        contraints on the problem
+        List of optimisation constraints to apply to the optimisation problem
 
     Notes
     -----