gkowal/amun-code
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

IO: Improve description of subroutine write_binary_xml().

Browse Source 
Signed-off-by: Grzegorz Kowal <grzegorz@amuncode.org>
This commit is contained in:
Grzegorz Kowal 2023-08-14 13:05:24 -03:00
parent a71a1390ca
commit 47b3b50ae0
1 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
sources/io.F90
View File

@ -2618,19 +2618,26 @@ module io
! subroutine WRITE_BINARY_XML:
! ---------------------------
!
! This subroutine serves the purpose of writing binary data to
! a specified data path and array name, while also performing integrity
! checks using hash functions and storing associated XML metadata.
! This subroutine is designed to write compressed binary data to a specified
! file path and array name. It includes functionality for ensuring data
! integrity through hash functions, as well as storing relevant metadata
! in XML format.
!
! Arguments:
!
! data_path - The file path indicating the location of the stored data.
! array_name - The name of the target array for data reading.
! array_ptr - A pointer intended to hold the read data from the array.
! array_bytes - The allocated size in bytes for the array.
! xml_ptr - A pointer referring to an XML tree containing
! associated metadata.
! status - A flag conveying the status of the subroutine.
! data_path - The file path indicating the location of the stored data.
! array_name - The name of the target array for data reading.
! array_ptr - A pointer intended to hold the read data from the array.
! array_bytes - The allocated size in bytes for the array.
! array_dtype - The data type of the array elements.
! array_dims - The dimensions (shape) of the array.
! digest_id - The method ID used for calculating hashes.
! compressor_id - The method ID used for compression of the array.
! level - The compression level.
! encoder_id - The method ID used for data encoding before compression.
! xml_ptr - A pointer referring to an XML tree containing
! associated metadata.
! status - A flag conveying the status of the subroutine.
!
!===============================================================================
!