Public Member Functions
procedure, non_overridable, public	set_handle (this, handle)

procedure, non_overridable, public	get_handle (this)

GENERIC, public	operator (file1, file2)

GENERIC, public	operator (file1, file2)

GENERIC, public	write_at mp_file_write_at_ch, mp_file_write_at_chv, mp_file_write_at_i, mp_file_write_at_iv, mp_file_write_at_r, mp_file_write_at_rv, mp_file_write_at_d, mp_file_write_at_dv, mp_file_write_at_c, mp_file_write_at_cv, mp_file_write_at_z, mp_file_write_at_zv, mp_file_write_at_l, mp_file_write_at_lv

GENERIC, public	write_at_all mp_file_write_at_all_ch, mp_file_write_at_all_chv, mp_file_write_at_all_i, mp_file_write_at_all_iv, mp_file_write_at_all_l, mp_file_write_at_all_lv, mp_file_write_at_all_r, mp_file_write_at_all_rv, mp_file_write_at_all_d, mp_file_write_at_all_dv, mp_file_write_at_all_c, mp_file_write_at_all_cv, mp_file_write_at_all_z, mp_file_write_at_all_zv

GENERIC, public	read_at mp_file_read_at_ch, mp_file_read_at_chv, mp_file_read_at_i, mp_file_read_at_iv, mp_file_read_at_r, mp_file_read_at_rv, mp_file_read_at_d, mp_file_read_at_dv, mp_file_read_at_c, mp_file_read_at_cv, mp_file_read_at_z, mp_file_read_at_zv, mp_file_read_at_l, mp_file_read_at_lv

GENERIC, public	read_at_all mp_file_read_at_all_ch, mp_file_read_at_all_chv, mp_file_read_at_all_i, mp_file_read_at_all_iv, mp_file_read_at_all_l, mp_file_read_at_all_lv, mp_file_read_at_all_r, mp_file_read_at_all_rv, mp_file_read_at_all_d, mp_file_read_at_all_dv, mp_file_read_at_all_c, mp_file_read_at_all_cv, mp_file_read_at_all_z, mp_file_read_at_all_zv

procedure, non_overridable, pass, public	open (groupid, fh, filepath, amode_status, info)
	Opens a file.

procedure, non_overridable, pass, public	close (fh)
	Closes a file.

GENERIC, public	assignment (fh_new, fh_old)

procedure, non_overridable, pass, public	get_size (fh, file_size)
	Returns the file size.

procedure, non_overridable, pass, public	get_position (fh, pos)
	Returns the file position.

procedure, non_overridable, pass, public	read_all (fh, msglen, ndims, buffer, type_descriptor)
	(parallel) Collective, blocking read of a character array from a file. File access pattern

procedure, non_overridable, pass, public	write_all (fh, msglen, ndims, buffer, type_descriptor)
	(parallel) Collective, blocking write of a character array to a file. File access pattern

Detailed Description

Definition at line 649 of file message_passing.F.

Member Function/Subroutine Documentation

◆ set_handle()

procedure, non_overridable, public message_passing::mp_file_type::set_handle	(	class(mp_file_type), intent(inout)	this,
		integer, intent(in)	handle
	)

final

Definition at line 653 of file message_passing.F.

◆ get_handle()

procedure, non_overridable, public message_passing::mp_file_type::get_handle ( class(mp_file_type), intent(in) this )

final

Definition at line 654 of file message_passing.F.

◆ operator() [1/2]

GENERIC, public message_passing::mp_file_type::operator	(	class(mp_file_type), intent(in)	file1,
		class(mp_file_type), intent(in)	file2
	)

Definition at line 657 of file message_passing.F.

◆ operator() [2/2]

GENERIC, public message_passing::mp_file_type::operator	(	class(mp_file_type), intent(in)	file1,
		class(mp_file_type), intent(in)	file2
	)

Definition at line 658 of file message_passing.F.

◆ write_at()

GENERIC, public message_passing::mp_file_type::write_at

Definition at line 664 of file message_passing.F.

◆ write_at_all()

GENERIC, public message_passing::mp_file_type::write_at_all

Definition at line 673 of file message_passing.F.

◆ read_at()

GENERIC, public message_passing::mp_file_type::read_at

Definition at line 682 of file message_passing.F.

◆ read_at_all()

GENERIC, public message_passing::mp_file_type::read_at_all

Definition at line 691 of file message_passing.F.

◆ open()

