This is the documentation of the most upstream development version of GRACE. If you're looking for the last stable release please select a different version of this documentation.

checkpoints

This page contains a full reference of all parameters available for the checkpoints module. At the bottom of the page you can find an example parameter block that can be used in your parameter file.

checkpoints

Parameters controlling checkpointing

Name:

checkpoint_dir

Type:

string

Default:

../checkpoints

Description:

Relative path to where checkpoints are written

Name:

max_n_checkpoints

Type:

unsigned int

Default:

3

Range:

[1,*)

Description:

How many checkpoints to keep before we start deleting old ones?

Name:

interval_kind

Type:

keyword

Default:

walltime

Range:

walltime, time, iteration

Description:

What unit of time controls checkpointing frequency?

Name:

iteration_interval

Type:

int

Default:

1000

Range:

(0,*)

Description:

If interval_kind is iteration, how often to checkpoint?

Name:

time_interval

Type:

double

Default:

204

Range:

(0,*)

Description:

If interval_kind is time, how often to checkpoint?

Name:

walltime_interval

Type:

double

Default:

12

Range:

(0,*)

Description:

If interval_kind is walltime, how often to checkpoint (in hours)?

Name:

checkpoint_at_startup

Type:

bool

Default:

False

Description:

Write a checkpoint after ID

Name:

checkpoint_at_termination

Type:

bool

Default:

True

Description:

Write a checkpoint before termination