Interface for Neko legacy checkpoint files. More...

Inheritance diagram for chkp_file::chkp_file_t:

Collaboration diagram for chkp_file::chkp_file_t:

[legend]

Public Member Functions
procedure	read (this, data)
	Load a Neko legacy checkpoint.

procedure	read_field (this, fh, byte_offset, x, nel)
	Read and optionally interpolate one legacy checkpoint field.

procedure	write (this, data, t)
	Write a Neko legacy checkpoint.

procedure	get_next_output_fname (this)
	Get the physical file name generated by the next write.

procedure	set_overwrite (this, overwrite)
	Set whether checkpoint files may be overwritten.

procedure	init (this, fname)
	Generic file constructor.

procedure(generic_file_write), deferred	write (this, data, t)
	Read method.

procedure(generic_file_read), deferred	read (this, data)

procedure	get_fname (this)
	Get a file's name.

procedure	get_next_output_fname (this)
	Get the file name generated by the next write.

procedure	get_base_fname (this)
	Get base name without counter.

procedure	set_counter (this, n)
	Set the file counter to n.

procedure	get_counter (this)
	Get the file counter.

procedure	set_start_counter (this, n)
	Set the file start counter to n.

procedure	get_start_counter (this)
	Get the file start counter.

procedure	increment_counter (this)
	Increment the file counter by 1.

procedure	check_exists (this)
	Ensure the file exists.

procedure	set_overwrite (this, overwrite)
	Set overwrite mode.

Public Attributes
type(space_t), pointer	chkp_xh
	Function space in the loaded checkpoint file.

type(space_t), pointer	sim_xh
	Function space used in the simulation.

type(interpolator_t)	space_interp
	Interpolation used when only the polynomial order changes.

type(global_interpolation_t)	global_interp
	Interpolation used when the mesh changes.

logical	mesh2mesh
	Whether the checkpoint mesh differs from the simulation mesh.

logical	serial = .false.
	File format is serial.

logical	overwrite = .false.

Private Attributes
character(len=1024), private	fname

integer, private	counter = -1

integer, private	start_counter = 0

Detailed Description

Definition at line 95 of file chkp_file.f90.

Member Function/Subroutine Documentation

◆ check_exists()

procedure generic_file::generic_file_t::check_exists ( class(generic_file_t), intent(in) this )

inherited

Definition at line 73 of file generic_file.f90.

◆ get_base_fname()

procedure generic_file::generic_file_t::get_base_fname ( class(generic_file_t), intent(in) this )

inherited

Definition at line 61 of file generic_file.f90.

◆ get_counter()

procedure generic_file::generic_file_t::get_counter ( class(generic_file_t), intent(in) this )

inherited

Definition at line 65 of file generic_file.f90.

◆ get_fname()

procedure generic_file::generic_file_t::get_fname ( class(generic_file_t), intent(in) this )

inherited

Definition at line 57 of file generic_file.f90.

◆ get_next_output_fname() [1/2]

procedure chkp_file::chkp_file_t::get_next_output_fname ( class(chkp_file_t), intent(in) this )

Definition at line 114 of file chkp_file.f90.

◆ get_next_output_fname() [2/2]

procedure generic_file::generic_file_t::get_next_output_fname ( class(generic_file_t), intent(in) this )

inherited

Definition at line 59 of file generic_file.f90.

◆ get_start_counter()

procedure generic_file::generic_file_t::get_start_counter ( class(generic_file_t), intent(in) this )

inherited

Definition at line 69 of file generic_file.f90.

◆ increment_counter()

procedure generic_file::generic_file_t::increment_counter ( class(generic_file_t), intent(inout) this )

inherited

Definition at line 71 of file generic_file.f90.

◆ init()

procedure generic_file::generic_file_t::init	(	class(generic_file_t)	this,
		character(len=*)	fname
	)

inherited

Write method.

Definition at line 51 of file generic_file.f90.

◆ read() [1/2]

procedure chkp_file::chkp_file_t::read	(	class(chkp_file_t)	this,
		class(*), intent(inout), target	data
	)

Parameters

data	Checkpoint data to populate.

Definition at line 108 of file chkp_file.f90.

◆ read() [2/2]

procedure(generic_file_read), deferred generic_file::generic_file_t::read	(	class(generic_file_t)	this,
		class(*), intent(inout), target	data
	)

pure virtualinherited

Definition at line 55 of file generic_file.f90.

◆ read_field()

