Skip to content

Commit bf9d69a

Browse files
committed
doc: input documentation for CLM:statevec_colmean
1 parent 3ff1bb3 commit bf9d69a

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

doc/content/setup_tsmp/input_enkfpf.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ update_T =
5656
print_swc =
5757
print_et =
5858
statevec_allcol =
59+
statevec_colmean =
5960
statevec_only_active =
6061
statevec_max_layer =
6162
t_printensemble =
@@ -495,23 +496,39 @@ further information, see source code. Default: `0`.
495496
### CLM:statevec_allcol ###
496497

497498
`CLM:statevec_allcol`: (integer) Switch for using all SWC columns of a
498-
CLM5 gridcell in the state vector.
499+
eCLM gridcell in the state vector.
499500

500501
If `0` (default): Only one SWC value per grid cell is saved in the
501502
state vector.
502503

503504
If `1`: `#columns` SWC values per grid cell are saved in the state
504505
vector.
505506

506-
### CLM:statevec_only_active ###
507+
Remark: `CLM:statevec_allcol` should not be switched on together with
508+
`CLM:statevec_colmean`.
507509

508-
**Not yet in main branch**
510+
### CLM:statevec_colmean ###
511+
512+
`CLM:statevec_colmean`: (integer) Switch for using gridcell averages
513+
of SWC (which is a column-variable) in the state vector.
514+
515+
If `0` (default): Only the SWC value from the **first** column is
516+
saved per grid cell in the state vector.
517+
518+
If `1`: The gridcell mean over all (possibly hydrologically active)
519+
SWC values is saved per grid cell in the state vector.
520+
521+
Remark: `CLM:statevec_colmean` should not be switched on together with
522+
`CLM:statevec_allcol`.
523+
524+
### CLM:statevec_only_active ###
509525

510526
`CLM:statevec_only_active`: (integer) Switch for using in the state
511527
vector only (1) hydrologically active columns of a CLM5 gridcell and
512528
(2) only layers until bedrock.
513529

514-
Only used, when `CLM:statevec_allcol` is switched on.
530+
Only used for `CLM:update_swc`. Therein, only used, when either
531+
`CLM:statevec_colmean` or `CLM:statevec_allcol` is used.
515532

516533
If `0` (default): Use all columns and all layers.
517534

@@ -786,6 +803,7 @@ Default: 0, output turned off.
786803
| | `print_swc` | 0 |
787804
| | `print_et` | 0 |
788805
| | `statevec_allcol` | 0 |
806+
| | `statevec_colmean` | 0 |
789807
| | `statevec_only_active` | 0 |
790808
| | `statevec_max_layer` | 25 |
791809
| | `t_printensemble` | -1 |

0 commit comments

Comments
 (0)