occbin: add description of filter_use_relaxation

(@stepan removed trailing space)
mr#1907
Johannes Pfeifer 2021-08-16 15:04:07 +02:00 committed by Stéphane Adjemian (Charybdis)
parent a27bc872ad
commit 41b3146273
Signed by: stepan
GPG Key ID: 295C1FE89E17EB3C
1 changed files with 4 additions and 1 deletions

View File

@ -4933,7 +4933,10 @@ All of these elements are discussed in the following.
.. option:: filter_use_relaxation
..
Triggers relaxation within the guess and verify algorithm used in the update step of the piecewise
Kalman filter. When old and new guess regime differ to much, use a new guess closer to the previous guess.
In case of multiple solutions, tends to provide an occasionally binding regime with a shorter duration (typically preferable).
Specifying this option may slow down convergence. Default: not enabled.
*Output*