hdf5_read Interface Reference

Detailed Description

Read data from an HDF5 file.

Public Member Functions
subroutine	hdf5_read_1d_i4 (array, filename, path, success)
	integer(i8) 1D array implementation of oft_io::hdf5_write
subroutine	hdf5_read_1d_r8 (array, filename, path, success)
	real(r8) 1D array implementation of oft_io::hdf5_write
subroutine	hdf5_read_2d_i4 (array, filename, path, success)
	integer(i4) 2D array implementation of oft_io::hdf5_write
subroutine	hdf5_read_2d_r8 (array, filename, path, success)
	real(r8) 2D array implementation of oft_io::hdf5_write
subroutine	hdf5_read_rst (rst_info, filename, path, success)
	FE vector implementation of oft_io::hdf5_write.
subroutine	hdf5_read_scalar_i4 (val, filename, path, success)
	integer(i4) scalar implementation of oft_io::hdf5_read
subroutine	hdf5_read_scalar_r8 (val, filename, path, success)
	real(r8) scalar implementation of oft_io::hdf5_read

Member Function/Subroutine Documentation

hdf5_read_1d_i4()

subroutine hdf5_read_1d_i4	(	integer(i4), dimension(:), intent(inout)	array,
		character(len=*), intent(in)	filename,
		character(len=*), intent(in)	path,
		logical, intent(out), optional	success
	)

integer(i8) 1D array implementation of oft_io::hdf5_write

Parameters

[in,out]	array	Values to read from file
[in]	filename	Path to file
[in]	path	Variable path in file
[out]	success	Successful read?

hdf5_read_1d_r8()

subroutine hdf5_read_1d_r8	(	real(r8), dimension(:), intent(inout)	array,
		character(len=*), intent(in)	filename,
		character(len=*), intent(in)	path,
		logical, intent(out), optional	success
	)

real(r8) 1D array implementation of oft_io::hdf5_write

Parameters

[in,out]	array	Values to read from file
[in]	filename	Path to file
[in]	path	Variable path in file
[out]	success	Successful read?

hdf5_read_2d_i4()

subroutine hdf5_read_2d_i4	(	integer(i4), dimension(:,:), intent(inout)	array,
		character(len=*), intent(in)	filename,
		character(len=*), intent(in)	path,
		logical, intent(out), optional	success
	)

integer(i4) 2D array implementation of oft_io::hdf5_write

Parameters

[in,out]	array	Values to read from file
[in]	filename	Path to file
[in]	path	Variable path in file
[out]	success	Successful read?

hdf5_read_2d_r8()

subroutine hdf5_read_2d_r8	(	real(r8), dimension(:,:), intent(inout)	array,
		character(len=*), intent(in)	filename,
		character(len=*), intent(in)	path,
		logical, intent(out), optional	success
	)

real(r8) 2D array implementation of oft_io::hdf5_write

Parameters

[in,out]	array	Values to read from file
[in]	filename	Path to file
[in]	path	Variable path in file
[out]	success	Successful read?

hdf5_read_rst()

subroutine hdf5_read_rst	(	type(hdf5_rst), intent(inout)	rst_info,
		character(*), intent(in)	filename,
		character(*), intent(in)	path,
		logical, intent(out), optional	success
	)

FE vector implementation of oft_io::hdf5_write.

Parameters

[in,out]	rst_info	Restart data (structure containing mapping and data holder)
[in]	filename	Path to file
[in]	path	Variable path in file
[out]	success	Successful read?

hdf5_read_scalar_i4()

subroutine hdf5_read_scalar_i4	(	integer(i4), intent(out)	val,
		character(len=*), intent(in)	filename,
		character(len=*), intent(in)	path,
		logical, intent(out), optional	success
	)

integer(i4) scalar implementation of oft_io::hdf5_read

Parameters

[out]	val	Value to read from file
[in]	filename	Path to file
[in]	path	Variable path in file
[out]	success	Successful read?

hdf5_read_scalar_r8()

subroutine hdf5_read_scalar_r8	(	real(r8), intent(out)	val,
		character(len=*), intent(in)	filename,
		character(len=*), intent(in)	path,
		logical, intent(out), optional	success
	)

real(r8) scalar implementation of oft_io::hdf5_read

Parameters

[out]	val	Value to read from file
[in]	filename	Path to file
[in]	path	Variable path in file
[out]	success	Successful read?

---

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

• /home/runner/work/OpenFUSIONToolkit/OpenFUSIONToolkit/src/base/oft_io.F90