hdf5_file::hdf5_file_t Type Reference

Interface for HDF5 files. More...

Inheritance diagram for hdf5_file::hdf5_file_t:

Collaboration diagram for hdf5_file::hdf5_file_t:

Public Member Functions
procedure	read (this, data)
	Read data in HDF5 format.
procedure	write (this, data, t)
	Write data in HDF5 format.
procedure	set_overwrite (this, overwrite)
	Set the overwrite flag for HDF5 files.
procedure	open (this, mode)
	Open a HDF5 file in a given mode.
procedure	close (this)
	Close the file.
procedure	set_active_group (this, group_name_path)
	Set the active group for HDF5 files.
procedure	set_precision (this, precision)
	Set the precision for the output (single or double)
procedure, pass(this)	write_vector (this, vec)
procedure, pass(this)	write_matrix (this, mat)
procedure, pass(this)	write_field (this, fld)
procedure, pass(this)	write_int_attribute (this, attr_name, attr)
procedure, pass(this)	write_rp_attribute (this, attr_name, attr)
procedure, pass(this)	read_vector (this, data_name, vec, strategy)
procedure, pass(this)	read_matrix (this, data_name, mat, strategy)
procedure, pass(this)	read_int_attribute (this, attr_name, attr, attr_exists)
procedure, pass(this)	read_rp_attribute (this, attr_name, attr, attr_exists)
procedure	write_dataset (this, data)
procedure	read_dataset (this, data_name, data, strategy)
procedure	write_attribute (this, data_name, data)
procedure	read_attribute (this, data_name, data, exist)
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_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
character(len=1)	mode
integer	precision = -1
integer	offset = 0
integer	count = 0
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 60 of file hdf5_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 71 of file generic_file.f90.

close()

procedure hdf5_file::hdf5_file_t::close

(

class(hdf5_file_t), intent(inout)

this

)

Definition at line 80 of file hdf5_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 59 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 63 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_start_counter()

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

inherited

Definition at line 67 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 69 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.

open()

procedure hdf5_file::hdf5_file_t::open	(	class(hdf5_file_t), intent(inout)	this,
		character(len=1), intent(in)	mode
	)

Definition at line 79 of file hdf5_file.F90.

read() [1/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() [2/2]

procedure hdf5_file::hdf5_file_t::read	(	class(hdf5_file_t)	this,
		class(*), intent(inout), target	data
	)

Definition at line 75 of file hdf5_file.F90.

read_attribute()

procedure hdf5_file::hdf5_file_t::read_attribute	(	class(hdf5_file_t), intent(inout)	this,
		character(len=*), intent(in)	data_name,
		class(*), intent(inout)	data,
		logical, intent(inout)	exist
	)

Definition at line 96 of file hdf5_file.F90.

read_dataset()

procedure hdf5_file::hdf5_file_t::read_dataset	(	class(hdf5_file_t), intent(inout)	this,
		character(len=*), intent(in)	data_name,
		class(*), intent(inout)	data,
		character(len=*), intent(in), optional	strategy
	)

Definition at line 94 of file hdf5_file.F90.

read_int_attribute()

procedure, pass(this) hdf5_file::hdf5_file_t::read_int_attribute	(	class(hdf5_file_t), intent(inout)	this,
		character(len=*), intent(in)	attr_name,
		integer, intent(inout)	attr,
		logical, intent(inout)	attr_exists
	)

Definition at line 91 of file hdf5_file.F90.

read_matrix()

procedure, pass(this) hdf5_file::hdf5_file_t::read_matrix	(	class(hdf5_file_t)	this,
		character(len=*), intent(in)	data_name,
		type(matrix_t), intent(inout)	mat,
		character(len=*), intent(in), optional	strategy
	)

Definition at line 90 of file hdf5_file.F90.

read_rp_attribute()

procedure, pass(this) hdf5_file::hdf5_file_t::read_rp_attribute	(	class(hdf5_file_t), intent(inout)	this,
		character(len=*), intent(in)	attr_name,
		real(kind=rp), intent(inout)	attr,
		logical, intent(inout)	attr_exists
	)

Definition at line 92 of file hdf5_file.F90.

read_vector()

procedure, pass(this) hdf5_file::hdf5_file_t::read_vector	(	class(hdf5_file_t)	this,
		character(len=*), intent(in)	data_name,
		type(vector_t), intent(inout)	vec,
		character(len=*), intent(in), optional	strategy
	)

Definition at line 89 of file hdf5_file.F90.

set_active_group()

procedure hdf5_file::hdf5_file_t::set_active_group	(	class(hdf5_file_t), intent(inout)	this,
		character(len=*), intent(in), optional	group_name_path
	)

Definition at line 81 of file hdf5_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 61 of file generic_file.f90.

set_overwrite() [1/2]

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

inherited

Definition at line 73 of file generic_file.f90.

set_overwrite() [2/2]

procedure hdf5_file::hdf5_file_t::set_overwrite	(	class(hdf5_file_t), intent(inout)	this,
		logical, intent(in)	overwrite
	)

Definition at line 77 of file hdf5_file.F90.

set_precision()

procedure hdf5_file::hdf5_file_t::set_precision	(	class(hdf5_file_t), intent(inout)	this,
		integer, intent(in)	precision
	)

Definition at line 82 of file hdf5_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 65 of file generic_file.f90.

write() [1/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=rp), intent(in), optional  t  )

