musica_map::pair_t Interface Reference

Matched pair. More...

Public Member Functions
procedure	pack_size (this, comm)
	Returns the size of a binary buffer required to pack the pair.
procedure	mpi_pack (this, buffer, position, comm)
	Packs the pair onto a characcter buffer.
procedure	mpi_unpack (this, buffer, position, comm)
	Unpacks a pair from a character buffer.
type(pair_t) function	pair_constructor (config, from_labels, to_labels)
	Constructor of pair_t objects.

Public Attributes
integer	to_index_
	Index in destination array.
real(kind=dk)	scale_factor_ = 1.0
	Scaling factor applied to source data.

Private Attributes
integer	from_index_
	Index in source array.

Detailed Description

Matched pair.

Constructor of pair_t objects.

Member Function/Subroutine Documentation

mpi_pack()

procedure musica_map::pair_t::mpi_pack	(	class(pair_t), intent(in)	this,
		character, dimension(:), intent(inout)	buffer,
		integer, intent(inout)	position,
		integer, intent(in)	comm )

Packs the pair onto a characcter buffer.

Parameters

[in]	this	Pair to pack
[in,out]	buffer	Memory buffer
[in,out]	position	Current buffer position
[in]	comm	MPI communicator

mpi_unpack()

procedure musica_map::pair_t::mpi_unpack	(	class(pair_t), intent(out)	this,
		character, dimension(:), intent(inout)	buffer,
		integer, intent(inout)	position,
		integer, intent(in)	comm )

Unpacks a pair from a character buffer.

Parameters

[out]	this	Pair to unpack
[in,out]	buffer	Memory buffer
[in,out]	position	Current buffer position
[in]	comm	MPI communicator

pack_size()

procedure musica_map::pair_t::pack_size	(	class(pair_t), intent(in)	this,
		integer, intent(in)	comm )

Returns the size of a binary buffer required to pack the pair.

Parameters

[in]	this	Pair to pack
[in]	comm	MPI communicator

pair_constructor()

type(pair_t) function musica_map::pair_t::pair_constructor	(	type(config_t), intent(inout)	config,
		type(string_t), dimension(:), intent(in)	from_labels,
		type(string_t), dimension(:), intent(in)	to_labels )

Constructor of pair_t objects.

Parameters

[in,out]	config	Matched pair configuration
[in]	from_labels	Source array element labels
[in]	to_labels	Destination array element labels

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/tuv-x/checkouts/latest/src/util/map.F90