swarm_message Module Reference

Swarm-message, a convenient data-container for with build-in serialization. More...

Data Types
interface	swarm_message_add
	Adds an entry from a swarm-message. More...
interface	swarm_message_get
	Returns an entry from a swarm-message. More...
type	swarm_message_type

Functions/Subroutines
logical function, public	swarm_message_haskey (msg, key)
	Checks if a swarm-message contains an entry with the given key.
subroutine, public	swarm_message_free (msg)
	Deallocates all entries contained in a swarm-message.
logical function, public	swarm_message_equal (msg1, msg2)
	Checks if two swarm-messages are equal.
subroutine, public	swarm_message_mpi_send (msg, group, dest, tag)
	Sends a swarm message via MPI.
subroutine, public	swarm_message_mpi_recv (msg, group, src, tag)
	Receives a swarm message via MPI.
subroutine, public	swarm_message_mpi_bcast (msg, src, group)
	Broadcasts a swarm message via MPI.
subroutine, public	swarm_message_file_write (msg, unit)
	Write a swarm-message to a given file / unit.
subroutine, public	swarm_message_file_read (msg, parser, at_end)
	Reads a swarm-message from a given file / unit.

Variables
integer, parameter	key_length = 20

Detailed Description

Swarm-message, a convenient data-container for with build-in serialization.

Author

Ole Schuett

Function/Subroutine Documentation

swarm_message_haskey()

logical function, public swarm_message::swarm_message_haskey	(	type(swarm_message_type), intent(in)	msg,
		character(len=*), intent(in)	key
	)

Checks if a swarm-message contains an entry with the given key.

Parameters

msg	...
key	...

Returns

...

Author

Ole Schuett

Definition at line 109 of file swarm_message.F.

Here is the caller graph for this function:

swarm_message_free()

subroutine, public swarm_message::swarm_message_free

(

type(swarm_message_type), intent(inout)

msg

)

Deallocates all entries contained in a swarm-message.

Parameters

msg

...

Author

Ole Schuett

Definition at line 132 of file swarm_message.F.

Here is the caller graph for this function:

swarm_message_equal()

logical function, public swarm_message::swarm_message_equal	(	type(swarm_message_type), intent(in)	msg1,
		type(swarm_message_type), intent(in)	msg2
	)

Checks if two swarm-messages are equal.

Parameters

msg1	...
msg2	...

Returns

...

Author

Ole Schuett

Definition at line 165 of file swarm_message.F.

Here is the caller graph for this function:

swarm_message_mpi_send()

subroutine, public swarm_message::swarm_message_mpi_send	(	type(swarm_message_type), intent(in)	msg,
		class(mp_comm_type), intent(in)	group,
		integer, intent(in)	dest,
		integer, intent(in)	tag
	)

Sends a swarm message via MPI.

Parameters

msg	...
group	...
dest	...
tag	...

Author

Ole Schuett

Definition at line 182 of file swarm_message.F.

Here is the caller graph for this function:

swarm_message_mpi_recv()

subroutine, public swarm_message::swarm_message_mpi_recv	(	type(swarm_message_type), intent(inout)	msg,
		class(mp_comm_type), intent(in)	group,
		integer, intent(inout)	src,
		integer, intent(inout)	tag
	)

Receives a swarm message via MPI.

Parameters

msg	...
group	...
src	...
tag	...

Author

Ole Schuett

Definition at line 205 of file swarm_message.F.

Here is the caller graph for this function:

swarm_message_mpi_bcast()

subroutine, public swarm_message::swarm_message_mpi_bcast	(	type(swarm_message_type), intent(inout)	msg,
		integer, intent(in)	src,
		class(mp_comm_type), intent(in)	group
	)

Broadcasts a swarm message via MPI.

Parameters

msg	...
src	...
group	...

Author

Ole Schuett

Definition at line 231 of file swarm_message.F.

Here is the caller graph for this function:

swarm_message_file_write()

subroutine, public swarm_message::swarm_message_file_write	(	type(swarm_message_type), intent(in)	msg,
		integer, intent(in)	unit
	)

Write a swarm-message to a given file / unit.

Parameters

msg	...
unit	...

Author

Ole Schuett

Definition at line 269 of file swarm_message.F.

Here is the caller graph for this function:

swarm_message_file_read()

subroutine, public swarm_message::swarm_message_file_read	(	type(swarm_message_type), intent(out)	msg,
		type(cp_parser_type), intent(inout)	parser,
		logical, intent(inout)	at_end
	)

Reads a swarm-message from a given file / unit.

Parameters

msg	...
parser	...
at_end	...

Author

Ole Schuett

Definition at line 300 of file swarm_message.F.

Here is the caller graph for this function:

Variable Documentation

key_length

integer, parameter swarm_message::key_length = 20

Definition at line 34 of file swarm_message.F.