crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 06:05:58 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

update documentation

Browse source
This commit is contained in:
Gavin Ridley 2023-03-31 23:59:04 -04:00
parent 5aa1d256bb
commit 30ed602009
2 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
include/openmc/mcpl_interface.h
View file

@ -32,11 +32,9 @@ vector<SourceSite> 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<SourceSite> source_bank, vector<int64_t> const& bank_index);
} // namespace openmc

5
include/openmc/state_point.h
View file

@ -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<SourceSite> source_bank,
vector<int64_t> const& bank_index);