Skip to content

Commit

Permalink
add description of what the galewsky_checkpoint script is for
Browse files Browse the repository at this point in the history
  • Loading branch information
JHopeCollins committed Apr 23, 2024
1 parent 9e491f9 commit e78df9b
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions case_studies/shallow_water/checkpoints/galewsky_checkpoints.py
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down

0 comments on commit e78df9b

Please sign in to comment.