Skip to content

Commit

Permalink
doc: mention VP solver is only reproducible using 'bfbflag'
Browse files Browse the repository at this point in the history
The previous commits made sure that the model outputs as well as the log
file output are bit-for-bit reproducible when using the VP solver by
refactoring the code to use the existing 'global_sum_prod' subrooutine.

Add a note in the documentation mentioning that 'bfbflag' is required to
get bit-for-bit reproducible results under different decompositions /
MPI count when using the VP solver.

While at it, correct a typo in cice_index.rst.
  • Loading branch information
phil-blain committed Aug 25, 2022
1 parent 93491ab commit 579e19f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion doc/source/cice_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ either Celsius or Kelvin units).
"awtvdf", "weighting factor for visible, diffuse albedo", "0.63282"
"awtvdr", "weighting factor for visible, direct albedo", "0.00318"
"**B**", "", ""
"bfb_flag", "for bit-for-bit reproducible diagnostics", ""
"bfbflag", "for bit-for-bit reproducible diagnostics, and reproducible outputs when using the VP solver", ""
"bgc_data_dir", "data directory for bgc", ""
"bgc_data_type", "source of silicate, nitrate data", ""
"bgc_flux_type", "ice–ocean flux velocity", ""
Expand Down
6 changes: 3 additions & 3 deletions doc/source/developer_guide/dg_other.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ To run with an interactive debugger, the following general steps should be taken
Reproducible Sums
----------------------

Reproducible sums in the CICE diagnostics are set with the namelist `bfbflag`.
CICE prognostics results do NOT depend on the global sum implementation. The
Reproducible sums in CICE are set with the namelist `bfbflag`.
CICE prognostics results do NOT depend on the global sum implementation when using the default dynamics solver (EVP) or the EAP solver. With these solvers, the
results are bit-for-bit identical with any `bfbflag`. The `bfbflag` only impacts
the results and performance of the global diagnostics written to the CICE
log file. For best performance, the off (or lsum8 which is equivalent) setting is recommended.
log file (for all dynamics solvers), as well as the model results when using the VP solver. For best performance, the off (or lsum8 which is equivalent) setting is recommended.
This will probably not produce bit-for-bit results with different decompositions.
For bit-for-bit results, the reprosum setting is recommended. This should be
only slightly slower than the lsum8 implementation.
Expand Down

0 comments on commit 579e19f

Please sign in to comment.