simulation_checkpoint::simulation_checkpoint_t Type Reference

Collaboration diagram for simulation_checkpoint::simulation_checkpoint_t:

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)
	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.

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 = .true.
	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(chkp_output_t)	chkp_output
type(field_t), dimension(:), allocatable	p_list
type(field_t), dimension(:), allocatable	u_list
type(field_t), dimension(:), allocatable	v_list
type(field_t), dimension(:), allocatable	w_list
integer	n_scalars = 0
type(field_t), dimension(:), allocatable	s_list

Detailed Description

Definition at line 49 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 94 of file checkpoint.f90.

init() [1/2]

generic, public simulation_checkpoint::simulation_checkpoint_t::init

Definition at line 86 of file checkpoint.f90.

init() [2/2]

generic, public simulation_checkpoint::simulation_checkpoint_t::init

Definition at line 86 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
	)

Definition at line 91 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 88 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 96 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 100 of file checkpoint.f90.

Member Data Documentation

algorithm

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

Definition at line 58 of file checkpoint.f90.

chkp_output

type(chkp_output_t) simulation_checkpoint::simulation_checkpoint_t::chkp_output

Definition at line 75 of file checkpoint.f90.

filename

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

Definition at line 60 of file checkpoint.f90.

first_valid_timestep

integer simulation_checkpoint::simulation_checkpoint_t::first_valid_timestep = 2

Definition at line 71 of file checkpoint.f90.

fmt

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

Definition at line 62 of file checkpoint.f90.

keep_checkpoints

logical simulation_checkpoint::simulation_checkpoint_t::keep_checkpoints = .true.

Definition at line 66 of file checkpoint.f90.

loaded_checkpoint

integer simulation_checkpoint::simulation_checkpoint_t::loaded_checkpoint = -1

Definition at line 72 of file checkpoint.f90.

n_saves_disc

integer simulation_checkpoint::simulation_checkpoint_t::n_saves_disc = 0

Definition at line 69 of file checkpoint.f90.

n_saves_memory

integer simulation_checkpoint::simulation_checkpoint_t::n_saves_memory = 10

Definition at line 64 of file checkpoint.f90.

n_scalars

integer simulation_checkpoint::simulation_checkpoint_t::n_scalars = 0

Definition at line 81 of file checkpoint.f90.

n_timesteps

integer simulation_checkpoint::simulation_checkpoint_t::n_timesteps = 0

Definition at line 70 of file checkpoint.f90.

p_list

type(field_t), dimension(:), allocatable simulation_checkpoint::simulation_checkpoint_t::p_list

Definition at line 76 of file checkpoint.f90.

s_list

type(field_t), dimension(:), allocatable simulation_checkpoint::simulation_checkpoint_t::s_list

Definition at line 82 of file checkpoint.f90.

u_list

type(field_t), dimension(:), allocatable simulation_checkpoint::simulation_checkpoint_t::u_list

Definition at line 77 of file checkpoint.f90.

v_list

type(field_t), dimension(:), allocatable simulation_checkpoint::simulation_checkpoint_t::v_list

Definition at line 78 of file checkpoint.f90.

w_list

type(field_t), dimension(:), allocatable simulation_checkpoint::simulation_checkpoint_t::w_list

Definition at line 79 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