This defines some constants and procedures that are useful to the IO server and clients that call it. By using the contents then the client can guarantee consistency against what the server expects. More...

Data Types
type	data_sizing_description_type

type	definition_description_type

type	field_description_type

Functions/Subroutines
integer function, dimension(5), public	populate_mpi_type_extents ()
	Provides the type extents of the types that we are using in construction of the MPI data type. This is done once for fast look up in the actual construction phase. More...

integer function, public	build_mpi_type_definition_description ()
	Builds the MPI data type for sending data descriptions to registree MONCs. More...

integer function, public	build_mpi_type_field_description ()
	Builds the MPI data type for sending field descriptions to registree MONCs. More...

integer function, public	build_mpi_type_data_sizing_description ()
	Builds the MPI type used for sending to the IO server a description of the data, namely the size of the arrays on this process. More...

subroutine, public	append_mpi_datatype (field_start, field_end, field_array_sizes, data_type, type_extents, prev_data_type, type_index, old_types, offsets, block_counts)
	Appends the MPI datatype details to the block counts, old types and offsets arrays. This will lump together multiple concurrent fields with the same type. More...

integer function, public	get_mpi_datatype_from_internal_representation (type_code)
	Gets the MPI datatype from out internal representation of the field data type (as in the configuration parse module) More...

integer function, public	pack_map_field (buffer, start_offset, map_to_pack)
	Packs a map into the send buffer. More...

integer function, public	pack_array_field (buffer, start_offset, int_array, real_array_1d, real_array_2d, real_array_3d, real_array_4d)
	Packs an array field into the sending buffer. More...

integer function, public	pack_scalar_field (buffer, start_offset, int_value, real_value, single_real_value, double_real_value, string_value, logical_value)
	Packs the data of a scalar field into a buffer. More...

logical function, public	get_data_description_from_name (descriptions, name, field_description)
	Look up the data description that corresponds to a specific field keyed by its name. More...

Variables
integer, parameter, public	command_tag =9

integer, parameter, public	data_tag =10

integer, parameter, public	register_command =1

integer, parameter, public	deregister_command =3

integer, parameter, public	data_command_start =4

integer, parameter, public	inter_io_communication =2
	Field type identifiers. More...

integer, parameter, public	scalar_field_type = 1

integer, parameter, public	array_field_type =2

integer, parameter, public	map_field_type =3
	Field data type identifiers. More...

integer, parameter, public	integer_data_type = 1

integer, parameter, public	boolean_data_type =2

integer, parameter, public	string_data_type =3

integer, parameter, public	float_data_type =4

integer, parameter, public	double_data_type =5

character(len=string_length), parameter, public	local_sizes_key ="local_sizes"

character(len=string_length), parameter, public	local_start_points_key ="local_start_points"

character(len=string_length), parameter, public	local_end_points_key ="local_end_points"

character(len=string_length), parameter, public	number_q_indicies_key ="num_q_indicies"

Detailed Description

This defines some constants and procedures that are useful to the IO server and clients that call it. By using the contents then the client can guarantee consistency against what the server expects.

Function/Subroutine Documentation

◆ append_mpi_datatype()

subroutine, public io_server_client_mod::append_mpi_datatype	(	integer, intent(in)	field_start,
		integer, intent(in)	field_end,
		integer, intent(in)	field_array_sizes,
		integer, intent(in)	data_type,
		integer, dimension(5), intent(in)	type_extents,
		integer, intent(in)	prev_data_type,
		integer, intent(in)	type_index,
		integer, dimension(20), intent(inout)	old_types,
		integer, dimension(20), intent(inout)	offsets,
		integer, dimension(20), intent(inout)	block_counts
	)

Appends the MPI datatype details to the block counts, old types and offsets arrays. This will lump together multiple concurrent fields with the same type.

Parameters

