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

Fix spacing, Doxygen comments

Browse source
This commit is contained in:
Paul Romano 2018-08-07 10:27:17 -05:00
parent f7eeb074b9
commit f152ca8948
3 changed files with 19 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

26
src/particle.h
View file

@ -1,8 +1,8 @@
#ifndef PARTICLE_H
#define PARTICLE_H
#ifndef OPENMC_PARTICLE_H
#define OPENMC_PARTICLE_H
//! @file particle.h
//! @brief Particle type
//! \file particle.h
//! \brief Particle type
#include <cstdint>
#include <array>
@ -114,10 +114,10 @@ extern "C" {
//
//! stores the current phase space attributes of the particle in the
//! secondary bank and increments the number of sites in the secondary bank.
//! @param uvw Direction of the secondary particle
//! @param E Energy of the secondary particle in [eV]
//! @param type Particle type
//! @param run_CE Whether continuous-energy data is being used
//! \param uvw Direction of the secondary particle
//! \param E Energy of the secondary particle in [eV]
//! \param type Particle type
//! \param run_CE Whether continuous-energy data is being used
void create_secondary(const double* uvw, double E, int type, bool run_CE);
//! sets default attributes for a particle
@ -128,13 +128,13 @@ extern "C" {
//! initializes a particle from data stored in a source site. The source
//! site may have been produced from an external source, from fission, or
//! simply as a secondary particle.
//! @param src Source site data
//! @param run_CE Whether continuous-energy data is being used
//! @param energy_bin_avg An array of energy group bin averages
//! \param src Source site data
//! \param run_CE Whether continuous-energy data is being used
//! \param energy_bin_avg An array of energy group bin averages
void from_source(const Bank* src, bool run_CE, const double* energy_bin_avg);
//! mark a particle as lost and create a particle restart file
//! @param message A warning message to display
//! \param message A warning message to display
void mark_as_lost(const char* message);
//! create a particle restart HDF5 file
@ -160,4 +160,4 @@ extern "C" {
} // namespace openmc
#endif // PARTICLE_H
#endif // OPENMC_PARTICLE_H

6
src/settings.h
View file

@ -1,8 +1,8 @@
#ifndef OPENMC_SETTINGS_H
#define OPENMC_SETTINGS_H
//! @file settings.h
//! @brief Settings for OpenMC
//! \file settings.h
//! \brief Settings for OpenMC
#include <string>
@ -33,7 +33,7 @@ extern std::string path_source;
//==============================================================================
//! Read settings from XML file
//! @param[in] root XML node for <settings>
//! \param[in] root XML node for <settings>
//==============================================================================
extern "C" void read_settings(pugi::xml_node* root);

6
src/string_utils.h
View file

@ -1,5 +1,5 @@
#ifndef OPENMC_STRING_UTILS_H
#define OPNEMC_STRING_UTILS_H
#define OPENMC_STRING_UTILS_H
#include <algorithm>
#include <string>
@ -34,8 +34,8 @@ split(const std::string& in)
inline bool
ends_with(const std::string& value, const std::string& ending)
{
if (ending.size() > value.size()) return false;
return std::equal(ending.rbegin(), ending.rend(), value.rbegin());
if (ending.size() > value.size()) return false;
return std::equal(ending.rbegin(), ending.rend(), value.rbegin());
}
} // namespace openmc