qs_fb_buffer_types::fb_buffer_get Interface Reference

Public Member Functions
subroutine	fb_buffer_i_get (buffer, i_slice, n, data_size, sizes, disps, data_1d, data_2d, data_2d_ld)
	get data from the fb_buffer object
subroutine	fb_buffer_d_get (buffer, i_slice, n, data_size, sizes, disps, data_1d, data_2d, data_2d_ld)
	get data from the fb_buffer object

Detailed Description

Definition at line 112 of file qs_fb_buffer_types.F.

Member Function/Subroutine Documentation

fb_buffer_i_get()

subroutine qs_fb_buffer_types::fb_buffer_get::fb_buffer_i_get	(	type(fb_buffer_i_obj), intent(in)	buffer,
		integer, intent(in), optional	i_slice,
		integer, intent(out), optional	n,
		integer, intent(out), optional	data_size,
		integer, dimension(:), intent(out), optional	sizes,
		integer, dimension(:), intent(out), optional	disps,
		integer, dimension(:), optional, pointer	data_1d,
		integer, dimension(:, :), optional, pointer	data_2d,
		integer, intent(in), optional	data_2d_ld
	)

get data from the fb_buffer object

Parameters

buffer	: fb_buffer object
i_slice	: see data_1d, data_2d
n	: outputs number of slices in data array
data_size	: outputs the total size of stored data
sizes	: outputs sizes of the slices in data array
disps	: outputs displacements in the data array for each slice
data_1d	: if i_slice is present: returns pointer to the section of data array corresponding to i_slice-th slice else: return pointer to the entire non-empty part of the data array
data_2d	: similar to data_1d, but with the 1D data array reshaped to 2D works only with i_slice present
data_2d_ld	: leading dimension for data_2d for slice i_slice

Author

Lianheng Tong (LT) lianh.nosp@m.eng..nosp@m.tong@.nosp@m.kcl..nosp@m.ac.uk

Definition at line 385 of file qs_fb_buffer_types.F.

fb_buffer_d_get()

subroutine qs_fb_buffer_types::fb_buffer_get::fb_buffer_d_get	(	type(fb_buffer_d_obj), intent(in)	buffer,
		integer, intent(in), optional	i_slice,
		integer, intent(out), optional	n,
		integer, intent(out), optional	data_size,
		integer, dimension(:), intent(out), optional	sizes,
		integer, dimension(:), intent(out), optional	disps,
		real(kind=dp), dimension(:), optional, pointer	data_1d,
		real(kind=dp), dimension(:, :), optional, pointer	data_2d,
		integer, intent(in), optional	data_2d_ld
	)

get data from the fb_buffer object

Parameters

buffer	: fb_buffer object
i_slice	: see data_1d, data_2d
n	: outputs number of slices in data array
data_size	: outputs the total size of stored data
sizes	: outputs sizes of the slices in data array
disps	: outputs displacements in the data array for each slice
data_1d	: if i_slice is present: returns pointer to the section of data array corresponding to i_slice-th slice else: return pointer to the entire non-empty part of the data array
data_2d	: similar to data_1d, but with the 1D data array reshaped to 2D works only with i_slice present
data_2d_ld	: leading dimension for data_2d for slice i_slice

Author

Lianheng Tong (LT) lianh.nosp@m.eng..nosp@m.tong@.nosp@m.kcl..nosp@m.ac.uk

Definition at line 703 of file qs_fb_buffer_types.F.

---

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

• qs_fb_buffer_types.F