From 30ed6020092768b2dd208e5343c399c2eac13d64 Mon Sep 17 00:00:00 2001 From: Gavin Ridley Date: Fri, 31 Mar 2023 23:59:04 -0400 Subject: [PATCH] update documentation --- include/openmc/mcpl_interface.h | 8 +++----- include/openmc/state_point.h | 5 +++++ 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/include/openmc/mcpl_interface.h b/include/openmc/mcpl_interface.h index ec2c7ac35d..1f0c94d6de 100644 --- a/include/openmc/mcpl_interface.h +++ b/include/openmc/mcpl_interface.h @@ -32,11 +32,9 @@ vector mcpl_source_sites(std::string path); //! \param[in] source_bank Vector of SourceSites to write to file for this //! MPI rank //! \param[in] bank_indx Pointer to vector of site index ranges over all -//! MPI ranks, allowed to leave this argument alone -//! or pass a nullptr if not running in MPI mode. -//! The option of passing a nullptr has been left -//! for developers to experiment with serial code -//! before writing the fully MPI-parallel version. +//! MPI ranks. This can be computed by calling +//! calculate_parallel_index_vector on +//! source_bank.size(). void write_mcpl_source_point(const char* filename, gsl::span source_bank, vector const& bank_index); } // namespace openmc diff --git a/include/openmc/state_point.h b/include/openmc/state_point.h index ca4b293eb3..db1ac2edb5 100644 --- a/include/openmc/state_point.h +++ b/include/openmc/state_point.h @@ -28,6 +28,11 @@ void load_state_point(); // This function ends up calling write_source_bank, and is responsible // for opening the file to be written to and controlling whether the // write is done in parallel (if compiled with parallel HDF5). +// +// bank_index is an exclusive parallel scan of the source_bank.size() +// values on each rank, used to create global indexing. This vector +// can be created by calling calculate_parallel_index_vector on +// source_bank.size() if such a vector is not already available. void write_source_point(const char* filename, gsl::span source_bank, vector const& bank_index);