| | 1 | = Available options for the different DA methods (PDAF3) = |
| | 2 | |
| | 3 | |
| | 4 | [[PageOutline(2-3,Contents of this page)]] |
| | 5 | |
| | 6 | || This page documents the options for PDAF 3. [[BR]]See the [wiki:AvailableOptionsforInitPDAFuntilPDAF231 page on available options in PDAF 2.31] for the options valid for the ealier releases. || |
| | 7 | |
| | 8 | There are different options for each of the filter algorithms that need to be specified in the call to `PDAF_init` or that canbe set using `PDAF_set_iparam` and `PDAF_set_rparam`. To display the available options in a compiled assimilation program, one can use run with the specification `subtype=-1`. In this case `PDAF_init` wil display the available options for the selected filter algorithm and exit with an error status of -1. |
| | 9 | |
| | 10 | The options are mainly unified over the different DA methods. Here, the nonlinear ensemble methods have somewhaat different options from those for the ensemble Kalman filter variants. Also the 3D-Var methods have a different set of options. |
| | 11 | |
| | 12 | == Overview of options == |
| | 13 | |
| | 14 | === Options for ensemble Kalman filters === |
| | 15 | |
| | 16 | Overview of integer options for ensemble Kalman filters. The parameters are explained in the list of options as they are displayed using `subtype=-1`, which are shown further below. |
| | 17 | |
| | 18 | Parameters shown in italic font have changed in PDAF V3 compared to PDAF V2.3.1. The index position in PDAF V2.3.1 is shown in parenthesis. |
| | 19 | |
| | 20 | ||= iparam =||= SEIK =||= LSEIK =||= EnKF =||= LEnKF =||= ETKF =||= LETKF =||= ESTKF =||= LESTKF =||= //ENSRF// =|| |
| | 21 | ||= 1 =|| dim_p || dim_p || dim_p || dim_p || dim_p || dim_p || dim_p ||dim_p || dim_p |
| | 22 | ||= 2 =|| dim_ens || dim_ens || dim_ens || dim_ens || dim_ens || dim_ens || dim_ens || dim_ens || dim_ens || |
| | 23 | ||= 3 =|| || || //dim_lag(5)// || || dim_lag || dim_lag || dim_lag || dim_lag || || |
| | 24 | ||= 4 =|| || || //rank_ana(3)// || //rank_ana(3)// || || || || || || |
| | 25 | ||= 5 =|| type_forget || type_forget || || || type_forget || type_forget || type_forget || type_forget || || |
| | 26 | ||= 6 =|| type_trans || type_trans || || || type_trans || type_trans || type_trans || type_trans || || |
| | 27 | ||= 7 =|| type_sqrt || type_sqrt || || || || || type_sqrt || type_sqrt || || |
| | 28 | ||= 8 =|| obs_ens || obs_ens || obs_ens || obs_ens || obs_ens || obs_ens || obs_ens || obs_ens || obs_ens || |
| | 29 | ||= 9 =|| type_obs || type_obs || type_obs || type_obs || type_obs || type_obs || type_obs || type_obs || type_obs || |
| | 30 | |
| | 31 | Overview of real-valued options for ensemble Kalman filters. The parameters are explained in the list of options as they are displayed using `subtype=-1`, which are shown further below |
| | 32 | |
| | 33 | ||= rparam =||= SEIK =||= LSEIK =||= EnKF =||= LEnKF =||= ETKF =||= LETKF =||= ESTKF =||= LESTKF =||= //ENSRF// =|| |
| | 34 | ||= 1 =|| forget ||forget || forget || forget || forget || forget || forget || forget || forget || |
| | 35 | |
| | 36 | |
| | 37 | |
| | 38 | === Options for nonlinear DA methods === |
| | 39 | |
| | 40 | Overview of integer options for nonlinear DA methods. The parameters are explained in the list of options as they are displayed using `subtype=-1`, which are shown further below. |
| | 41 | |
| | 42 | Parameters shown in italic font have changed in PDAF V3 compared to PDAF V2.3.1. The index position in PDAF V2.3.1 is shown in parenthesis. |
| | 43 | |
| | 44 | ||= iparam =||= NETF =||= LNETF =||= LKNETF =||= PF =|| |
| | 45 | ||= 1 =|| dim_p || dim_p || dim_p || dim_p || |
| | 46 | ||= 2 =|| dim_ens || dim_ens || dim_ens || dim_ens || |
| | 47 | ||= 3 =|| dim_lag || dim_lag || || |
| | 48 | ||= 4 =|| type_noise || type_noise || //type_hyb(7)// || type_noise |
| | 49 | ||= 5 =|| type_forget || type_forget || type_forget || || |
| | 50 | ||= 6 =|| type_trans || type_trans || type_trans || //type_resample(3)// || |
| | 51 | ||= 7 =|| type_winf || type_winf || || //type_winf(6)// || |
| | 52 | ||= 8 =|| obs_ens || obs_ens || obs_ens || obs_ens || |
| | 53 | ||= 9 =|| type_obs || type_obs || type_obs || type_obs || |
| | 54 | |
| | 55 | |
| | 56 | Overview of real-valued options: |
| | 57 | |
| | 58 | ||= rparam =||= NETF =||= LNETF =||= LKNETF =||= PF =|| |
| | 59 | ||= 1 =|| forget ||forget || forget || //forget(2)// || |
| | 60 | ||= 2 =|| limit_winf || limit_winf || hyb_g || //limit_winf(3)// || |
| | 61 | ||= 3 =|| noise_amp || noise_amp || hyb_k || //noise_amp(1)// || |
| | 62 | |
| | 63 | |
| | 64 | === Options for 3D-Var methods === |
| | 65 | |
| | 66 | Overview of integer options for 3D-Var methods. The parameters are explained in the list of options as they are displayed using `subtype=-1`, which are shown further below. |
| | 67 | |
| | 68 | Parameters shown in italic font have changed in PDAF V3 compared to PDAF V2.3.1. The index position in PDAF V2.3.1 is shown in parenthesis. |
| | 69 | |
| | 70 | ||= iparam =||= 3dvar =||= en3dvar =||= hyb3dvar =|| |
| | 71 | ||= 1 =|| dim_p || dim_p || dim_p || |
| | 72 | ||= 2 =|| dim_ens || dim_ens || dim_ens || |
| | 73 | ||= 3 =|| type_opt || type_opt || type_opt || |
| | 74 | ||= 4 =|| dim_cvec || || dim_cvec || |
| | 75 | ||= 5 =|| || dim_cvec_ens || dim_cvec_ens || |
| | 76 | ||= 6 =|| solver param1 || solver param1 || solver param1 || |
| | 77 | ||= 7 =|| solver param2 || solver param2 || solver param2 || |
| | 78 | ||= 8 =|| obs_ens || obs_ens || obs_ens || |
| | 79 | ||= 9 =|| type_obs || type_obs || type_obs || |
| | 80 | ||= 10 =|| || || || |
| | 81 | ||= 11 =|| || type_forget || type_forget || |
| | 82 | ||= 12 =|| || type_trans || type_trans || |
| | 83 | ||= 13 =|| || type_sqrt || type_sqrt || |
| | 84 | |
| | 85 | Overview of real-valued options: |
| | 86 | ||= rparam =||= 3dvar =||= en3dvar =||= hyb3dvar =|| |
| | 87 | ||= 1 =|| forget || forget || forget || |
| | 88 | ||= 2 =|| || || beta || |
| | 89 | ||= 3 =|| solver param3 || solver param3 || solver param3 || |
| | 90 | ||= 4 =|| solver param4 || solver param4 || solver param4 || |
| | 91 | |
| | 92 | |
| | 93 | == Option outputs using subtype=-1 == |
| | 94 | |
| | 95 | === SEIK (filtertype=PDAF_DA_SEIK=1) === |
| | 96 | |
| | 97 | {{{ |
| | 98 | PDAF Available options for SEIK: |
| | 99 | PDAF --- Sub-types (Parameter subtype) --- |
| | 100 | PDAF 0: full ensemble integration; left-sided application of T |
| | 101 | PDAF 1: full ensemble integration; right-sided application of T |
| | 102 | PDAF 2: full ensemble integration; explicit ensemble transformation |
| | 103 | PDAF 10: Fixed error space basis |
| | 104 | PDAF 11: Fixed state covariance matrix |
| | 105 | PDAF --- Integer parameters (Array param_int) --- |
| | 106 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 107 | PDAF param_int(2): Ensemble size (>0), required |
| | 108 | PDAF param_int(3): not used |
| | 109 | PDAF param_int(4): not used |
| | 110 | PDAF param_int(5) type_forget |
| | 111 | PDAF Type of forgetting factor; optional |
| | 112 | PDAF 0: fixed forgetting factor (default) |
| | 113 | PDAF 1: adaptive forgetting factor (experimental) |
| | 114 | PDAF param_int(6) type_trans |
| | 115 | PDAF Type of ensemble transformation matrix; optional |
| | 116 | PDAF 0: deterministic Omega (default) |
| | 117 | PDAF 1: random orthonormal Omega orthogonal to (1,...,1)^T |
| | 118 | PDAF 2: use product of 0 with random orthonomal matrix with eigenvector (1,...,1)^T |
| | 119 | PDAF (experimental; for random transformations, 1 is recommended) |
| | 120 | PDAF param_int(7) type_sqrt |
| | 121 | PDAF Type of transformation matrix square root; optional |
| | 122 | PDAF (Only relevant for subtype/=11) |
| | 123 | PDAF 0: symmetric square root (default) |
| | 124 | PDAF 1: Cholesky decomposition |
| | 125 | PDAF param_int(8): observe_ens |
| | 126 | PDAF Application of observation operator H, optional |
| | 127 | PDAF 0: Apply H to ensemble mean to compute innovation |
| | 128 | PDAF 1: Apply H to ensemble states; then compute innovation from their mean (default) |
| | 129 | PDAF param_int(8)=1 is the recomended choice for nonlinear H |
| | 130 | PDAF param_int(9): type_obs_init |
| | 131 | PDAF Initialize observations before or after call to prepoststep_pdaf |
| | 132 | PDAF 0: Initialize observations before call to prepoststep_pdaf |
| | 133 | PDAF 1: Initialize observations after call to prepoststep_pdaf (default) |
| | 134 | PDAF --- Floating point parameters (Array param_real) --- |
| | 135 | PDAF param_real(1): forget |
| | 136 | PDAF Forgetting factor (usually >0 and <=1), required |
| | 137 | PDAF --- Further parameters --- |
| | 138 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 139 | PDAF >=1 for subtypes 0, 1 and 2; not larger than total number of processors |
| | 140 | PDAF =1 required for subtypes 10 and 11 |
| | 141 | PDAF screen: Control verbosity of PDAF |
| | 142 | PDAF 0: no outputs |
| | 143 | PDAF 1: basic output (default) |
| | 144 | PDAF 2: 1 plus timing output |
| | 145 | PDAF 3: 2 plus debug output |
| | 146 | PDAF --- Internal parameter (defined inside PDAF) --- |
| | 147 | PDAF Nm1vsN: Normalization of covariance matrix; default: 1 |
| | 148 | PDAF 0: normalization with 1/(Ensemble size) |
| | 149 | PDAF (original SEIK, mainly for compatibility with older studies) |
| | 150 | PDAF 1: normalization with 1/(Ensemble size - 1) |
| | 151 | PDAF (sample covariance matrix consistent with other EnKFs) |
| | 152 | PDAF +++++++++ End of option overview for the SEIK filter ++++++++++ |
| | 153 | }}} |
| | 154 | |
| | 155 | |
| | 156 | === EnKF (filtertype=PDAF_DA_ENKF=2) === |
| | 157 | |
| | 158 | {{{ |
| | 159 | PDAF Available options for EnKF: |
| | 160 | PDAF --- Sub-types (Parameter subtype) --- |
| | 161 | PDAF 0: Full ensemble integration; analysis for 2*dim_obs>dim_ens |
| | 162 | PDAF 1: Full ensemble integration; analysis for 2*dim_obs<=dim_ens |
| | 163 | PDAF --- Integer parameters (Array param_int) --- |
| | 164 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 165 | PDAF param_int(2): Ensemble size (>0), required |
| | 166 | PDAF param_int(3): dim_lag |
| | 167 | PDAF Size of smoothing lag (>=0), optional |
| | 168 | PDAF 0: no smoothing (default) |
| | 169 | PDAF >0: apply smoother up to specified lag |
| | 170 | PDAF param_int(4): rank_ana_enkf |
| | 171 | PDAF maximum rank for inversion of HPH^T, optional, default=0 |
| | 172 | PDAF for =0, HPH is inverted by solving the representer equation |
| | 173 | PDAF allowed range is 0 to ensemble size - 1 |
| | 174 | PDAF param_int(5): not used |
| | 175 | PDAF param_int(6): not used |
| | 176 | PDAF param_int(7): not used |
| | 177 | PDAF param_int(8): observe_ens |
| | 178 | PDAF Application of observation operator H, optional |
| | 179 | PDAF 0: Apply H to ensemble mean to compute innovation |
| | 180 | PDAF 1: Apply H to ensemble states; then compute innovation from their mean (default) |
| | 181 | PDAF param_int(8)=1 is the recomended choice for nonlinear H |
| | 182 | PDAF param_int(9): type_obs_init |
| | 183 | PDAF Initialize observations before or after call to prepoststep_pdaf |
| | 184 | PDAF 0: Initialize observations before call to prepoststep_pdaf |
| | 185 | PDAF 1: Initialize observations after call to prepoststep_pdaf (default) |
| | 186 | PDAF --- Floating point parameters (Array param_real) --- |
| | 187 | PDAF param_real(1): forget |
| | 188 | PDAF Forgetting factor (usually >0 and <=1), required |
| | 189 | PDAF --- Further parameters --- |
| | 190 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 191 | PDAF (>=1; not larger than total number of processors) |
| | 192 | PDAF screen: Control verbosity of PDAF |
| | 193 | PDAF 0: no outputs |
| | 194 | PDAF 1: basic output (default) |
| | 195 | PDAF 2: 1 plus timing output |
| | 196 | PDAF 3: 2 plus debug output |
| | 197 | PDAF +++++++++ End of option overview for the EnKF ++++++++++ |
| | 198 | }}} |
| | 199 | |
| | 200 | |
| | 201 | === LSEIK (filtertype=PDAF_DA_LSEIK=3) === |
| | 202 | |
| | 203 | {{{ |
| | 204 | PDAF Available options for LSEIK: |
| | 205 | PDAF --- Sub-types (Parameter subtype) --- |
| | 206 | PDAF 0: full ensemble integration; left-sided application of T |
| | 207 | PDAF 1: full ensemble integration; explicit ensemble transformation |
| | 208 | PDAF 10: Fixed error space basis |
| | 209 | PDAF 11: Fixed state covariance matrix |
| | 210 | PDAF --- Integer parameters (Array param_int) --- |
| | 211 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 212 | PDAF param_int(2): Ensemble size (>0), required |
| | 213 | PDAF param_int(3): not used |
| | 214 | PDAF param_int(4): not used |
| | 215 | PDAF param_int(5) type_forget |
| | 216 | PDAF Type of forgetting factor; optional |
| | 217 | PDAF 0: fixed forgetting factor (default) |
| | 218 | PDAF 1: adaptive forgetting factor |
| | 219 | PDAF 2: locally adaptive forgetting factor |
| | 220 | PDAF param_int(6) type_trans |
| | 221 | PDAF Type of ensemble transformation matrix; optional |
| | 222 | PDAF 0: deterministic Omega (default) |
| | 223 | PDAF 1: random orthonormal Omega orthogonal to (1,...,1)^T |
| | 224 | PDAF 2: use product of 0 with random orthonomal matrix with eigenvector (1,...,1)^T |
| | 225 | PDAF (experimental; for random transformations, 1 is recommended) |
| | 226 | PDAF param_int(7) type_sqrt |
| | 227 | PDAF Type of transformation matrix square root; optional |
| | 228 | PDAF (Only relevant for subtype/=11) |
| | 229 | PDAF 0: symmetric square root (default) |
| | 230 | PDAF 1: Cholesky decomposition |
| | 231 | PDAF param_int(8): observe_ens |
| | 232 | PDAF Application of observation operator H, optional |
| | 233 | PDAF 0: Apply H to ensemble mean to compute innovation |
| | 234 | PDAF 1: Apply H to ensemble states; then compute innovation from their mean (default) |
| | 235 | PDAF param_int(8)=1 is the recomended choice for nonlinear H |
| | 236 | PDAF param_int(9): type_obs_init |
| | 237 | PDAF Initialize observations before or after call to prepoststep_pdaf |
| | 238 | PDAF 0: Initialize observations before call to prepoststep_pdaf |
| | 239 | PDAF 1: Initialize observations after call to prepoststep_pdaf (default) |
| | 240 | PDAF --- Floating point parameters (Array param_real) --- |
| | 241 | PDAF param_real(1): forget |
| | 242 | PDAF Forgetting factor (usually >0 and <=1), required |
| | 243 | PDAF --- Further parameters --- |
| | 244 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 245 | PDAF >=1 for subtypes 0 and 1; not larger than total number of processors |
| | 246 | PDAF =1 required for subtypes 10 and 11 |
| | 247 | PDAF screen: Control verbosity of PDAF |
| | 248 | PDAF 0: no outputs |
| | 249 | PDAF 1: basic output (default) |
| | 250 | PDAF 2: 1 plus timing output |
| | 251 | PDAF 3: 2 plus debug output |
| | 252 | PDAF --- Internal parameter (defined inside PDAF) --- |
| | 253 | PDAF Nm1vsN: Normalization of covariance matrix; default: 1 |
| | 254 | PDAF 0: normalization with 1/(Ensemble size) |
| | 255 | PDAF (original SEIK, mainly for compatibility with older studies) |
| | 256 | PDAF 1: normalization with 1/(Ensemble size - 1) |
| | 257 | PDAF (sample covariance matrix consistent with other EnKFs) |
| | 258 | PDAF +++++++++ End of option overview for the LSEIK filter ++++++++++ |
| | 259 | }}} |
| | 260 | |
| | 261 | |
| | 262 | === ETKF (filtertype=PDAF_DA_ETKF=4) === |
| | 263 | |
| | 264 | {{{ |
| | 265 | PDAF Available options for ETKF: |
| | 266 | PDAF --- Sub-types (Parameter subtype) --- |
| | 267 | PDAF 0: full ensemble integration; apply T-matrix analogously to SEIK |
| | 268 | PDAF 1: full ensemble integration; formulation cf. Hunt et al. (2007) without T matrix |
| | 269 | PDAF 10: Fixed error space basis; analysis with T-matrix |
| | 270 | PDAF 11: Fixed state covariance matrix; analysis with T-matrix |
| | 271 | PDAF --- Integer parameters (Array param_int) --- |
| | 272 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 273 | PDAF param_int(2): Ensemble size (>0), required |
| | 274 | PDAF param_int(3): dim_lag |
| | 275 | PDAF Size of smoothing lag (>=0), optional |
| | 276 | PDAF 0: no smoothing (default) |
| | 277 | PDAF >0: apply smoother up to specified lag |
| | 278 | PDAF param_int(4): not used |
| | 279 | PDAF param_int(5) type_forget |
| | 280 | PDAF Type of forgetting factor; optional |
| | 281 | PDAF 0: fixed forgetting factor (default) |
| | 282 | PDAF 1: adaptive forgetting factor (experimental) |
| | 283 | PDAF param_int(6) type_trans |
| | 284 | PDAF Type of ensemble transformation matrix; optional |
| | 285 | PDAF 0: deterministic transformation (default) |
| | 286 | PDAF 2: use product of 0 with random orthonomal matrix with eigenvector (1,...,1)^T |
| | 287 | PDAF param_int(7): not used |
| | 288 | PDAF param_int(8): observe_ens |
| | 289 | PDAF Application of observation operator H, optional |
| | 290 | PDAF 0: Apply H to ensemble mean to compute innovation |
| | 291 | PDAF 1: Apply H to ensemble states; then compute innovation from their mean (default) |
| | 292 | PDAF param_int(8)=1 is the recomended choice for nonlinear H |
| | 293 | PDAF param_int(9): type_obs_init |
| | 294 | PDAF Initialize observations before or after call to prepoststep_pdaf |
| | 295 | PDAF 0: Initialize observations before call to prepoststep_pdaf |
| | 296 | PDAF 1: Initialize observations after call to prepoststep_pdaf (default) |
| | 297 | PDAF --- Floating point parameters (Array param_real) --- |
| | 298 | PDAF param_real(1): forget |
| | 299 | PDAF Forgetting factor (usually >0 and <=1), required |
| | 300 | PDAF --- Further parameters --- |
| | 301 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 302 | PDAF >=1 for subtypes 0 and 1; not larger than total number of processors |
| | 303 | PDAF =1 required for subtypes 10 and 11 |
| | 304 | PDAF screen: Control verbosity of PDAF |
| | 305 | PDAF 0: no outputs |
| | 306 | PDAF 1: basic output (default) |
| | 307 | PDAF 2: 1 plus timing output |
| | 308 | PDAF 3: 2 plus debug output |
| | 309 | PDAF +++++++++ End of option overview for the ETKF ++++++++++ |
| | 310 | }}} |
| | 311 | |
| | 312 | |
| | 313 | |
| | 314 | |
| | 315 | === LETKF (filtertype=PDAF_DA_LETKF=5) === |
| | 316 | |
| | 317 | {{{ |
| | 318 | PDAF Available options for LETKF: |
| | 319 | PDAF --- Sub-types (Parameter subtype) --- |
| | 320 | PDAF 0: full ensemble integration; apply T-matrix analogously to SEIK |
| | 321 | PDAF 1: full ensemble integration; formulation cf. Hunt et al. (2007) without T matrix |
| | 322 | PDAF 10: Fixed error space basis; analysis with T-matrix |
| | 323 | PDAF 11: Fixed state covariance matrix; analysis with T-matrix |
| | 324 | PDAF --- Integer parameters (Array param_int) --- |
| | 325 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 326 | PDAF param_int(2): Ensemble size (>0), required |
| | 327 | PDAF param_int(3): dim_lag |
| | 328 | PDAF Size of smoothing lag (>=0), optional |
| | 329 | PDAF 0: no smoothing (default) |
| | 330 | PDAF >0: apply smoother up to specified lag |
| | 331 | PDAF param_int(4): not used |
| | 332 | PDAF param_int(5) type_forget |
| | 333 | PDAF Type of forgetting factor; optional |
| | 334 | PDAF 0: fixed forgetting factor (default) |
| | 335 | PDAF 1: adaptive forgetting factor for full domain |
| | 336 | PDAF 2: locally adaptive forgetting factor |
| | 337 | PDAF param_int(6) type_trans |
| | 338 | PDAF Type of ensemble transformation matrix; optional |
| | 339 | PDAF 0: deterministic transformation (default) |
| | 340 | PDAF 2: use product of 0 with random orthonomal matrix with eigenvector (1,...,1)^T |
| | 341 | PDAF param_int(8): observe_ens |
| | 342 | PDAF Application of observation operator H, optional |
| | 343 | PDAF 0: Apply H to ensemble mean to compute innovation |
| | 344 | PDAF 1: Apply H to ensemble states; then compute innovation from their mean (default) |
| | 345 | PDAF param_int(8)=1 is the recomended choice for nonlinear H |
| | 346 | PDAF param_int(9): type_obs_init |
| | 347 | PDAF Initialize observations before or after call to prepoststep_pdaf |
| | 348 | PDAF 0: Initialize observations before call to prepoststep_pdaf |
| | 349 | PDAF 1: Initialize observations after call to prepoststep_pdaf (default) |
| | 350 | PDAF --- Floating point parameters (Array param_real) --- |
| | 351 | PDAF param_real(1): forget |
| | 352 | PDAF Forgetting factor (usually >0 and <=1), required |
| | 353 | PDAF --- Further parameters --- |
| | 354 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 355 | PDAF >=1 for subtypes 0 and 1; not larger than total number of processors |
| | 356 | PDAF =1 required for subtypes 10 and 11 |
| | 357 | PDAF screen: Control verbosity of PDAF |
| | 358 | PDAF 0: no outputs |
| | 359 | PDAF 1: basic output (default) |
| | 360 | PDAF 2: 1 plus timing output |
| | 361 | PDAF 3: 2 plus debug output |
| | 362 | PDAF +++++++++ End of option overview for the LETKF ++++++++++ |
| | 363 | }}} |
| | 364 | |
| | 365 | |
| | 366 | |
| | 367 | |
| | 368 | === ESTKF (filtertype=PDAF_DA_ESTKF=6) === |
| | 369 | |
| | 370 | {{{ |
| | 371 | PDAF Available options for ESTKF: |
| | 372 | PDAF --- Sub-types (Parameter subtype) --- |
| | 373 | PDAF 0: Standard implementation with ensemble integration |
| | 374 | PDAF 10: Fixed error space basis |
| | 375 | PDAF 11: Fixed state covariance matrix |
| | 376 | PDAF --- Integer parameters (Array param_int) --- |
| | 377 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 378 | PDAF param_int(2): Ensemble size (>0), required |
| | 379 | PDAF param_int(3): dim_lag |
| | 380 | PDAF Size of smoothing lag (>=0), optional |
| | 381 | PDAF 0: no smoothing (default) |
| | 382 | PDAF >0: apply smoother up to specified lag |
| | 383 | PDAF param_int(4): not used |
| | 384 | PDAF param_int(5) type_forget |
| | 385 | PDAF Type of forgetting factor; optional |
| | 386 | PDAF 0: fixed forgetting factor (default) |
| | 387 | PDAF 1: adaptive forgetting factor (experimental) |
| | 388 | PDAF param_int(6) type_trans |
| | 389 | PDAF Type of ensemble transformation matrix; optional |
| | 390 | PDAF 0: deterministic Omega (default) |
| | 391 | PDAF 1: random orthonormal Omega orthogonal to (1,...,1)^T |
| | 392 | PDAF 2: use product of 0 with random orthonomal matrix with eigenvector (1,...,1)^T |
| | 393 | PDAF (experimental; for random transformations, 0 or 1 are recommended) |
| | 394 | PDAF param_int(7) type_sqrt |
| | 395 | PDAF Type of transformation matrix square root; optional |
| | 396 | PDAF 0: symmetric square root (default) |
| | 397 | PDAF 1: Cholesky decomposition |
| | 398 | PDAF param_int(8): observe_ens |
| | 399 | PDAF Application of observation operator H, optional |
| | 400 | PDAF 0: Apply H to ensemble mean to compute innovation |
| | 401 | PDAF 1: Apply H to ensemble states; then compute innovation from their mean (default) |
| | 402 | PDAF param_int(8)=1 is the recomended choice for nonlinear H |
| | 403 | PDAF param_int(9): type_obs_init |
| | 404 | PDAF Initialize observations before or after call to prepoststep_pdaf |
| | 405 | PDAF 0: Initialize observations before call to prepoststep_pdaf |
| | 406 | PDAF 1: Initialize observations after call to prepoststep_pdaf (default) |
| | 407 | PDAF --- Floating point parameters (Array param_real) --- |
| | 408 | PDAF param_real(1): forget |
| | 409 | PDAF Forgetting factor (usually >0 and <=1), required |
| | 410 | PDAF --- Further parameters --- |
| | 411 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 412 | PDAF >=1 for subtype 0; not larger than total number of processors |
| | 413 | PDAF =1 required for subtypes 10 and 11 |
| | 414 | PDAF screen: Control verbosity of PDAF |
| | 415 | PDAF 0: no outputs |
| | 416 | PDAF 1: basic output (default) |
| | 417 | PDAF 2: 1 plus timing output |
| | 418 | PDAF 3: 2 plus debug output |
| | 419 | PDAF +++++++++ End of option overview for the ESTKF ++++++++++ |
| | 420 | }}} |
| | 421 | |
| | 422 | |
| | 423 | |
| | 424 | |
| | 425 | === LESTKF (filtertype=PDAF_DA_LESTKF=7) === |
| | 426 | |
| | 427 | {{{ |
| | 428 | PDAF Available options for LESTKF: |
| | 429 | PDAF --- Sub-types (Parameter subtype) --- |
| | 430 | PDAF 0: Standard implementation with ensemble integration |
| | 431 | PDAF 10: Fixed error space basis |
| | 432 | PDAF 11: Fixed state covariance matrix |
| | 433 | PDAF --- Integer parameters (Array param_int) --- |
| | 434 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 435 | PDAF param_int(2): Ensemble size (>0), required |
| | 436 | PDAF param_int(3): dim_lag |
| | 437 | PDAF Size of smoothing lag (>=0), optional |
| | 438 | PDAF 0: no smoothing (default) |
| | 439 | PDAF >0: apply smoother up to specified lag |
| | 440 | PDAF param_int(4): not used |
| | 441 | PDAF param_int(5) type_forget |
| | 442 | PDAF Type of forgetting factor; optional |
| | 443 | PDAF 0: fixed forgetting factor (default) |
| | 444 | PDAF 1: adaptive forgetting factor for full domain |
| | 445 | PDAF 2: locally adaptive forgetting factor |
| | 446 | PDAF param_int(6) type_trans |
| | 447 | PDAF Type of ensemble transformation matrix; optional |
| | 448 | PDAF 0: deterministic Omega (default) |
| | 449 | PDAF 1: random orthonormal Omega orthogonal to (1,...,1)^T |
| | 450 | PDAF 2: use product of 0 with random orthonomal matrix with eigenvector (1,...,1)^T |
| | 451 | PDAF (experimental; for random transformations, 1 is recommended) |
| | 452 | PDAF param_int(7) type_sqrt |
| | 453 | PDAF Type of transformation matrix square root; optional |
| | 454 | PDAF 0: symmetric square root (default) |
| | 455 | PDAF 1: Cholesky decomposition |
| | 456 | PDAF param_int(8): observe_ens |
| | 457 | PDAF Application of observation operator H, optional |
| | 458 | PDAF 0: Apply H to ensemble mean to compute innovation |
| | 459 | PDAF 1: Apply H to ensemble states; then compute innovation from their mean (default) |
| | 460 | PDAF param_int(8)=1 is the recomended choice for nonlinear H |
| | 461 | PDAF param_int(9): type_obs_init |
| | 462 | PDAF Initialize observations before or after call to prepoststep_pdaf |
| | 463 | PDAF 0: Initialize observations before call to prepoststep_pdaf |
| | 464 | PDAF 1: Initialize observations after call to prepoststep_pdaf (default) |
| | 465 | PDAF --- Floating point parameters (Array param_real) --- |
| | 466 | PDAF param_real(1): forget |
| | 467 | PDAF Forgetting factor (usually >0 and <=1), required |
| | 468 | PDAF --- Further parameters --- |
| | 469 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 470 | PDAF >=1 for subtype 0; not larger than total number of processors |
| | 471 | PDAF =1 required for subtypes 10 and 11 |
| | 472 | PDAF screen: Control verbosity of PDAF |
| | 473 | PDAF 0: no outputs |
| | 474 | PDAF 1: basic output (default) |
| | 475 | PDAF 2: 1 plus timing output |
| | 476 | PDAF 3: 2 plus debug output |
| | 477 | PDAF +++++++++ End of option overview for the LESTKF ++++++++++ |
| | 478 | }}} |
| | 479 | |
| | 480 | |
| | 481 | |
| | 482 | |
| | 483 | === LEnKF (filtertype=PDAF_DA_LENKF=8) === |
| | 484 | |
| | 485 | {{{ |
| | 486 | PDAF Available options for LEnKF: |
| | 487 | PDAF --- Sub-types (Parameter subtype) --- |
| | 488 | PDAF 0: Standard EnKF analysis with covariance localization |
| | 489 | PDAF --- Integer parameters (Array param_int) --- |
| | 490 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 491 | PDAF param_int(2): Ensemble size (>0), required |
| | 492 | PDAF param_int(3): not used |
| | 493 | PDAF param_int(4): rank_ana_enkf |
| | 494 | PDAF maximum rank for inversion of HPH^T, optional, default=0 |
| | 495 | PDAF for =0, HPH is inverted by solving the representer equation |
| | 496 | PDAF allowed range is 0 to ensemble size - 1 |
| | 497 | PDAF param_int(5): not used |
| | 498 | PDAF param_int(6): not used |
| | 499 | PDAF param_int(7): not used |
| | 500 | PDAF param_int(8): observe_ens |
| | 501 | PDAF Application of observation operator H, optional |
| | 502 | PDAF 0: Apply H to ensemble mean to compute innovation |
| | 503 | PDAF 1: Apply H to ensemble states; then compute innovation from their mean (default) |
| | 504 | PDAF param_int(8)=1 is the recomended choice for nonlinear H |
| | 505 | PDAF param_int(9): type_obs_init |
| | 506 | PDAF Initialize observations before or after call to prepoststep_pdaf |
| | 507 | PDAF 0: Initialize observations before call to prepoststep_pdaf |
| | 508 | PDAF 1: Initialize observations after call to prepoststep_pdaf (default) |
| | 509 | PDAF --- Floating point parameters (Array param_real) --- |
| | 510 | PDAF param_real(1): forget |
| | 511 | PDAF Forgetting factor (usually >0 and <=1), required |
| | 512 | PDAF --- Further parameters --- |
| | 513 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 514 | PDAF (>=1; not larger than total number of processors) |
| | 515 | PDAF screen: Control verbosity of PDAF |
| | 516 | PDAF 0: no outputs |
| | 517 | PDAF 1: basic output (default) |
| | 518 | PDAF 2: 1 plus timing output |
| | 519 | PDAF 3: 2 plus debug output |
| | 520 | PDAF +++++++++ End of option overview for the LEnKF ++++++++++ |
| | 521 | }}} |
| | 522 | |
| | 523 | |
| | 524 | |
| | 525 | |
| | 526 | === NETF (filtertype=PDAF_DA_NETF=9) === |
| | 527 | |
| | 528 | {{{ |
| | 529 | PDAF Available options for NETF: |
| | 530 | PDAF --- Sub-types (Parameter subtype) --- |
| | 531 | PDAF 0: Standard implementation with ensemble integration |
| | 532 | PDAF --- Integer parameters (Array param_int) --- |
| | 533 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 534 | PDAF param_int(2): Ensemble size (>0), required |
| | 535 | PDAF param_int(3): dim_lag |
| | 536 | PDAF Size of smoothing lag (>=0), optional |
| | 537 | PDAF 0: no smoothing (default) |
| | 538 | PDAF >0: apply smoother up to specified lag |
| | 539 | PDAF param_int(4): type_noise |
| | 540 | PDAF Type of ensemble perturbations, optional |
| | 541 | PDAF 0: no perturbations (default) |
| | 542 | PDAF 1: constant standard deviation |
| | 543 | PDAF 2: relative to ensemble standard deviation |
| | 544 | PDAF param_int(5) type_forget |
| | 545 | PDAF Type of forgetting factor; optional |
| | 546 | PDAF 0: forgetting factor on forecast ensemble (default) |
| | 547 | PDAF 2: forgetting factor on analysis ensemble |
| | 548 | PDAF param_int(6) type_trans |
| | 549 | PDAF Type of ensemble transformation matrix; optional |
| | 550 | PDAF 0: random orthonormal matrix orthogonal to (1,...,1)^T (default) |
| | 551 | PDAF 1: deterministic transformation |
| | 552 | PDAF param_int(7): type_winf |
| | 553 | PDAF Type of weights inflation; optional |
| | 554 | PDAF 0: no weights inflation (default) |
| | 555 | PDAF 1: inflate so that N_eff/N > param_real(2) |
| | 556 | PDAF param_int(8): observe_ens |
| | 557 | PDAF Application of observation operator H, optional |
| | 558 | PDAF Note: This parameter has no influence on the NETF assimilation result |
| | 559 | PDAF 0: Apply H to ensemble mean to compute innovation |
| | 560 | PDAF 1: Apply H to ensemble states; then compute innovation from their mean (default) |
| | 561 | PDAF param_int(8)=1 is the recomended choice for nonlinear H |
| | 562 | PDAF param_int(9): type_obs_init |
| | 563 | PDAF Initialize observations before or after call to prepoststep_pdaf |
| | 564 | PDAF 0: Initialize observations before call to prepoststep_pdaf |
| | 565 | PDAF 1: Initialize observations after call to prepoststep_pdaf (default) |
| | 566 | PDAF --- Floating point parameters (Array param_real) --- |
| | 567 | PDAF param_real(1): forget |
| | 568 | PDAF Forgetting factor (usually >0 and <=1), required |
| | 569 | PDAF param_real(2): limit_winf |
| | 570 | PDAF Limit for weigts inflation N_eff/N > param_real(2), optional, default=0.0 |
| | 571 | PDAF param_real(3): noise_amp |
| | 572 | PDAF Ensemble perturbation level (>0), required, only used if param_int(4)>0 |
| | 573 | PDAF --- Further parameters --- |
| | 574 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 575 | PDAF >=1; not larger than total number of processors |
| | 576 | PDAF screen: Control verbosity of PDAF |
| | 577 | PDAF 0: no outputs |
| | 578 | PDAF 1: basic output (default) |
| | 579 | PDAF 2: 1 plus timing output |
| | 580 | PDAF 3: 2 plus debug output |
| | 581 | PDAF +++++++++ End of option overview for the NETF ++++++++++ |
| | 582 | }}} |
| | 583 | |
| | 584 | |
| | 585 | |
| | 586 | |
| | 587 | === LNETF (filtertype=PDAF_DA_LNETF=10) === |
| | 588 | |
| | 589 | {{{ |
| | 590 | PDAF Available options for LNETF: |
| | 591 | PDAF --- Sub-types (Parameter subtype) --- |
| | 592 | PDAF 0: Standard implementation with ensemble integration |
| | 593 | PDAF --- Integer parameters (Array param_int) --- |
| | 594 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 595 | PDAF param_int(2): Ensemble size (>0), required |
| | 596 | PDAF param_int(3): dim_lag |
| | 597 | PDAF Size of smoothing lag (>=0), optional |
| | 598 | PDAF 0: no smoothing (default) |
| | 599 | PDAF >0: apply smoother up to specified lag |
| | 600 | PDAF param_int(4): type_noise |
| | 601 | PDAF Type of ensemble perturbations, optional |
| | 602 | PDAF 0: no perturbations (default) |
| | 603 | PDAF 1: constant standard deviation |
| | 604 | PDAF 2: relative to ensemble standard deviation |
| | 605 | PDAF param_int(5) type_forget |
| | 606 | PDAF Type of forgetting factor; optional |
| | 607 | PDAF 0: forgetting factor on forecast ensemble (default) |
| | 608 | PDAF 1: forgetting factor on forecast ensemble only observed domains |
| | 609 | PDAF 2: forgetting factor on analysis ensemble |
| | 610 | PDAF 3: forgetting factor on analysis ensemble only observed domains |
| | 611 | PDAF param_int(6) type_trans |
| | 612 | PDAF Type of ensemble transformation matrix; optional |
| | 613 | PDAF 0: random orthonormal matrix orthogonal to (1,...,1)^T (default) |
| | 614 | PDAF 1: deterministic transformation |
| | 615 | PDAF param_int(7): type_winf |
| | 616 | PDAF Type of weights inflation; optional |
| | 617 | PDAF 0: no weights inflation (default) |
| | 618 | PDAF 1: inflate so that N_eff/N > param_real(2) |
| | 619 | PDAF param_int(8): observe_ens |
| | 620 | PDAF Application of observation operator H, optional |
| | 621 | PDAF Note: This parameter has no influence on the LNETF assimilation result |
| | 622 | PDAF 0: Apply H to ensemble mean to compute innovation |
| | 623 | PDAF 1: Apply H to ensemble states; then compute innovation from their mean (default) |
| | 624 | PDAF param_int(8)=1 is the recomended choice for nonlinear H |
| | 625 | PDAF param_int(9): type_obs_init |
| | 626 | PDAF Initialize observations before or after call to prepoststep_pdaf |
| | 627 | PDAF 0: Initialize observations before call to prepoststep_pdaf |
| | 628 | PDAF 1: Initialize observations after call to prepoststep_pdaf (default) |
| | 629 | PDAF --- Floating point parameters (Array param_real) --- |
| | 630 | PDAF param_real(1): forget |
| | 631 | PDAF Forgetting factor (usually >0 and <=1), required |
| | 632 | PDAF param_real(2): limit_winf |
| | 633 | PDAF Limit for weigts inflation N_eff/N > param_real(2), optional, default=0.0 |
| | 634 | PDAF param_real(3): noise_amp |
| | 635 | PDAF Ensemble perturbation level (>0), required, only used if param_int(4)>0 |
| | 636 | PDAF --- Further parameters --- |
| | 637 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 638 | PDAF >=1; not larger than total number of processors |
| | 639 | PDAF screen: Control verbosity of PDAF |
| | 640 | PDAF 0: no outputs |
| | 641 | PDAF 1: basic output (default) |
| | 642 | PDAF 2: 1 plus timing output |
| | 643 | PDAF 3: 2 plus debug output |
| | 644 | PDAF +++++++++ End of option overview for the LNETF ++++++++++ |
| | 645 | }}} |
| | 646 | |
| | 647 | |
| | 648 | |
| | 649 | |
| | 650 | === LKNETF (filtertype=PDAF_DA_LKNETF=11) === |
| | 651 | |
| | 652 | {{{ |
| | 653 | PDAF Available options for LKNETF: |
| | 654 | PDAF --- Sub-types (Parameter subtype) --- |
| | 655 | PDAF 0: HNK: 2-step LKNETF with NETF before LETKF |
| | 656 | PDAF 1: HKN: 2-step LKNETF with LETKF before NETF |
| | 657 | PDAF 2: HSync: LKNETF synchronous |
| | 658 | PDAF --- Integer parameters (Array param_int) --- |
| | 659 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 660 | PDAF param_int(2): Ensemble size (>0), required |
| | 661 | PDAF param_int(3): not used |
| | 662 | PDAF param_int(4): type_hyb |
| | 663 | PDAF Type of hybrid weight; optional |
| | 664 | PDAF 0: fixed value |
| | 665 | PDAF 1: gamma_lin: (1 - N_eff/N_e)*param_real(2) (default) |
| | 666 | PDAF 2: gamma_alpha: hybrid weight from N_eff/N>=param_real(2) |
| | 667 | PDAF 3: gamma_ska: 1 - min(s,k)/sqrt(param_real(3)) with N_eff/N>=param_real(2) |
| | 668 | PDAF 4: gamma_sklin: 1 - min(s,k)/sqrt(param_real(3)) >= 1-N_eff/N>=param_real(2) |
| | 669 | PDAF param_int(5): type_forget |
| | 670 | PDAF Type of forgetting factor; optional |
| | 671 | PDAF 0: inflate forecast ensemble by 1/forget (default) |
| | 672 | PDAF 1: inflate forecast ensemble by 1/forget only observed domains |
| | 673 | PDAF 2: inflate analysis ensemble by 1/forget |
| | 674 | PDAF 3: inflate analysis ensemble by 1/forget only observed domains |
| | 675 | PDAF 5: adaptive forgetting factor for full domain in LETKF part |
| | 676 | PDAF 6: locally adaptive forgetting factor in LETKF part |
| | 677 | PDAF param_int(6): type_trans |
| | 678 | PDAF Type of ensemble transformation matrix; optional |
| | 679 | PDAF 0: random orthonormal matrix orthogonal to (1,...,1)^T (default) |
| | 680 | PDAF 1: deterministic transformation |
| | 681 | PDAF param_int(7): not used |
| | 682 | PDAF --- Floating point parameters (Array param_real) --- |
| | 683 | PDAF param_real(1): forget |
| | 684 | PDAF Forgetting factor (usually >0 and <=1), required |
| | 685 | PDAF param_real(2): hyb_g |
| | 686 | PDAF prescribed hybrid weight gamma (usually >0 and <=1), optional, default=0.95 |
| | 687 | PDAF param_real(3): hyb_k |
| | 688 | PDAF hybrid norm kappa (>0), optional, default=dim_ens |
| | 689 | PDAF --- Further parameters --- |
| | 690 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 691 | PDAF >=1; not larger than total number of processors |
| | 692 | PDAF screen: Control verbosity of PDAF |
| | 693 | PDAF 0: no outputs |
| | 694 | PDAF 1: basic output (default) |
| | 695 | PDAF 2: 1 plus timing output |
| | 696 | PDAF 3: 2 plus debug output |
| | 697 | PDAF +++++++++ End of option overview for the LKNETF ++++++++++ |
| | 698 | }}} |
| | 699 | |
| | 700 | |
| | 701 | |
| | 702 | |
| | 703 | === PF (filtertype=PDAF_DA_PF=12) === |
| | 704 | |
| | 705 | {{{ |
| | 706 | PDAF Available options for PF: |
| | 707 | PDAF --- Sub-types (Parameter subtype) --- |
| | 708 | PDAF 0: Standard implementation with ensemble integration |
| | 709 | PDAF --- Integer parameters (Array param_int) --- |
| | 710 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 711 | PDAF param_int(2): Ensemble size (>0), required |
| | 712 | PDAF param_int(3): type_resample |
| | 713 | PDAF Resampling type, optional |
| | 714 | PDAF 1: probabilistic resamping (default) |
| | 715 | PDAF 2: stochastic universal resampling |
| | 716 | PDAF 3: residual resampling |
| | 717 | PDAF param_int(4): type_noise |
| | 718 | PDAF Type of ensemble perturbations, optional |
| | 719 | PDAF 0: no perturbations (default) |
| | 720 | PDAF 1: constant standard deviation |
| | 721 | PDAF 2: relative to ensemble standard deviation |
| | 722 | PDAF param_int(5) type_forget |
| | 723 | PDAF Type of forgetting factor; optional |
| | 724 | PDAF 0: forgetting factor on forecast ensemble (default) |
| | 725 | PDAF 2: forgetting factor on analysis ensemble |
| | 726 | PDAF param_int(6): not used |
| | 727 | PDAF param_int(7): type_winf |
| | 728 | PDAF Type of weights inflation; optional |
| | 729 | PDAF 0: no weights inflation (default) |
| | 730 | PDAF 1: inflate so that N_eff/N > param_real(2) |
| | 731 | PDAF param_int(8): observe_ens |
| | 732 | PDAF Application of observation operator H, optional |
| | 733 | PDAF Note: This parameter has no influence on the PF assimilation result |
| | 734 | PDAF 0: Apply H to ensemble mean to compute innovation |
| | 735 | PDAF 1: Apply H to ensemble states; then compute innovation from their mean (default) |
| | 736 | PDAF param_int(8)=1 is the recomended choice for nonlinear H |
| | 737 | PDAF param_int(9): type_obs_init |
| | 738 | PDAF Initialize observations before or after call to prepoststep_pdaf |
| | 739 | PDAF 0: Initialize observations before call to prepoststep_pdaf |
| | 740 | PDAF 1: Initialize observations after call to prepoststep_pdaf (default) |
| | 741 | PDAF --- Floating point parameters (Array param_real) --- |
| | 742 | PDAF param_real(1): forget |
| | 743 | PDAF Forgetting factor (usually >0 and <=1), required |
| | 744 | PDAF param_real(2): limit_winf |
| | 745 | PDAF Limit for weigts inflation N_eff/N > param_real(2), optional, default=0.0 |
| | 746 | PDAF param_real(3): noise_amp |
| | 747 | PDAF Ensemble perturbation level (>0), required, only used if param_int(4)>0 |
| | 748 | PDAF --- Further parameters --- |
| | 749 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 750 | PDAF >=1; not larger than total number of processors |
| | 751 | PDAF screen: Control verbosity of PDAF |
| | 752 | PDAF 0: no outputs |
| | 753 | PDAF 1: basic output (default) |
| | 754 | PDAF 2: 1 plus timing output |
| | 755 | PDAF 3: 2 plus debug output |
| | 756 | PDAF +++++++++ End of option overview for the PF ++++++++++ |
| | 757 | }}} |
| | 758 | |
| | 759 | |
| | 760 | |
| | 761 | |
| | 762 | === ENSRF/EAKF (filtertype=PDAF_DA_ENSRF=13) === |
| | 763 | |
| | 764 | {{{ |
| | 765 | PDAF Available options for ENSRF: |
| | 766 | PDAF --- Sub-types (Parameter subtype) --- |
| | 767 | PDAF 0: ENSRF with serial observation processing (cf. Houtekamer/Mitchell, 2002) |
| | 768 | PDAF 1: EAKF/2-step local least squares filter (cf. Anderson, 2003) |
| | 769 | PDAF --- Integer parameters (Array param_int) --- |
| | 770 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 771 | PDAF param_int(2): Ensemble size (>0), required |
| | 772 | PDAF param_int(3): not used |
| | 773 | PDAF param_int(4): not used |
| | 774 | PDAF param_int(5): not used |
| | 775 | PDAF param_int(6): not used |
| | 776 | PDAF param_int(7): not used |
| | 777 | PDAF param_int(8): observe_ens |
| | 778 | PDAF Application of observation operator H, optional |
| | 779 | PDAF 0: Apply H to ensemble mean to compute innovation |
| | 780 | PDAF 1: Apply H to ensemble states; then compute innovation from their mean (default) |
| | 781 | PDAF param_int(8)=1 is the recomended choice for nonlinear H |
| | 782 | PDAF param_int(9): type_obs_init |
| | 783 | PDAF Initialize observations before or after call to prepoststep_pdaf |
| | 784 | PDAF 0: Initialize observations before call to prepoststep_pdaf |
| | 785 | PDAF 1: Initialize observations after call to prepoststep_pdaf (default) |
| | 786 | PDAF --- Floating point parameters (Array param_real) --- |
| | 787 | PDAF param_real(1): forget |
| | 788 | PDAF Forgetting factor (usually >0 and <=1), required |
| | 789 | PDAF --- Further parameters --- |
| | 790 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 791 | PDAF (>=1; not larger than total number of processors) |
| | 792 | PDAF screen: Control verbosity of PDAF |
| | 793 | PDAF 0: no outputs |
| | 794 | PDAF 1: basic output (default) |
| | 795 | PDAF 2: 1 plus timing output |
| | 796 | PDAF 3: 2 plus debug output |
| | 797 | PDAF +++++++++ End of option overview for the ENSRF ++++++++++ |
| | 798 | }}} |
| | 799 | |
| | 800 | |
| | 801 | |
| | 802 | |
| | 803 | === GENOBS (filtertype=PDAF_DA_GENOBS=100) === |
| | 804 | |
| | 805 | {{{ |
| | 806 | PDAF Available options for GENOBS: |
| | 807 | PDAF --- Sub-types (Parameter subtype) --- |
| | 808 | PDAF 0: Standard implementation with ensemble integration |
| | 809 | PDAF --- Integer parameters (Array param_int) --- |
| | 810 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 811 | PDAF param_int(2): Ensemble size (>0), required |
| | 812 | PDAF param_int(3): seedset |
| | 813 | PDAF seed set index for random number generator, optional |
| | 814 | PDAF valid are values between 1 and 20; default=1 |
| | 815 | PDAF --- Floating point parameters (Array param_real) --- |
| | 816 | PDAF param_real(1): Forgetting factor (usually >0 and <=1), required, but not used |
| | 817 | PDAF --- Further parameters --- |
| | 818 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 819 | PDAF =1 for GENOBS; not larger than total number of processors |
| | 820 | PDAF =1 required for subtypes 10 and 11 |
| | 821 | PDAF screen: Control verbosity of PDAF |
| | 822 | PDAF 0: no outputs |
| | 823 | PDAF 1: basic output (default) |
| | 824 | PDAF 2: 1 plus timing output |
| | 825 | PDAF 3: 2 plus debug output |
| | 826 | PDAF +++++++++ End of option overview for GENOBS ++++++++++ |
| | 827 | }}} |
| | 828 | |
| | 829 | |
| | 830 | |
| | 831 | |
| | 832 | |
| | 833 | === 3D-Var (filtertype=PDAF_DA_3DVAR=200) === |
| | 834 | |
| | 835 | {{{ |
| | 836 | PDAF Available options for 3D-Var: |
| | 837 | PDAF --- Sub-types (Parameter subtype) --- |
| | 838 | PDAF 0: incremental 3D-Var with parameterized covariance matrix |
| | 839 | PDAF 1: 3D ensemble Var using LESTKF for ensemble transformation |
| | 840 | PDAF 2: 3D ensemble Var using ESTKF for ensemble transformation |
| | 841 | PDAF 3: hybrid 3D-Var using LESTKF for ensemble transformation |
| | 842 | PDAF 4: hybrid 3D-Var using ESTKF for ensemble transformation |
| | 843 | PDAF --- Integer parameters (Array param_int) --- |
| | 844 | PDAF param_int(1): Dimension of state vector (>0), required |
| | 845 | PDAF param_int(2): Ensemble size (>0), required |
| | 846 | PDAF param_int(3): type_opt |
| | 847 | PDAF Select optimization method (solver), required |
| | 848 | PDAF 1: LBFGS (default) |
| | 849 | PDAF 2: CG+ |
| | 850 | PDAF 3: direct implementation of CG |
| | 851 | PDAF 12: CG+ with decomposed control vector |
| | 852 | PDAF 13: direct implementation of CG with decomposed control vector |
| | 853 | PDAF param_int(4): size of parameterized control vector (for 3D-Var and hybrid 3D-Var), required |
| | 854 | PDAF param_int(5): size of ensemble control vector (required for ensemble and hybrid 3D-Var), |
| | 855 | PDAF param_int(6): Solver-specific parameter, optional |
| | 856 | PDAF LBFGS: parameter m (default=5) |
| | 857 | PDAF Number of corrections used in limited memory matrix; 3<=m<=20 |
| | 858 | PDAF CG+: parameter method (default=2) |
| | 859 | PDAF (1) Fletcher-Reeves, (2) Polak-Ribiere, (3) positive Polak-Ribiere |
| | 860 | PDAF CG: maximum number of iterations (default=200) |
| | 861 | PDAF param_int(7): Solver-specific parameter, optional |
| | 862 | PDAF CG+: parameter irest (default=1) |
| | 863 | PDAF (0) no restarts; (n>0) restart every n steps |
| | 864 | PDAF param_int(8): observe_ens |
| | 865 | PDAF Application of observation operator H, optional |
| | 866 | PDAF 0: Apply H to ensemble mean to compute innovation |
| | 867 | PDAF 1: Apply H to ensemble states; then compute innovation from their mean (default) |
| | 868 | PDAF param_int(8)=1 is the recomended choice for nonlinear H |
| | 869 | PDAF param_int(9): type_obs_init |
| | 870 | PDAF Initialize observations before or after call to prepoststep_pdaf |
| | 871 | PDAF 0: Initialize observations before call to prepoststep_pdaf |
| | 872 | PDAF 1: Initialize observations after call to prepoststep_pdaf (default) |
| | 873 | PDAF param_int(10): not used |
| | 874 | PDAF ___Options for ESTKF/LESTKF for En3DVar/hyb3DVar___ |
| | 875 | PDAF param_int(11) type_forget |
| | 876 | PDAF Type of forgetting factor; optional |
| | 877 | PDAF 0: fixed forgetting factor (default) |
| | 878 | PDAF 1: adaptive forgetting factor (experimental) |
| | 879 | PDAF 2: locally adaptive forgetting factor (experimental) |
| | 880 | PDAF param_int(12) type_trans |
| | 881 | PDAF Type of ensemble transformation matrix; optional |
| | 882 | PDAF 0: deterministic Omega (default) |
| | 883 | PDAF 1: random orthonormal Omega orthogonal to (1,...,1)^T |
| | 884 | PDAF 2: use product of 0 with random orthonomal matrix with eigenvector (1,...,1)^T |
| | 885 | PDAF (experimental; for random transformations, 0 or 1 are recommended) |
| | 886 | PDAF param_int(13) type_sqrt |
| | 887 | PDAF Type of transformation matrix square root; optional |
| | 888 | PDAF 0: symmetric square root (default) |
| | 889 | PDAF 1: Cholesky decomposition |
| | 890 | PDAF --- Floating point parameters (Array param_real) --- |
| | 891 | PDAF param_real(1): Forgetting factor (usually >0 and <=1), required; |
| | 892 | PDAF (only used for ensemble and hybrid 3D-Var) |
| | 893 | PDAF param_real(2): hybrid weight beta, optional (only for hybrid 3D-Var) |
| | 894 | PDAF range >=0.0 and <=1.0, =1.0 for pure ensemble 3D-var (default=0.5) |
| | 895 | PDAF param_real(3): Solver-specific parameter, optional |
| | 896 | PDAF LBFGS: Limit for stopping iterations (pgtol, default=1.0e-5) |
| | 897 | PDAF CG+: convergence parameter eps (default=1.0e-5) |
| | 898 | PDAF CG: convergence parameter eps (default=1.0e-6) |
| | 899 | PDAF param_real(4): Solver-specific parameter, optional |
| | 900 | PDAF LBFGS: Tolerance in termination test (factr, default=1.0e+7) |
| | 901 | PDAF --- Further parameters --- |
| | 902 | PDAF n_modeltasks: Number of parallel model integration tasks |
| | 903 | PDAF >=1 for subtypes >0; not larger than total number of processors |
| | 904 | PDAF =1 required for subtype 0 |
| | 905 | PDAF screen: Control verbosity of PDAF |
| | 906 | PDAF 0: no outputs |
| | 907 | PDAF 1: basic output (default) |
| | 908 | PDAF 2: 1 plus timing output |
| | 909 | PDAF 3: 2 plus debug output |
| | 910 | PDAF +++++++++ End of option overview for 3DVAR ++++++++++ |
| | 911 | }}} |