field_start	Number of field that we are starting at to build
field_end	Number of field that we are ending at in this build
field_array_sizes	The extra size that is taken up not just by the data but the fact that some members are arrays (array size)
data_type	IO server representation of the current field data type
type_extents	Array of MPI type extents
prev_data_type	IO server representation of the previous distinct field data type
type_index	The number in the MPI type structure that we are creating here
old_types	Array of MPI types that we use for each member in the structure
offsets	Starting offsets for each MPI type structure element
block_counts	Number of type blocks for each MPI type structure element

Definition at line 184 of file ioclient.F90.

     integer, intent(in) :: field_start, field_end, field_array_sizes, data_type, type_index, prev_data_type, type_extents(5)
     integer, intent(inout) :: old_types(20), offsets(20), block_counts(20)
  
     block_counts(type_index)=(field_end-field_start) + 1 + field_array_sizes
     old_types(type_index)=get_mpi_datatype_from_internal_representation(data_type)
     if (type_index == 1) then
       offsets(1)=0
     else
       offsets(type_index)=offsets(type_index-1)+type_extents(prev_data_type) * block_counts(type_index-1)
     end if    

Here is the call graph for this function:

Here is the caller graph for this function:

◆ build_mpi_type_data_sizing_description()

integer function, public io_server_client_mod::build_mpi_type_data_sizing_description

Builds the MPI type used for sending to the IO server a description of the data, namely the size of the arrays on this process.

Returns: The handle of the MPI type

Definition at line 146 of file ioclient.F90.

     integer :: new_type, ierr, block_counts(3), old_types(3), offsets(3)
     integer(kind=MPI_ADDRESS_KIND) :: num_addr, base_addr
  
     type(data_sizing_description_type) :: basic_type
  
     call mpi_get_address(basic_type, base_addr, ierr)
     old_types(1) = mpi_character
     block_counts(1) = string_length 
     offsets(1)=0
  
     call mpi_get_address(basic_type%dimensions, num_addr, ierr)
     old_types(2) = mpi_int
     block_counts(2) = 1
     offsets(2)=int(num_addr-base_addr)
  
     call mpi_get_address(basic_type%dim_sizes, num_addr, ierr)    
     old_types(3) = mpi_int
     block_counts(3) = 4
     offsets(3)=int(num_addr-base_addr)
  
     call mpi_type_struct(3, block_counts, offsets, old_types, new_type, ierr) 
     call mpi_type_commit(new_type, ierr)
     build_mpi_type_data_sizing_description=new_type

Here is the caller graph for this function:

◆ build_mpi_type_definition_description()

integer function, public io_server_client_mod::build_mpi_type_definition_description

Builds the MPI data type for sending data descriptions to registree MONCs.

Definition at line 75 of file ioclient.F90.

     integer :: new_type, ierr, block_counts(4), old_types(4), offsets(4)
     integer(MPI_ADDRESS_KIND) :: num_addr, base_addr
  
     type(definition_description_type) :: basic_type
  
     call mpi_get_address(basic_type, base_addr, ierr)
     old_types(1) = mpi_character
     block_counts(1) = string_length
     offsets(1)=0
  
     call mpi_get_address(basic_type%send_on_terminate, num_addr, ierr)
     old_types(2) = mpi_logical
     block_counts(2) = 1
     offsets(2)=int(num_addr-base_addr)
  
     call mpi_get_address(basic_type%number_fields, num_addr, ierr)
     old_types(3) = mpi_int
     block_counts(3) = 1
     offsets(3)=int(num_addr-base_addr)
  
     call mpi_get_address(basic_type%frequency, num_addr, ierr)
     old_types(4) = mpi_int
     block_counts(4) = 1
     offsets(4)=int(num_addr-base_addr)
  
     call mpi_type_struct(4, block_counts, offsets, old_types, new_type, ierr) 
     call mpi_type_commit(new_type, ierr)
     build_mpi_type_definition_description=new_type

Here is the caller graph for this function:

◆ build_mpi_type_field_description()

integer function, public io_server_client_mod::build_mpi_type_field_description

Builds the MPI data type for sending field descriptions to registree MONCs.

