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

Add documentation of collapse_rate functions

Browse source
This commit is contained in:
Paul Romano 2020-08-04 13:05:56 -05:00
parent fba5f0cb9c
commit b7df2d95e1
3 changed files with 31 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/openmc/nuclide.h
View file

@ -58,6 +58,12 @@ public:
//! from probability tables.
void calculate_urr_xs(int i_temp, Particle& p) const;
//! \brief Calculate reaction rate based on group-wise flux distribution
//
//! \param[in] MT ENDF MT value for desired reaction
//! \param[in] energy Energy group boundaries in [eV]
//! \param[in] flux Flux in each energy group (not normalized per eV)
//! \return Reaction rate
double collapse_rate(int MT, gsl::span<const double> energy, gsl::span<const double> flux) const;
// Data members

9
include/openmc/reaction.h
View file

@ -27,7 +27,14 @@ public:
//! \param[in] temperatures Desired temperatures for cross sections
explicit Reaction(hid_t group, const std::vector<int>& temperatures);
double collapse_rate(gsl::span<const double> energy, gsl::span<const double> flux, const std::vector<double>& grid) const;
//! \brief Calculate reaction rate based on group-wise flux distribution
//
//! \param[in] energy Energy group boundaries in [eV]
//! \param[in] flux Flux in each energy group (not normalized per eV)
//! \param[in] grid Nuclide energy grid
//! \return Reaction rate
double collapse_rate(gsl::span<const double> energy, gsl::span<const double> flux,
const std::vector<double>& grid) const;
//! Cross section at a single temperature
struct TemperatureXS {