diff --git a/case_studies/shallow_water/checkpoints/galewsky_checkpoints.py b/case_studies/shallow_water/checkpoints/galewsky_checkpoints.py index aa78f7eb..62000b5a 100644 --- a/case_studies/shallow_water/checkpoints/galewsky_checkpoints.py +++ b/case_studies/shallow_water/checkpoints/galewsky_checkpoints.py @@ -12,6 +12,16 @@ PETSc.Sys.popErrorHandler() +# Run the Galewsky test case and checkpoint solution to disk at specified intervals. +# +# These checkpoints can be used for: +# 1. converting to vtu to check solution veracity using `checkpoint_to_pvd.py` +# 2. starting a test from partway through the Galewsky case - e.g. starting +# a Paradiag run from several days in once nonlinearity has developed. +# 3. Testing solvers for the nonlinear blocks using standalone complex-proxy +# scripts. The checkpoints are used to linearise the nonlinear operator around +# to construct the complex-proxy blocks. + # get command arguments import argparse parser = argparse.ArgumentParser(