Definition at line 107 of file ioclient.F90.

     integer :: new_type, ierr, old_types(5), block_counts(5), offsets(5)
     integer(MPI_ADDRESS_KIND) :: num_addr, base_addr
  
     type(field_description_type) :: basic_type
  
     call mpi_get_address(basic_type, base_addr, ierr)    
     old_types(1) = mpi_character
     block_counts(1) = string_length
     offsets(1)=0
  
     call mpi_get_address(basic_type%field_name, num_addr, ierr)    
     old_types(2) = mpi_character
     block_counts(2) = string_length
     offsets(2)=int(num_addr-base_addr)
  
     call mpi_get_address(basic_type%field_type, num_addr, ierr)
     old_types(3) = mpi_int
     block_counts(3) = 1
     offsets(3)=int(num_addr-base_addr)
     
     call mpi_get_address(basic_type%data_type, num_addr, ierr)
     old_types(4) = mpi_int
     block_counts(4) = 1
     offsets(4)=int(num_addr-base_addr)
  
     call mpi_get_address(basic_type%optional, num_addr, ierr)
     old_types(5) = mpi_logical
     block_counts(5) = 1
     offsets(5)=int(num_addr-base_addr)
  
     call mpi_type_struct(5, block_counts, offsets, old_types, new_type, ierr) 
     call mpi_type_commit(new_type, ierr)
     build_mpi_type_field_description=new_type

Here is the caller graph for this function:

◆ get_data_description_from_name()

logical function, public io_server_client_mod::get_data_description_from_name	(	type(data_sizing_description_type), dimension(:), intent(in)	descriptions,
		character(len=*), intent(in)	name,
		type(data_sizing_description_type), intent(out), optional	field_description
	)

Look up the data description that corresponds to a specific field keyed by its name.

Parameters

descriptions	The data descriptions
name	The field name to look up
field_description	The resulting field description if the field is found

Returns: Whether or not the field, based upon its name lookup, was found

Definition at line 354 of file ioclient.F90.

     type(data_sizing_description_type), dimension(:), intent(in) :: descriptions
     type(data_sizing_description_type), intent(out), optional :: field_description
     character(len=*), intent(in) :: name
  
     integer :: i
     do i=1,size(descriptions)
       if (descriptions(i)%field_name == name) then
         if (present(field_description)) field_description=descriptions(i)
         get_data_description_from_name=.true.
         return
       end if
     end do
     get_data_description_from_name=.false.

Here is the caller graph for this function:

◆ get_mpi_datatype_from_internal_representation()

integer function, public io_server_client_mod::get_mpi_datatype_from_internal_representation ( integer, intent(in) type_code )

Gets the MPI datatype from out internal representation of the field data type (as in the configuration parse module)

Parameters

Our	internal type code representation of the data type

Returns: The corresponding MPI data type

Definition at line 202 of file ioclient.F90.

     integer, intent(in) :: type_code
  
     if (type_code==integer_data_type) then
       get_mpi_datatype_from_internal_representation=mpi_int
     else if (type_code==boolean_data_type) then
       get_mpi_datatype_from_internal_representation=mpi_logical
     else if (type_code==string_data_type) then
       get_mpi_datatype_from_internal_representation=mpi_character
     else if (type_code==float_data_type) then
       get_mpi_datatype_from_internal_representation=mpi_real
     else if (type_code==double_data_type) then
       get_mpi_datatype_from_internal_representation=mpi_double_precision
     end if

Here is the caller graph for this function:

◆ pack_array_field()

integer function, public io_server_client_mod::pack_array_field	(	character, dimension(:), intent(inout)	buffer,
		integer, intent(in)	start_offset,
		integer, dimension(:), intent(in), optional	int_array,
		real(kind=default_precision), dimension(:), intent(in), optional	real_array_1d,
		real(kind=default_precision), dimension(:,:), intent(in), optional	real_array_2d,
		real(kind=default_precision), dimension(:,:,:), intent(in), optional	real_array_3d,
		real(kind=default_precision), dimension(:,:,:,:), intent(in), optional	real_array_4d
	)

Packs an array field into the sending buffer.

Parameters

