From 7fcc9bbfec7d39bb887624c7e9687ba15a128d60 Mon Sep 17 00:00:00 2001
From: Johannes Pfeifer <jpfeifer@gmx.de>
Date: Mon, 16 Aug 2021 15:04:07 +0200
Subject: [PATCH] occbin: add description of filter_use_relaxation
(@stepan removed trailing space)
(cherry picked from commit 41b3146273cf0d13f27ca0e31aeb1513cec87d36)
---
doc/manual/source/the-model-file.rst | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/doc/manual/source/the-model-file.rst b/doc/manual/source/the-model-file.rst
index b7f37d5fb7..d939b107a0 100644
--- a/doc/manual/source/the-model-file.rst
+++ b/doc/manual/source/the-model-file.rst
@@ -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*
--
GitLab