procedure chkp_file::chkp_file_t::read_field	(	class(chkp_file_t)	this,
		type(mpi_file)	fh,
		integer(kind=mpi_offset_kind)	byte_offset,
		real(kind=rp), dimension(this%sim_xh%lxyz, nel)	x,
		integer, intent(in)	nel
	)

Parameters

fh	Open MPI file handle.
byte_offset	Byte offset of the rank-local field data.
x	Simulation-space field storage to populate.
nel	Number of local elements.

Definition at line 110 of file chkp_file.f90.

◆ set_counter()

procedure generic_file::generic_file_t::set_counter	(	class(generic_file_t), intent(inout)	this,
		integer, intent(in)	n
	)

inherited

Definition at line 63 of file generic_file.f90.

◆ set_overwrite() [1/2]

procedure chkp_file::chkp_file_t::set_overwrite	(	class(chkp_file_t), intent(inout)	this,
		logical, intent(in)	overwrite
	)

Parameters

overwrite Whether existing files may be overwritten.

Definition at line 116 of file chkp_file.f90.

◆ set_overwrite() [2/2]

procedure generic_file::generic_file_t::set_overwrite	(	class(generic_file_t), intent(inout)	this,
		logical, intent(in)	overwrite
	)

inherited

Definition at line 75 of file generic_file.f90.

◆ set_start_counter()

procedure generic_file::generic_file_t::set_start_counter	(	class(generic_file_t), intent(inout)	this,
		integer, intent(in)	n
	)

inherited

Definition at line 67 of file generic_file.f90.

◆ write() [1/2]

procedure chkp_file::chkp_file_t::write	(	class(chkp_file_t), intent(inout)	this,
		class(*), intent(in), target	data,
		real(kind=dp), intent(in), optional	t
	)

Parameters

data	Checkpoint data to write.
[optional]	t Simulation time.

Definition at line 112 of file chkp_file.f90.

◆ write() [2/2]

procedure(generic_file_write), deferred generic_file::generic_file_t::write	(	class(generic_file_t), intent(inout)	this,
		class(*), intent(in), target	data,
		real(kind=dp), intent(in), optional	t
	)

pure virtualinherited

Definition at line 53 of file generic_file.f90.

Member Data Documentation

◆ chkp_xh

type(space_t), pointer chkp_file::chkp_file_t::chkp_xh

Definition at line 97 of file chkp_file.f90.

◆ counter

integer, private generic_file::generic_file_t::counter = -1

privateinherited

Definition at line 44 of file generic_file.f90.

◆ fname

character(len=1024), private generic_file::generic_file_t::fname

privateinherited

Definition at line 43 of file generic_file.f90.

◆ global_interp

type(global_interpolation_t) chkp_file::chkp_file_t::global_interp

Definition at line 103 of file chkp_file.f90.

◆ mesh2mesh

logical chkp_file::chkp_file_t::mesh2mesh

Definition at line 105 of file chkp_file.f90.

◆ overwrite

logical generic_file::generic_file_t::overwrite = .false.

inherited

Definition at line 48 of file generic_file.f90.

◆ serial

logical generic_file::generic_file_t::serial = .false.

inherited

Definition at line 47 of file generic_file.f90.

◆ sim_xh

type(space_t), pointer chkp_file::chkp_file_t::sim_xh

Definition at line 99 of file chkp_file.f90.

◆ space_interp

type(interpolator_t) chkp_file::chkp_file_t::space_interp

Definition at line 101 of file chkp_file.f90.

◆ start_counter

integer, private generic_file::generic_file_t::start_counter = 0

privateinherited

Definition at line 45 of file generic_file.f90.

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

/home/runner/work/neko/neko/src/io/chkp_file.f90

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ check_exists()

◆ get_base_fname()

◆ get_counter()

◆ get_fname()

◆ get_next_output_fname() [1/2]

◆ get_next_output_fname() [2/2]

◆ get_start_counter()

◆ increment_counter()

◆ init()

◆ read() [1/2]

◆ read() [2/2]

◆ read_field()

◆ set_counter()

◆ set_overwrite() [1/2]

◆ set_overwrite() [2/2]

◆ set_start_counter()

◆ write() [1/2]

◆ write() [2/2]

Member Data Documentation

◆ chkp_xh

◆ counter

◆ fname

◆ global_interp

◆ mesh2mesh

◆ overwrite

◆ serial

◆ sim_xh

◆ space_interp

◆ start_counter