Changes between Version 11 and Version 12 of AvailableOptionsforInitPDAF


Ignore:
Timestamp:
Dec 16, 2021, 5:52:44 PM (2 years ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • AvailableOptionsforInitPDAF

    v11 v12  
    5454PDAF       param_int(2): Ensemble size (>0), required
    5555PDAF       param_int(3): not used
    56 PDAF       param_int(4): 1 for incremental updating, 0 else; optional, default: 0
    57 PDAF       param_int(5): Type of forgetting factor; optional, default: 0
    58 PDAF           0: fixed forgetting factor
     56PDAF       param_int(4): Apply incremental updating; optional
     57PDAF           0: no incremental updating (default)
     58PDAF           1: apply incremental updating
     59PDAF       param_int(5): Type of forgetting factor; optional
     60PDAF           0: fixed forgetting factor (default)
    5961PDAF           1: adaptive forgetting factor (experimental)
    60 PDAF       param_int(6): Type of ensemble transformation matrix; optional, default: 0
    61 PDAF           0: deterministic omega
     62PDAF       param_int(6): Type of ensemble transformation matrix; optional
     63PDAF           0: deterministic omega (default)
    6264PDAF           1: random orthonormal omega orthogonal to (1,...,1)^T
    6365PDAF           2: use product of 0 with random orthonomal matrix with eigenvector (1,...,1)^T
    6466PDAF              (experimental; for random transformations, 1 is recommended)
    65 PDAF       param_int(7): Type of transformation matrix square root; optional, default: 0
     67PDAF       param_int(7): Type of transformation matrix square root; optional
    6668PDAF           (Only relevant for subtype/=3)
    67 PDAF           0: symmetric square root
     69PDAF           0: symmetric square root (default)
    6870PDAF           1: Cholesky decomposition
    69 PDAF       param_int(8): Application of observation operator H, default: 0
    70 PDAF           0: Apply H to ensemble mean to compute residual
     71PDAF       param_int(8): Application of observation operator H, optional
     72PDAF           0: Apply H to ensemble mean to compute residual (default)
    7173PDAF           1: Apply H to all ensemble states and then compute residual from mean of these
    7274PDAF              param_int(8)=1 is the recomended choice for nonlinear H
    … …  
    107109PDAF           (if set to >=ensemble size, it is reset to ensemble size - 1)
    108110PDAF       param_int(4): not used
    109 PDAF       param_int(5): Size of lag for smoothing
     111PDAF       param_int(5): Size of smoothing lag (>=0), optional
     112PDAF           0: no smoothing (default)
     113PDAF           >0: apply smoother up to specified lag
    110114PDAF     --- Floating point parameters (Array param_real) ---
    111115PDAF       param_real(1): Forgetting factor (usually >0 and <=1), required
    … …  
    135139PDAF       param_int(2): Ensemble size (>0), required
    136140PDAF       param_int(3): not used
    137 PDAF       param_int(4): 1 for incremental updating, 0 else; optional, default: 0
    138 PDAF       param_int(5): Type of forgetting factor; optional, default: 0
    139 PDAF           0: fixed forgetting factor
     141PDAF       param_int(4): Apply incremental updating; optional
     142PDAF           0: no incremental updating (default)
     143PDAF           1: apply incremental updating
     144PDAF       param_int(5): Type of forgetting factor; optional
     145PDAF           0: fixed forgetting factor (default)
    140146PDAF           1: adaptive forgetting factor for full domain (experimental)
    141147PDAF           2: locally adaptive forgetting factor (experimental)
    142 PDAF       param_int(6): Type of ensemble transformation matrix; optional, default: 0
    143 PDAF           0: deterministic omega
     148PDAF       param_int(6): Type of ensemble transformation matrix; optional
     149PDAF           0: deterministic omega (default)
    144150PDAF           1: random orthonormal omega orthogonal to (1,...,1)^T
    145151PDAF           2: use product of 0 with random orthonomal matrix with eigenvector (1,...,1)^T
    146152PDAF              (experimental; for random transformations, 1 is recommended)
    147 PDAF       param_int(7): Type of transformation matrix square root; optional, default: 0
     153PDAF       param_int(7): Type of transformation matrix square root; optional
    148154PDAF           (Only relevant for subtype/=3)
    149 PDAF           0: symmetric square root
     155PDAF           0: symmetric square root (default)
    150156PDAF           1: Cholesky decomposition
    151157PDAF     --- Floating point parameters (Array param_real) ---
    … …  
    183189PDAF       param_int(1): Dimension of state vector (>0), required
    184190PDAF       param_int(2): Ensemble size (>0), required
    185 PDAF       param_int(3): Size of lag for smoothing
    186 PDAF       param_int(4): not used
    187 PDAF       param_int(5): Type of forgetting factor; optional, default: 0
    188 PDAF           0: fixed forgetting factor
     191PDAF       param_int(3): Size of smoothing lag (>=0), optional
     192PDAF           0: no smoothing (default)
     193PDAF           >0: apply smoother up to specified lag
     194PDAF       param_int(4): not used
     195PDAF       param_int(5): Type of forgetting factor; optional
     196PDAF           0: fixed forgetting factor (default)
    189197PDAF           1: adaptive forgetting factor (experimental)
    190 PDAF       param_int(6): Type of ensemble transformation matrix; optional, default: 0
    191 PDAF           0: deterministic transformation
     198PDAF       param_int(6): Type of ensemble transformation matrix; optional
     199PDAF           0: deterministic transformation (default)
    192200PDAF           2: use product of 0 with random orthonomal matrix with eigenvector (1,...,1)^T
    193201PDAF       param_int(7): not used
    194 PDAF       param_int(8): Application of observation operator H, default: 0
    195 PDAF           0: Apply H to ensemble mean to compute residual
    196 PDAF           1: Apply H to all ensemble states and then compute residual from mean of these
     202PDAF       param_int(8): Application of observation operator H
     203PDAF           0: Apply H to ensemble mean to compute residual (default)
     204PDAF           1: Apply H to all ensemble states; then compute residual from mean of these
    197205PDAF              param_int(8)=1 is the recomended choice for nonlinear H
    198206PDAF     --- Floating point parameters (Array param_real) ---
    … …  
    223231PDAF       param_int(1): Dimension of state vector (>0), required
    224232PDAF       param_int(2): Ensemble size (>0), required
    225 PDAF       param_int(3): Size of lag for smoothing
    226 PDAF       param_int(4): not used
    227 PDAF       param_int(5): Type of forgetting factor; optional, default: 0
    228 PDAF           0: fixed forgetting factor
     233PDAF       param_int(3): Size of smoothing lag (>=0), optional
     234PDAF           0: no smoothing (default)
     235PDAF           >0: apply smoother up to specified lag
     236PDAF       param_int(4): not used
     237PDAF       param_int(5): Type of forgetting factor; optional
     238PDAF           0: fixed forgetting factor (default)
    229239PDAF           1: adaptive forgetting factor for full domain (experimental)
    230240PDAF           2: locally adaptive forgetting factor (experimental)
    231 PDAF       param_int(6): Type of ensemble transformation matrix; optional, default: 0
    232 PDAF           0: deterministic transformation
     241PDAF       param_int(6): Type of ensemble transformation matrix; optional
     242PDAF           0: deterministic transformation (default)
    233243PDAF           2: use product of 0 with random orthonomal matrix with eigenvector (1,...,1)^T
    234244PDAF     --- Floating point parameters (Array param_real) ---
    … …  
    259269PDAF       param_int(1): Dimension of state vector (>0), required
    260270PDAF       param_int(2): Ensemble size (>0), required
    261 PDAF       param_int(3): Size of lag for smoothing
    262 PDAF       param_int(4): not used
    263 PDAF       param_int(5): Type of forgetting factor; optional, default: 0
    264 PDAF           0: fixed forgetting factor
     271PDAF       param_int(3): Size of smoothing lag (>=0), optional
     272PDAF           0: no smoothing (default)
     273PDAF           >0: apply smoother up to specified lag
     274PDAF       param_int(4): not used
     275PDAF       param_int(5): Type of forgetting factor; optional
     276PDAF           0: fixed forgetting factor (default)
    265277PDAF           1: adaptive forgetting factor (experimental)
    266 PDAF       param_int(6): Type of ensemble transformation matrix; optional, default: 0
    267 PDAF           0: deterministic omega
     278PDAF       param_int(6): Type of ensemble transformation matrix; optional
     279PDAF           0: deterministic omega (default)
    268280PDAF           1: random orthonormal omega orthogonal to (1,...,1)^T
    269281PDAF           2: use product of 0 with random orthonomal matrix with eigenvector (1,...,1)^T
    270282PDAF              (experimental; for random transformations, 0 or 1 are recommended)
    271 PDAF       param_int(7): Type of transformation matrix square root; optional, default: 0
    272 PDAF           0: symmetric square root
     283PDAF       param_int(7): Type of transformation matrix square root; optional
     284PDAF           0: symmetric square root (default)
    273285PDAF           1: Cholesky decomposition
    274 PDAF       param_int(8): Application of observation operator H, default: 0
    275 PDAF           0: Apply H to ensemble mean to compute residual
    276 PDAF           1: Apply H to all ensemble states and then compute residual from mean of these
     286PDAF       param_int(8): Application of observation operator H
     287PDAF           0: Apply H to ensemble mean to compute residual (default)
     288PDAF           1: Apply H to all ensemble states; then compute residual from mean of these
    277289PDAF              param_int(8)=1 is the recomended choice for nonlinear H
    278290PDAF     --- Floating point parameters (Array param_real) ---
    … …  
    303315PDAF       param_int(1): Dimension of state vector (>0), required
    304316PDAF       param_int(2): Ensemble size (>0), required
    305 PDAF       param_int(3): Size of lag for smoothing
    306 PDAF       param_int(4): not used
    307 PDAF       param_int(5): Type of forgetting factor; optional, default: 0
    308 PDAF           0: fixed forgetting factor
     317PDAF       param_int(3): Size of smoothing lag (>=0), optional
     318PDAF           0: no smoothing (default)
     319PDAF           >0: apply smoother up to specified lag
     320PDAF       param_int(4): not used
     321PDAF       param_int(5): Type of forgetting factor; optional
     322PDAF           0: fixed forgetting factor (default)
    309323PDAF           1: adaptive forgetting factor for full domain (experimental)
    310324PDAF           2: locally adaptive forgetting factor (experimental)
    311 PDAF       param_int(6): Type of ensemble transformation matrix; optional, default: 0
    312 PDAF           0: deterministic omega
     325PDAF       param_int(6): Type of ensemble transformation matrix; optional
     326PDAF           0: deterministic omega (default)
    313327PDAF           1: random orthonormal omega orthogonal to (1,...,1)^T
    314328PDAF           2: use product of 0 with random orthonomal matrix with eigenvector (1,...,1)^T
    315329PDAF              (experimental; for random transformations, 1 is recommended)
    316 PDAF       param_int(7): Type of transformation matrix square root; optional, default: 0
    317 PDAF           0: symmetric square root
     330PDAF       param_int(7): Type of transformation matrix square root; optional
     331PDAF           0: symmetric square root (default)
    318332PDAF           1: Cholesky decomposition
    319333PDAF     --- Floating point parameters (Array param_real) ---
    … …  
    369383PDAF       param_int(1): Dimension of state vector (>0), required
    370384PDAF       param_int(2): Ensemble size (>0), required
    371 PDAF       param_int(3): Size of lag for smoothing
    372 PDAF       param_int(4): not used
    373 PDAF       param_int(5): Type of forgetting factor; optional, default: 0
    374 PDAF           0: forgetting factor on forecast ensemble
     385PDAF       param_int(3): Size of smoothing lag (>=0), optional
     386PDAF           0: no smoothing (default)
     387PDAF           >0: apply smoother up to specified lag
     388PDAF       param_int(4): not used
     389PDAF       param_int(5): Type of forgetting factor; optional
     390PDAF           0: forgetting factor on forecast ensemble (default)
    375391PDAF           2: forgetting factor on analysis ensemble
    376 PDAF       param_int(6): Type of ensemble transformation matrix; optional, default: 0
    377 PDAF           0: random orthonormal matrix orthogonal to (1,...,1)^T
     392PDAF       param_int(6): Type of ensemble transformation matrix; optional
     393PDAF           0: random orthonormal matrix orthogonal to (1,...,1)^T (default)
    378394PDAF           1: deterministic transformation
    379 PDAF       param_int(7): Type of weights inflation; optional, default: 0
    380 PDAF           0: no weights inflation
     395PDAF       param_int(7): Type of weights inflation; optional
     396PDAF           0: no weights inflation (default)
    381397PDAF           1: inflate so that N_eff/N > param_real(2)
    382398PDAF     --- Floating point parameters (Array param_real) ---
    … …  
    405421PDAF       param_int(1): Dimension of state vector (>0), required
    406422PDAF       param_int(2): Ensemble size (>0), required
    407 PDAF       param_int(3): Size of lag for smoothing
    408 PDAF       param_int(4): not used
    409 PDAF       param_int(5): Type of forgetting factor; optional, default: 0
    410 PDAF           0: forgetting factor on forecast ensemble
     423PDAF       param_int(3): Size of smoothing lag (>=0), optional
     424PDAF           0: no smoothing (default)
     425PDAF           >0: apply smoother up to specified lag
     426PDAF       param_int(4): not used
     427PDAF       param_int(5): Type of forgetting factor; optional
     428PDAF           0: forgetting factor on forecast ensemble (default)
    411429PDAF           1: forgetting factor on forecast ensemble only observed domains
    412430PDAF           2: forgetting factor on analysis ensemble
    413431PDAF           3: forgetting factor on analysis ensemble only observed domains
    414 PDAF       param_int(6): Type of ensemble transformation matrix; optional, default: 0
    415 PDAF           0: random orthonormal matrix orthogonal to (1,...,1)^T
     432PDAF       param_int(6): Type of ensemble transformation matrix; optional
     433PDAF           0: random orthonormal matrix orthogonal to (1,...,1)^T (default)
    416434PDAF           1: deterministic transformation
    417 PDAF       param_int(7): Type of weights inflation; optional, default: 0
    418 PDAF           0: no weights inflation
     435PDAF       param_int(7): Type of weights inflation; optional
     436PDAF           0: no weights inflation (default)
    419437PDAF           1: inflate so that N_eff/N > param_real(2)
    420438PDAF     --- Floating point parameters (Array param_real) ---
    … …  
    433451}}}
    434452
    435 == GENOBS (filtertype=11) ==
    436 
    437 {{{
    438 PDAF     Available options for GENOBS:
    439 PDAF     --- Sub-types (Parameter subtype) ---
    440 PDAF       0: Standard implementation with ensemble integration
    441 PDAF     --- Integer parameters (Array param_int) ---
    442 PDAF       param_int(1): Dimension of state vector (>0), required
    443 PDAF       param_int(2): Ensemble size (>0), required
    444 PDAF     --- Floating point parameters (Array param_real) ---
    445 PDAF       param_real(1): Forgetting factor (usually >0 and <=1), required, but not used
    446 PDAF     --- Further parameters ---
    447 PDAF       n_modeltasks: Number of parallel model integration tasks
    448 PDAF           =1 for GENOBS; not larger than total number of processors
    449 PDAF           =1 required for subtypes 2 and 3
    450 PDAF       screen: Control verbosity of PDAF
    451 PDAF           0: no outputs
    452 PDAF           1: basic output (default)
    453 PDAF           2: 1 plus timing output
    454 PDAF           3: 2 plus debug output
    455 PDAF     +++++++++ End of option overview for GENOBS  ++++++++++
    456 }}}
    457453
    458454== PF (filtertype=12) ==
    … …  
    474470PDAF           1: constant standard deviation
    475471PDAF           2: relative to ensemble standard deviation
     472PDAF       param_int(5): Type of forgetting factor; optional
     473PDAF           0: forgetting factor on forecast ensemble (default)
     474PDAF           2: forgetting factor on analysis ensemble
     475PDAF       param_int(6): Type of weights inflation; optional
     476PDAF           0: no weights inflation (default)
     477PDAF           1: inflate so that N_eff/N > param_real(2)
    476478PDAF     --- Floating point parameters (Array param_real) ---
    477479PDAF       param_real(1): Ensemble pert. level (>0), required, only used if param_int(4)>0
     480PDAF       param_real(2): Forgetting factor (usually >0 and <=1), optional, default=1.0
     481PDAF       param_real(3): Limit for weigts inflation N_eff/N > param_real(2), optional, default=0.0
    478482PDAF     --- Further parameters ---
    479483PDAF       n_modeltasks: Number of parallel model integration tasks
    … …  
    487491PDAF     +++++++++ End of option overview for the PF  ++++++++++
    488492}}}
     493
     494== GENOBS (filtertype=100 (=11 before PDAF V2.0)) ==
     495
     496{{{
     497PDAF     Available options for GENOBS:
     498PDAF     --- Sub-types (Parameter subtype) ---
     499PDAF       0: Standard implementation with ensemble integration
     500PDAF     --- Integer parameters (Array param_int) ---
     501PDAF       param_int(1): Dimension of state vector (>0), required
     502PDAF       param_int(2): Ensemble size (>0), required
     503PDAF     --- Floating point parameters (Array param_real) ---
     504PDAF       param_real(1): Forgetting factor (usually >0 and <=1), required, but not used
     505PDAF     --- Further parameters ---
     506PDAF       n_modeltasks: Number of parallel model integration tasks
     507PDAF           =1 for GENOBS; not larger than total number of processors
     508PDAF           =1 required for subtypes 2 and 3
     509PDAF       screen: Control verbosity of PDAF
     510PDAF           0: no outputs
     511PDAF           1: basic output (default)
     512PDAF           2: 1 plus timing output
     513PDAF           3: 2 plus debug output
     514PDAF     +++++++++ End of option overview for GENOBS  ++++++++++
     515}}}
     516
     517== 3DVAR (filtertype=200) [added in PDAF V2.0] ==
     518
     519{{{
     520PDAF     Available options for 3D-Var:
     521PDAF     --- Sub-types (Parameter subtype) ---
     522PDAF       0: incremental 3D-Var with parameterized covariance matrix
     523PDAF       1: 3D ensemble Var using LESTKF for ensemble transformation
     524PDAF       4: 3D ensemble Var using ESTKF for ensemble transformation
     525PDAF       5: Offline mode; analysis chosen by PDAF_put_state/PDAF_assimilate
     526PDAF       6: hybrid 3D-Var using LESTKF for ensemble transformation
     527PDAF       7: hybrid 3D-Var using ESTKF for ensemble transformation
     528PDAF     --- Integer parameters (Array param_int) ---
     529PDAF       param_int(1): Dimension of state vector (>0), required
     530PDAF       param_int(2): Ensemble size (>0), required
     531PDAF       param_int(3): Select optimization method (solver), required
     532PDAF           0: LBFGS (default)
     533PDAF           1: CG+
     534PDAF           2: direct implementation of CG
     535PDAF           3: direct implementation of CG with decomposed control vector
     536PDAF       param_int(4): size of parameterized control vector (for parameterized and hybrid 3D-Var), required
     537PDAF       param_int(5): size of ensemble control vector (required for ensemble and hybrid 3D-Var),
     538PDAF       param_int(4): Dimension of parameterized control vector
     539PDAF     --- Floating point parameters (Array param_real) ---
     540PDAF       param_real(1): Forgetting factor (usually >0 and <=1), required
     541PDAF       param_real(2): hybrid weight beta, optional
     542PDAF           >=0.0 and <=1.0 (default = 0.5)
     543PDAF     --- Further parameters ---
     544PDAF       n_modeltasks: Number of parallel model integration tasks
     545PDAF           >=1 for subtypes 0 and 1; not larger than total number of processors
     546PDAF           =1 required for subtypes 2 and 3
     547PDAF       screen: Control verbosity of PDAF
     548PDAF           0: no outputs
     549PDAF           1: basic output (default)
     550PDAF           2: 1 plus timing output
     551PDAF           3: 2 plus debug output
     552PDAF     +++++++++ End of option overview for 3DVAR ++++++++++}}}