Skip to content

Commit 606dddd

Browse files
committed
Update documentation for ChunkInfo and WrittenChunkInfo
1 parent b98b356 commit 606dddd

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

include/openPMD/Chunk.hpp

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@
2727
namespace openPMD
2828
{
2929
/**
30-
* A chunk consists of its offset, its extent
31-
* and the rank from which it was written.
32-
* If not specified explicitly, the rank will be assumed to be 0.
30+
* Represents the meta info around a chunk in a dataset.
31+
*
32+
* A chunk consists of its offset and its extent
3333
*/
3434
struct ChunkInfo
3535
{
@@ -48,6 +48,15 @@ struct ChunkInfo
4848
operator==( ChunkInfo const & other ) const;
4949
};
5050

51+
/**
52+
* Represents the meta info around a chunk that has been written by some
53+
* data producing application.
54+
* Produced by BaseRecordComponent::availableChunk.
55+
*
56+
* Carries along the usual chunk meta info also the rank from which
57+
* it was written.
58+
* If not specified explicitly, the rank will be assumed to be 0.
59+
*/
5160
struct WrittenChunkInfo : ChunkInfo
5261
{
5362
unsigned int mpi_rank = 0; //!< the MPI rank of the writing process

0 commit comments

Comments
 (0)