buffer	The buffer to pack the field into
start_offset	The starting offset to write into the buffer
int_value	(Optional) integer array values to pack
real_value	(Optional) default precision real array values to pack

Returns: The next location in the buffer to write to (next start offset)

Definition at line 272 of file ioclient.F90.

     character, dimension(:), intent(inout) :: buffer
     integer, intent(in) :: start_offset
     integer, dimension(:), intent(in), optional :: int_array
     real(kind=default_precision), dimension(:), intent(in), optional :: real_array_1d
     real(kind=default_precision), dimension(:,:), intent(in), optional :: real_array_2d
     real(kind=default_precision), dimension(:,:,:), intent(in), optional :: real_array_3d
     real(kind=default_precision), dimension(:,:,:,:), intent(in), optional :: real_array_4d
  
     integer :: target_end
  
     if (present(int_array)) then
       target_end=start_offset+kind(int_array)*size(int_array)-1    
       buffer(start_offset:target_end) = transfer(int_array, buffer(start_offset:target_end))
     else if (present(real_array_1d)) then
       target_end=start_offset+kind(real_array_1d)*size(real_array_1d)-1    
       buffer(start_offset:target_end) = transfer(real_array_1d, buffer(start_offset:target_end))
     else if (present(real_array_2d)) then
       target_end=start_offset+kind(real_array_2d)*size(real_array_2d)-1    
       buffer(start_offset:target_end) = transfer(real_array_2d, buffer(start_offset:target_end))
     else if (present(real_array_3d)) then
       target_end=start_offset+kind(real_array_3d)*size(real_array_3d)-1    
       buffer(start_offset:target_end) = transfer(real_array_3d, buffer(start_offset:target_end))
     else if (present(real_array_4d)) then
       target_end=start_offset+kind(real_array_4d)*size(real_array_4d)-1    
       buffer(start_offset:target_end) = transfer(real_array_4d, buffer(start_offset:target_end))
     end if
     pack_array_field=target_end+1

Here is the caller graph for this function:

◆ pack_map_field()

integer function, public io_server_client_mod::pack_map_field	(	character, dimension(:), intent(inout)	buffer,
		integer, intent(in)	start_offset,
		type(hashmap_type)	map_to_pack
	)

Packs a map into the send buffer.

Parameters

buffer	The buffer to pack the field into
start_offset	The starting offset to write into the buffer
map_to_pack	The map to pack into the buffer

Returns: The next location in the buffer to write to (next start offset)

Definition at line 223 of file ioclient.F90.

     character, dimension(:), intent(inout) :: buffer
     integer, intent(in) :: start_offset
     type(hashmap_type) :: map_to_pack
  
     integer :: i, target_end, current_offset
     character(len=STRING_LENGTH) :: temp_string
     character(len=STRING_LENGTH), pointer :: sized_raw_character
     class(*), pointer :: raw_data, raw_to_string
     type(iterator_type) :: map_iterator
     type(mapentry_type) :: specific_mapentry
  
     current_offset=start_offset
     map_iterator=c_get_iterator(map_to_pack)
     do while (c_has_next(map_iterator))
       specific_mapentry=c_next_mapentry(map_iterator)
       temp_string=specific_mapentry%key
       target_end=current_offset+string_length-1
       buffer(current_offset:target_end)=transfer(temp_string, buffer(current_offset:target_end))
       current_offset=target_end+1
  
       raw_data=>c_get_generic(specific_mapentry)
       raw_to_string=>raw_data
       select type (raw_data)
       type is(integer)
         temp_string=conv_to_string(raw_data)
       type is(real(4))
         temp_string=conv_to_string(raw_data)
       type is (real(8))
         temp_string=conv_to_string(raw_data)
       type is(logical)
         temp_string=conv_to_string(raw_data)
       type is(character(len=*))
         sized_raw_character=>conv_to_string(raw_to_string, .false., string_length)
         temp_string=sized_raw_character
       end select
       target_end=current_offset+string_length-1
       buffer(current_offset:target_end)=transfer(temp_string, buffer(current_offset:target_end))
       current_offset=target_end+1
     end do
     pack_map_field=current_offset

