checkpoint::chkp_t Type Reference

Collection of live simulation data registered for checkpointing. More...

Collaboration diagram for checkpoint::chkp_t:

Public Member Functions
procedure, pass(this)	init (this)
	Initialize an empty checkpoint.
procedure, pass(this)	sync_host (this)
	Synchronise registered checkpoint data from device to host.
procedure, pass(this)	sync_device (this)
	Synchronise registered checkpoint data from host to device.
procedure, pass(this)	add_payload (this, name)
	Add or return a checkpoint payload.
procedure, pass(this)	get_payload (this, name)
	Return a checkpoint payload by name.
procedure, pass(this)	payload_count (this)
	Return the number of registered checkpoint payloads.
procedure, pass(this)	scalar_payload_count (this)
	Return the number of registered scalar payloads.
procedure, pass(this)	add_time_state (this, time_state)
	Register the simulation time history as a replicated payload.
procedure, pass(this)	get_time_history (this, tlag, dtlag)
	Return pointers to the simulation time history.
procedure, pass(this)	restart_time (this)
	Return the restart time from a loaded checkpoint.
procedure, pass(this)	set_time_state (this, time_state)
	Restore a simulation time state from the checkpoint.
procedure, pass(this)	free (this)
	Release all checkpoint payloads and restart metadata.

Public Attributes
type(checkpoint_payload_ptr_t), dimension(:), allocatable	payloads
	Format-independent checkpoint payloads.
real(kind=dp)	t = 0d0
	Restart time, valid after loading a checkpoint.
type(mesh_t)	previous_mesh
	Mesh on which an interpolated legacy checkpoint was written.
type(space_t)	previous_xh
	Function space of a loaded legacy checkpoint.
real(kind=dp)	mesh2mesh_tol = GLOB_INTERP_TOL
	Point-search tolerance for legacy mesh-to-mesh restart.

Detailed Description

Definition at line 51 of file checkpoint.f90.

Member Function/Subroutine Documentation

add_payload()

procedure, pass(this) checkpoint::chkp_t::add_payload	(	class(chkp_t), intent(inout)	this,
		character(len=*), intent(in)	name
	)

Parameters

name	Payload path to add or find.

Returns

Pointer to the registered payload.

Definition at line 71 of file checkpoint.f90.

add_time_state()

procedure, pass(this) checkpoint::chkp_t::add_time_state	(	class(chkp_t), intent(inout)	this,
		type(time_state_t), intent(inout), target	time_state
	)

Parameters

time_state

Simulation time history to register.

Definition at line 79 of file checkpoint.f90.

free()

procedure, pass(this) checkpoint::chkp_t::free

(

class(chkp_t), intent(inout)

this

)

Definition at line 87 of file checkpoint.f90.

get_payload()

procedure, pass(this) checkpoint::chkp_t::get_payload	(	class(chkp_t), intent(in)	this,
		character(len=*), intent(in)	name
	)

Parameters

name	Payload path to find.

Returns

Pointer to the registered payload.

Definition at line 73 of file checkpoint.f90.

get_time_history()

procedure, pass(this) checkpoint::chkp_t::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
	)

Parameters

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

Definition at line 81 of file checkpoint.f90.

init()

procedure, pass(this) checkpoint::chkp_t::init

(

class(chkp_t), intent(inout)

this

)

Definition at line 65 of file checkpoint.f90.

payload_count()

procedure, pass(this) checkpoint::chkp_t::payload_count

(

class(chkp_t), intent(in)

this

)

Returns

Number of registered payloads.

Definition at line 75 of file checkpoint.f90.

restart_time()

procedure, pass(this) checkpoint::chkp_t::restart_time

(

class(chkp_t), intent(in)

this

)

Returns

Restart time stored in the checkpoint.

Definition at line 83 of file checkpoint.f90.

scalar_payload_count()

procedure, pass(this) checkpoint::chkp_t::scalar_payload_count

(

class(chkp_t), intent(in)

this

)

Returns

Number of registered scalar payloads.

Definition at line 77 of file checkpoint.f90.

set_time_state()

procedure, pass(this) checkpoint::chkp_t::set_time_state	(	class(chkp_t), intent(in)	this,
		type(time_state_t), intent(inout)	time_state
	)

Parameters

time_state

Simulation time state to restore.

Definition at line 85 of file checkpoint.f90.

sync_device()

procedure, pass(this) checkpoint::chkp_t::sync_device

(

class(chkp_t), intent(inout)

this

)

Definition at line 69 of file checkpoint.f90.

sync_host()

procedure, pass(this) checkpoint::chkp_t::sync_host

(

class(chkp_t), intent(inout)

this

)

Definition at line 67 of file checkpoint.f90.

Member Data Documentation

mesh2mesh_tol

real(kind=dp) checkpoint::chkp_t::mesh2mesh_tol = GLOB_INTERP_TOL

Definition at line 62 of file checkpoint.f90.

payloads

type(checkpoint_payload_ptr_t), dimension(:), allocatable checkpoint::chkp_t::payloads

Definition at line 53 of file checkpoint.f90.

previous_mesh

type(mesh_t) checkpoint::chkp_t::previous_mesh

Definition at line 58 of file checkpoint.f90.

previous_xh

type(space_t) checkpoint::chkp_t::previous_xh

Definition at line 60 of file checkpoint.f90.

t

real(kind=dp) checkpoint::chkp_t::t = 0d0

Definition at line 56 of file checkpoint.f90.

---

The documentation for this type was generated from the following file:

• /home/runner/work/neko/neko/src/common/checkpoint.f90