procedure, non_overridable, pass, public message_passing::mp_file_type::open	(	class(mp_comm_type), intent(in)	groupid,
		class(mp_file_type), intent(out)	fh,
		character(len=*), intent(in)	filepath,
		integer, intent(in)	amode_status,
		type(mp_info_type), intent(in), optional	info
	)

final

Opens a file.

Parameters

[in]	groupid	message passing environment identifier
[out]	fh	file handle (file storage unit)
[in]	filepath	path to the file
	amode_status	access mode
	info	...

MPI-I/O mapping mpi_file_open

STREAM-I/O mapping OPEN

Parameters

[in]

optional) info info object

History: 11.2012 created [Hossein Bani-Hashemian]

Definition at line 696 of file message_passing.F.

◆ close()

procedure, non_overridable, pass, public message_passing::mp_file_type::close ( class(mp_file_type), intent(inout) fh )

final

Closes a file.

Parameters

[in] fh file handle (file storage unit)

MPI-I/O mapping mpi_file_close

STREAM-I/O mapping CLOSE

History: 11.2012 created [Hossein Bani-Hashemian]

Definition at line 697 of file message_passing.F.

◆ assignment()

GENERIC, public message_passing::mp_file_type::assignment	(	class(mp_file_type), intent(out)	fh_new,
		class(mp_file_type), intent(in)	fh_old
	)

Definition at line 699 of file message_passing.F.

◆ get_size()

procedure, non_overridable, pass, public message_passing::mp_file_type::get_size	(	class(mp_file_type), intent(in)	fh,
		integer(kind=file_offset), intent(out)	file_size
	)

final

Returns the file size.

Parameters

[in]	fh	file handle (file storage unit)
[out]	file_size	the file size

MPI-I/O mapping mpi_file_get_size

STREAM-I/O mapping INQUIRE

History: 12.2012 created [Hossein Bani-Hashemian]

Definition at line 701 of file message_passing.F.

◆ get_position()

procedure, non_overridable, pass, public message_passing::mp_file_type::get_position	(	class(mp_file_type), intent(in)	fh,
		integer(kind=file_offset), intent(out)	pos
	)

final

Returns the file position.

Parameters

[in]	fh	file handle (file storage unit)
[out]	file_size	the file position

MPI-I/O mapping mpi_file_get_position

STREAM-I/O mapping INQUIRE

History: 11.2017 created [Nico Holmberg]

Definition at line 702 of file message_passing.F.

◆ read_all()

procedure, non_overridable, pass, public message_passing::mp_file_type::read_all	(	class(mp_file_type), intent(in)	fh,
		integer, intent(in)	msglen,
		integer, intent(in)	ndims,
		character(len=msglen), dimension(ndims), intent(inout)	buffer,
		type(mp_file_descriptor_type), intent(in), optional	type_descriptor
	)

final

(parallel) Collective, blocking read of a character array from a file. File access pattern

(serial) Unformatted stream read using explicit offsets

Parameters

fh	the file handle associated with the input file
msglen	the message length of an individual vector component
ndims	the number of vector components
buffer	the buffer where the data is placed
type_descriptor	container for the MPI type

Author: Nico Holmberg [05.2017]

Definition at line 704 of file message_passing.F.

◆ write_all()

procedure, non_overridable, pass, public message_passing::mp_file_type::write_all	(	class(mp_file_type), intent(in)	fh,
		integer, intent(in)	msglen,
		integer, intent(in)	ndims,
		character(len=msglen), dimension(ndims), intent(in)	buffer,
		type(mp_file_descriptor_type), intent(in), optional	type_descriptor
	)

final

(parallel) Collective, blocking write of a character array to a file. File access pattern

(serial) Unformatted stream write using explicit offsets

Parameters

fh	the file handle associated with the output file
msglen	the message length of an individual vector component
ndims	the number of vector components
buffer	the buffer where the data is placed
type_descriptor	container for the MPI type

Author: Nico Holmberg [05.2017]

Definition at line 705 of file message_passing.F.

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

mpiwrap/message_passing.F

Public Member Functions

Detailed Description

Member Function/Subroutine Documentation

◆ set_handle()

◆ get_handle()

◆ operator() [1/2]

◆ operator() [2/2]

◆ write_at()

◆ write_at_all()

◆ read_at()

◆ read_at_all()

◆ open()

◆ close()

◆ assignment()

◆ get_size()

◆ get_position()

◆ read_all()

◆ write_all()