◆ pack_scalar_field()

integer function, public io_server_client_mod::pack_scalar_field	(	character, dimension(:), intent(inout)	buffer,
		integer, intent(in)	start_offset,
		integer, intent(in), optional	int_value,
		real(kind=default_precision), intent(in), optional	real_value,
		real(kind=single_precision), intent(in), optional	single_real_value,
		real(kind=double_precision), intent(in), optional	double_real_value,
		character(len=*), intent(in), optional	string_value,
		logical, intent(in), optional	logical_value
	)

Packs the data of a scalar field into a buffer.

Parameters

buffer	The buffer to pack the field into
start_offset	The starting offset to write into the buffer
int_value	(Optional) integer scalar value to pack
real_value	(Optional) default precision real scalar value to pack
single_real_value	(Optional) single precision real scalar value to pack
double_real_value	(Optional) double precision real scalar value to pack

Returns: The next location in the buffer to write to (next start offset)

Definition at line 310 of file ioclient.F90.

     character, dimension(:), intent(inout) :: buffer
     integer, intent(in) :: start_offset
     integer, intent(in), optional :: int_value
     real(kind=default_precision), intent(in), optional :: real_value
     real(kind=single_precision), intent(in), optional :: single_real_value
     real(kind=double_precision), intent(in), optional :: double_real_value
     character(len=*), intent(in), optional :: string_value
     logical, intent(in), optional :: logical_value
  
     integer :: target_end
     character(len=STRING_LENGTH) :: string_to_insert
  
     if (present(int_value)) then
       target_end=start_offset+kind(int_value)-1
       buffer(start_offset:target_end) = transfer(int_value, buffer(start_offset:target_end))
     else if (present(real_value)) then
       target_end=start_offset+kind(real_value)-1
       buffer(start_offset:target_end) = transfer(real_value, buffer(start_offset:target_end))
     else if (present(single_real_value)) then
       target_end=start_offset+kind(single_real_value)-1
       buffer(start_offset:target_end) = transfer(single_real_value, buffer(start_offset:target_end))
     else if (present(double_real_value)) then
       target_end=start_offset+kind(double_real_value)-1
       buffer(start_offset:target_end) = transfer(double_real_value, buffer(start_offset:target_end))
     else if (present(string_value)) then
       target_end=start_offset+string_length-1
       string_to_insert=string_value
       buffer(start_offset:target_end) = transfer(string_to_insert, buffer(start_offset:target_end))
     else if (present(logical_value)) then
       target_end=start_offset+kind(logical_value)-1
       buffer(start_offset:target_end) = transfer(logical_value, buffer(start_offset:target_end))
     else 
       target_end=start_offset-1
     end if
     pack_scalar_field=target_end+1

Here is the caller graph for this function:

◆ populate_mpi_type_extents()

integer function, dimension(5), public io_server_client_mod::populate_mpi_type_extents

Provides the type extents of the types that we are using in construction of the MPI data type. This is done once for fast look up in the actual construction phase.

Returns: An array of type extents keyed by the DATA_TYPE constants of the configuration parser module)

Definition at line 59 of file ioclient.F90.

     integer :: populate_mpi_type_extents(5)
  
     integer :: ierr
     integer(kind=MPI_ADDRESS_KIND) :: large_number_extents(5)
     
     call mpi_type_extent(mpi_int, large_number_extents(integer_data_type), ierr)
     call mpi_type_extent(mpi_logical, large_number_extents(boolean_data_type), ierr)
     call mpi_type_extent(mpi_character, large_number_extents(string_data_type), ierr)
     call mpi_type_extent(mpi_real, large_number_extents(float_data_type), ierr)
     call mpi_type_extent(mpi_double_precision, large_number_extents(double_data_type), ierr)
  
     populate_mpi_type_extents=int(large_number_extents)

Here is the caller graph for this function:

Variable Documentation

◆ array_field_type

integer, parameter, public io_server_client_mod::array_field_type =2

Definition at line 38 of file ioclient.F90.

