Collaboration diagram for simulation_checkpoint::simulation_checkpoint_t:

[legend]

Public Member Functions
generic, public	init init_from_json
	Initialization.

generic, public	init init_from_components
	Initialization.

procedure, pass(this), public	init_from_json (this, neko_case, params)
	Initialization from a JSON file.

procedure, pass(this), public	init_from_components (this, neko_case, algorithm, n_saves_memory, filename, fmt, keep_checkpoints, extra_fields)
	Initialization from components.

procedure, pass(this), public	free (this)
	Free.

procedure, pass(this), public	reset (this, neko_case)
	Reset the checkpoint data.

procedure, pass(this), public	restore (this, neko_case, tstep)
	Save the current state of the simulation to disk.

procedure, pass(this)	save_data (this, index)
	Save current data to the ram checkpoint at index.

procedure, pass(this)	load_data (this, index)
	Restore data from the ram checkpoint at index to the current state.

Public Attributes
character(len=256)	algorithm = "linear"
	The checkpointing algorithm to use.

character(len=256)	filename = "checkpoint"
	The name of the checkpoint file.

character(len=8)	fmt = "chkp"
	The format of the checkpoint file.

integer	n_saves_memory = 10
	Number of checkpoints to keep in memory.

logical	keep_checkpoints = .false.
	Whether to keep the checkpoint files on disk after the simulation ends.

integer	n_saves_disc = 0

integer	n_timesteps = 0

integer	first_valid_timestep = 2

integer	loaded_checkpoint = -1

type(field_list_t)	state_list

type(host_array), dimension(:,:), allocatable	state_storage

type(chkp_output_t)	chkp_output

Detailed Description

Definition at line 56 of file checkpoint.f90.

Member Function/Subroutine Documentation

◆ free()

procedure, pass(this), public simulation_checkpoint::simulation_checkpoint_t::free ( class(simulation_checkpoint_t), intent(inout) this )

Definition at line 98 of file checkpoint.f90.

◆ init() [1/2]

generic, public simulation_checkpoint::simulation_checkpoint_t::init

Definition at line 90 of file checkpoint.f90.

◆ init() [2/2]

generic, public simulation_checkpoint::simulation_checkpoint_t::init

Definition at line 90 of file checkpoint.f90.

◆ init_from_components()

procedure, pass(this), public simulation_checkpoint::simulation_checkpoint_t::init_from_components	(	class(simulation_checkpoint_t), intent(inout), target	this,
		class(case_t), intent(inout), target	neko_case,
		character(len=*), intent(in), optional	algorithm,
		integer, intent(in), optional	n_saves_memory,
		character(len=*), intent(in), optional	filename,
		character(len=*), intent(in), optional	fmt,
		logical, intent(in), optional	keep_checkpoints,
		type(field_list_t), intent(inout), optional	extra_fields
	)

Definition at line 95 of file checkpoint.f90.

◆ init_from_json()

procedure, pass(this), public simulation_checkpoint::simulation_checkpoint_t::init_from_json	(	class(simulation_checkpoint_t), intent(inout)	this,
		class(case_t), intent(inout), target	neko_case,
		type(json_file), intent(inout), target	params
	)

Restore the forward simulation state in a linear fashion Initialization

Definition at line 92 of file checkpoint.f90.

◆ load_data()

procedure, pass(this) simulation_checkpoint::simulation_checkpoint_t::load_data	(	class(simulation_checkpoint_t), intent(inout)	this,
		integer, intent(in)	index
	)

Parameters

this	The checkpoint object.
index	The index in the RAM checkpoint to restore from.

Definition at line 109 of file checkpoint.f90.

◆ reset()

procedure, pass(this), public simulation_checkpoint::simulation_checkpoint_t::reset	(	class(simulation_checkpoint_t), intent(inout)	this,
		class(case_t), intent(inout)	neko_case
	)

Definition at line 100 of file checkpoint.f90.

◆ restore()

procedure, pass(this), public simulation_checkpoint::simulation_checkpoint_t::restore	(	class(simulation_checkpoint_t), intent(inout)	this,
		class(case_t), intent(inout), target	neko_case,
		integer, intent(in)	tstep
	)

Restore the forward simulation state

Definition at line 104 of file checkpoint.f90.

◆ save_data()

procedure, pass(this) simulation_checkpoint::simulation_checkpoint_t::save_data	(	class(simulation_checkpoint_t), intent(inout)	this,
		integer, intent(in)	index
	)

Parameters

this	The checkpoint object.
index	The index in the RAM checkpoint to save to.

Definition at line 107 of file checkpoint.f90.

Member Data Documentation

◆ algorithm

character(len=256) simulation_checkpoint::simulation_checkpoint_t::algorithm = "linear"

Definition at line 65 of file checkpoint.f90.

◆ chkp_output

type(chkp_output_t) simulation_checkpoint::simulation_checkpoint_t::chkp_output

Definition at line 86 of file checkpoint.f90.

◆ filename

character(len=256) simulation_checkpoint::simulation_checkpoint_t::filename = "checkpoint"

Definition at line 67 of file checkpoint.f90.

◆ first_valid_timestep

integer simulation_checkpoint::simulation_checkpoint_t::first_valid_timestep = 2

Definition at line 78 of file checkpoint.f90.

◆ fmt

character(len=8) simulation_checkpoint::simulation_checkpoint_t::fmt = "chkp"

Definition at line 69 of file checkpoint.f90.

◆ keep_checkpoints

logical simulation_checkpoint::simulation_checkpoint_t::keep_checkpoints = .false.

Definition at line 73 of file checkpoint.f90.

◆ loaded_checkpoint

integer simulation_checkpoint::simulation_checkpoint_t::loaded_checkpoint = -1

Definition at line 79 of file checkpoint.f90.

◆ n_saves_disc

integer simulation_checkpoint::simulation_checkpoint_t::n_saves_disc = 0

Definition at line 76 of file checkpoint.f90.

◆ n_saves_memory

integer simulation_checkpoint::simulation_checkpoint_t::n_saves_memory = 10

Definition at line 71 of file checkpoint.f90.

◆ n_timesteps

integer simulation_checkpoint::simulation_checkpoint_t::n_timesteps = 0

Definition at line 77 of file checkpoint.f90.

◆ state_list

type(field_list_t) simulation_checkpoint::simulation_checkpoint_t::state_list

Definition at line 82 of file checkpoint.f90.

◆ state_storage

type(host_array), dimension(:,:), allocatable simulation_checkpoint::simulation_checkpoint_t::state_storage

Definition at line 83 of file checkpoint.f90.

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

/home/runner/work/neko-top/neko-top/sources/checkpoint/checkpoint.f90

Public Member Functions

Public Attributes