Skip to content

Commit

Permalink
add documentation about parameters
Browse files Browse the repository at this point in the history
see commit feelpp/feelpp@9512e77
[ci skip]
  • Loading branch information
thomas-saigre authored Jul 1, 2021
1 parent c8b4d4b commit 47c647c
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion docs/user/modules/python/pages/pyfeelppmor/parameters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,21 @@ mu = [4.37e+00,2.92e+00,1.17e+00,8.75e+05,5.28e+05,2.83e+01]

* `setParameterNamed(name: str, value: float)` : set the parameter `name` to `value`

* `size()` -> `int` : return the size of the parameter
* `setParameters(...)` : Overloaded function.
1. `setParameters(values: List[float])` : set the parameter to the given list, the argument shas to be in the same order as values are stored in the `ParameterSpaceElement`.
2. `setParameters(values: Dict[str, float])` : set the parameter to the given dict with values. Eg `mu.setParameters({hcoeff: 2, q_1: 18712.5})`.

* `size()` -> `int` : return the size of the parameter

* `view()` : displays the names of the parameters, associated to their values. Here is an example :

[source, python]
----
>>> mu.view()
hcoeff 3.77075
k_1 2.36557
k_2 1.79914
q_1 18710.5
q_2 166074
vinconv 3.58235
----

0 comments on commit 47c647c

Please sign in to comment.