◆ boolean_data_type

integer, parameter, public io_server_client_mod::boolean_data_type =2

Definition at line 40 of file ioclient.F90.

◆ command_tag

integer, parameter, public io_server_client_mod::command_tag =9

Definition at line 34 of file ioclient.F90.

34 integer, parameter :: COMMAND_TAG=9, data_tag=10, register_command=1, deregister_command=3, data_command_start=4, &

35 inter_io_communication=2

◆ data_command_start

integer, parameter, public io_server_client_mod::data_command_start =4

Definition at line 34 of file ioclient.F90.

◆ data_tag

integer, parameter, public io_server_client_mod::data_tag =10

Definition at line 34 of file ioclient.F90.

◆ deregister_command

integer, parameter, public io_server_client_mod::deregister_command =3

Definition at line 34 of file ioclient.F90.

◆ double_data_type

integer, parameter, public io_server_client_mod::double_data_type =5

Definition at line 40 of file ioclient.F90.

◆ float_data_type

integer, parameter, public io_server_client_mod::float_data_type =4

Definition at line 40 of file ioclient.F90.

◆ integer_data_type

integer, parameter, public io_server_client_mod::integer_data_type = 1

Definition at line 40 of file ioclient.F90.

40 integer, parameter :: INTEGER_DATA_TYPE = 1, boolean_data_type=2, string_data_type=3, float_data_type=4, &

41 double_data_type=5

◆ inter_io_communication

integer, parameter, public io_server_client_mod::inter_io_communication =2

Field type identifiers.

Definition at line 34 of file ioclient.F90.

◆ local_end_points_key

character(len=string_length), parameter, public io_server_client_mod::local_end_points_key ="local_end_points"

Definition at line 43 of file ioclient.F90.

◆ local_sizes_key

character(len=string_length), parameter, public io_server_client_mod::local_sizes_key ="local_sizes"

Definition at line 43 of file ioclient.F90.

43 character(len=STRING_LENGTH), parameter :: LOCAL_SIZES_KEY="local_sizes", local_start_points_key="local_start_points", &

44 local_end_points_key="local_end_points", number_q_indicies_key="num_q_indicies"

◆ local_start_points_key

character(len=string_length), parameter, public io_server_client_mod::local_start_points_key ="local_start_points"

Definition at line 43 of file ioclient.F90.

◆ map_field_type

integer, parameter, public io_server_client_mod::map_field_type =3

Field data type identifiers.

Definition at line 38 of file ioclient.F90.

◆ number_q_indicies_key

character(len=string_length), parameter, public io_server_client_mod::number_q_indicies_key ="num_q_indicies"

Definition at line 43 of file ioclient.F90.

◆ register_command

integer, parameter, public io_server_client_mod::register_command =1

Definition at line 34 of file ioclient.F90.

◆ scalar_field_type

integer, parameter, public io_server_client_mod::scalar_field_type = 1

Definition at line 38 of file ioclient.F90.

38 integer, parameter :: SCALAR_FIELD_TYPE = 1, array_field_type=2, map_field_type=3

◆ string_data_type

integer, parameter, public io_server_client_mod::string_data_type =3

Definition at line 40 of file ioclient.F90.

Data Types

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ append_mpi_datatype()

◆ build_mpi_type_data_sizing_description()

◆ build_mpi_type_definition_description()

◆ build_mpi_type_field_description()

◆ get_data_description_from_name()

◆ get_mpi_datatype_from_internal_representation()

◆ pack_array_field()

◆ pack_map_field()

◆ pack_scalar_field()

◆ populate_mpi_type_extents()

Variable Documentation

◆ array_field_type

◆ boolean_data_type

◆ command_tag

◆ data_command_start

◆ data_tag

◆ deregister_command

◆ double_data_type

◆ float_data_type

◆ integer_data_type

◆ inter_io_communication

◆ local_end_points_key

◆ local_sizes_key

◆ local_start_points_key

◆ map_field_type

◆ number_q_indicies_key

◆ register_command

◆ scalar_field_type

◆ string_data_type