checkpoint Module Reference

Defines format-independent checkpoint registration and restart state.

Data Types
type	chkp_t
	Collection of live simulation data registered for checkpointing. More...

Functions/Subroutines
subroutine	chkp_init (this)
	Initialize an empty checkpoint.
subroutine	chkp_free (this)
	Release all checkpoint payloads and restart metadata.
subroutine	chkp_sync_host (this)
	Synchronise registered checkpoint data from device to host.
subroutine	chkp_sync_device (this)
	Synchronise registered checkpoint data from host to device.
pure integer function	chkp_scalar_payload_count (this)
	Return the number of registered scalar payloads.
type(checkpoint_payload_t) function, pointer	chkp_add_payload (this, name)
	Add or return a checkpoint payload.
type(checkpoint_payload_t) function, pointer	chkp_get_payload (this, name)
	Return a checkpoint payload by name.
pure integer function	chkp_payload_count (this)
	Return the number of registered checkpoint payloads.
subroutine	chkp_add_time_state (this, time_state)
	Register the simulation time history as a replicated payload.
subroutine	chkp_get_time_history (this, tlag, dtlag)
	Return pointers to the simulation time history.
pure real(kind=dp) function	chkp_restart_time (this)
	Return the restart time from a loaded checkpoint.
subroutine	chkp_set_time_state (this, time_state)
	Restore a simulation time state from the checkpoint.

Function/Subroutine Documentation

chkp_add_payload()

type(checkpoint_payload_t) function, pointer checkpoint::chkp_add_payload ( class(chkp_t), intent(inout)  this, character(len=*), intent(in)  name  )

private

Parameters

name	Payload path to add or find.

Returns

Pointer to the registered payload.

Definition at line 234 of file checkpoint.f90.

chkp_add_time_state()

subroutine checkpoint::chkp_add_time_state ( class(chkp_t), intent(inout)  this, type(time_state_t), intent(inout), target  time_state  )

private

Parameters

time_state

Simulation time history to register.

Definition at line 295 of file checkpoint.f90.

chkp_free()

subroutine checkpoint::chkp_free ( class(chkp_t), intent(inout)  this )

private

Definition at line 102 of file checkpoint.f90.

chkp_get_payload()

type(checkpoint_payload_t) function, pointer checkpoint::chkp_get_payload ( class(chkp_t), intent(in)  this, character(len=*), intent(in)  name  )

private

Parameters

name	Payload path to find.

Returns

Pointer to the registered payload.

Definition at line 261 of file checkpoint.f90.

chkp_get_time_history()

subroutine checkpoint::chkp_get_time_history ( class(chkp_t), intent(in)  this, real(kind=dp), dimension(:), intent(out), pointer  tlag, real(kind=dp), dimension(:), intent(out), pointer  dtlag  )

private

Parameters

tlag	Pointer to the registered previous times.
dtlag	Pointer to the registered previous time-step sizes.

Definition at line 309 of file checkpoint.f90.

chkp_init()

subroutine checkpoint::chkp_init

(

class(chkp_t), intent(inout)

this

)

Definition at line 93 of file checkpoint.f90.

chkp_payload_count()

pure integer function checkpoint::chkp_payload_count ( class(chkp_t), intent(in)  this )

private

Returns

Number of registered payloads.

Definition at line 281 of file checkpoint.f90.

chkp_restart_time()

pure real(kind=dp) function checkpoint::chkp_restart_time ( class(chkp_t), intent(in)  this )

private

Returns

Restart time stored in the checkpoint.

Definition at line 325 of file checkpoint.f90.

chkp_scalar_payload_count()

pure integer function checkpoint::chkp_scalar_payload_count ( class(chkp_t), intent(in)  this )

private

Returns

Number of registered scalar payloads.

Definition at line 218 of file checkpoint.f90.

chkp_set_time_state()

subroutine checkpoint::chkp_set_time_state ( class(chkp_t), intent(in)  this, type(time_state_t), intent(inout)  time_state  )

private

Parameters

time_state

Simulation time state to restore.

Definition at line 334 of file checkpoint.f90.

chkp_sync_device()

subroutine checkpoint::chkp_sync_device ( class(chkp_t), intent(inout)  this )

private

Definition at line 171 of file checkpoint.f90.

chkp_sync_host()

subroutine checkpoint::chkp_sync_host ( class(chkp_t), intent(inout)  this )

private

Definition at line 124 of file checkpoint.f90.