Skip to content

Commit 94f99ae

Browse files
committed
doc: documentating command line input -forget
1 parent 9276ebf commit 94f99ae

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

doc/content/setup_tsmp/input_cmd.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,32 @@ avoid performance loss. See remark in
8181
- 2: 1 plus timing output
8282
- 3: 2 plus debug output
8383

84+
## forget ##
85+
86+
`forget` (real) forgetting factor for filter analysis
87+
88+
Example: `-forget 0.98`.
89+
90+
General advise: Choose forgetting factor close to one. For values
91+
smaller than 0.95, effects like a splitting of the ensemble have been
92+
observed (compare Amezcua et al., Tellus A 2012, 64, 18039,
93+
http://dx.doi.org/10.3402/tellusa.v64i0.18039)
94+
95+
For EnKF / LEnKF, the forgetting factor leads to a spreading of the
96+
ensemble through manipulating ensemble member by
97+
98+
\begin{align*}
99+
x^{f}_{i} &= \bar{x} + (x_{i}-\bar{x}) \cdot \frac{1}{\mathtt{forget}},
100+
\end{align*}
101+
102+
where $x_{i}$ is the state vector ensemble member $i$ and $\bar{x}$ is
103+
the ensemble mean of the state vector.
104+
105+
For ETKF, see
106+
e.g. https://github.com/PDAF/PDAF/blob/ae9545227bd4804469dff389a9baadcc9e31906e/src/PDAF_etkf_analysis.F90#L441-L444
107+
108+
109+
84110
## Command Line Examples ##
85111

86112
### Command Line Example: EnKF ###

0 commit comments

Comments
 (0)