pure virtualinherited

Definition at line 53 of file generic_file.f90.

write() [2/2]

procedure hdf5_file::hdf5_file_t::write	(	class(hdf5_file_t), intent(inout)	this,
		class(*), intent(in), target	data,
		real(kind=rp), intent(in), optional	t
	)

Definition at line 76 of file hdf5_file.F90.

write_attribute()

procedure hdf5_file::hdf5_file_t::write_attribute	(	class(hdf5_file_t), intent(inout)	this,
		character(len=*), intent(in)	data_name,
		class(*), intent(inout)	data
	)

Definition at line 95 of file hdf5_file.F90.

write_dataset()

procedure hdf5_file::hdf5_file_t::write_dataset	(	class(hdf5_file_t), intent(inout)	this,
		class(*), intent(inout)	data
	)

Definition at line 93 of file hdf5_file.F90.

write_field()

procedure, pass(this) hdf5_file::hdf5_file_t::write_field	(	class(hdf5_file_t), intent(inout)	this,
		type(field_t), intent(inout)	fld
	)

Definition at line 85 of file hdf5_file.F90.

write_int_attribute()

procedure, pass(this) hdf5_file::hdf5_file_t::write_int_attribute	(	class(hdf5_file_t), intent(inout)	this,
		character(len=*), intent(in)	attr_name,
		integer, intent(in)	attr
	)

Definition at line 86 of file hdf5_file.F90.

write_matrix()

procedure, pass(this) hdf5_file::hdf5_file_t::write_matrix	(	class(hdf5_file_t), intent(inout)	this,
		type(matrix_t), intent(inout)	mat
	)

Definition at line 84 of file hdf5_file.F90.

write_rp_attribute()

procedure, pass(this) hdf5_file::hdf5_file_t::write_rp_attribute	(	class(hdf5_file_t), intent(inout)	this,
		character(len=*), intent(in)	attr_name,
		real(kind=rp), intent(in)	attr
	)

Definition at line 88 of file hdf5_file.F90.

write_vector()

procedure, pass(this) hdf5_file::hdf5_file_t::write_vector	(	class(hdf5_file_t), intent(inout)	this,
		type(vector_t), intent(inout)	vec
	)

Definition at line 83 of file hdf5_file.F90.

Member Data Documentation

count

integer hdf5_file::hdf5_file_t::count = 0

Definition at line 71 of file hdf5_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.

mode

character(len=1) hdf5_file::hdf5_file_t::mode

Definition at line 68 of file hdf5_file.F90.

offset

integer hdf5_file::hdf5_file_t::offset = 0

Definition at line 70 of file hdf5_file.F90.

overwrite

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

inherited

Definition at line 48 of file generic_file.f90.

precision

integer hdf5_file::hdf5_file_t::precision = -1

Definition at line 69 of file hdf5_file.F90.

serial

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

inherited

Definition at line 47 of file generic_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/hdf5_file.F90