From 5daa0ac5862d77b1cedf2991c76fc242f2e64866 Mon Sep 17 00:00:00 2001 From: Wim Haeck Date: Mon, 7 Oct 2024 14:26:30 -0600 Subject: [PATCH 1/2] Changes following review. --- python/src/depletion.python.cpp | 2 +- .../depletion/Test_NDItk_depletion_ReactionMultiplicities.py | 1 + src/NDItk/depletion/Multiplicities/src/verify.hpp | 2 +- src/NDItk/depletion/ReactionMultiplicities/src/ctor.hpp | 2 +- src/NDItk/depletion/ReactionMultiplicities/src/read.hpp | 2 ++ src/NDItk/depletion/ReactionMultiplicities/src/verify.hpp | 1 - .../ReactionMultiplicities/test/ReactionMultiplicities.test.cpp | 1 - 7 files changed, 6 insertions(+), 5 deletions(-) diff --git a/python/src/depletion.python.cpp b/python/src/depletion.python.cpp index dbc5c25..c8c9d11 100644 --- a/python/src/depletion.python.cpp +++ b/python/src/depletion.python.cpp @@ -23,7 +23,7 @@ void wrapDepletion( python::module& module, python::module& viewmodule ) { python::module submodule = module.def_submodule( "depletion", - "Depeltion NDI records and subrecords" + "Depletion NDI records and subrecords" ); depletion::wrapReactionMultiplicityType( submodule, viewmodule ); diff --git a/python/test/depletion/Test_NDItk_depletion_ReactionMultiplicities.py b/python/test/depletion/Test_NDItk_depletion_ReactionMultiplicities.py index ac0ab55..8bd2c3c 100644 --- a/python/test/depletion/Test_NDItk_depletion_ReactionMultiplicities.py +++ b/python/test/depletion/Test_NDItk_depletion_ReactionMultiplicities.py @@ -144,6 +144,7 @@ def verify_chunk_typed( self, chunk ) : # verify the record self.assertEqual( 'rprod_all', chunk.keyword ) + self.assertEqual( ReactionMultiplicityType.All, chunk.type ) self.assertEqual( False, chunk.empty ) self.assertEqual( 12, chunk.size ) diff --git a/src/NDItk/depletion/Multiplicities/src/verify.hpp b/src/NDItk/depletion/Multiplicities/src/verify.hpp index a6eb854..5913823 100644 --- a/src/NDItk/depletion/Multiplicities/src/verify.hpp +++ b/src/NDItk/depletion/Multiplicities/src/verify.hpp @@ -2,7 +2,7 @@ * @brief Verify the cross section data values * * The following verification tests are performed: - * - there are at least three values + * - there are at least two values * - the reaction identifier looks to be an integer * * @param[in] data the data values in the cross section subrecord diff --git a/src/NDItk/depletion/ReactionMultiplicities/src/ctor.hpp b/src/NDItk/depletion/ReactionMultiplicities/src/ctor.hpp index ee67bc2..68e6784 100644 --- a/src/NDItk/depletion/ReactionMultiplicities/src/ctor.hpp +++ b/src/NDItk/depletion/ReactionMultiplicities/src/ctor.hpp @@ -33,7 +33,7 @@ ReactionMultiplicities( ReactionMultiplicityType type, ReactionMultiplicities() : IntegerListRecord( base::Keyword( "rprod" ) ) {} /** - * @brief Default constructor + * @brief Constructor for a multiplicity type */ ReactionMultiplicities( ReactionMultiplicityType type ) : IntegerListRecord( base::Keyword( "rprod", type ) ) {} diff --git a/src/NDItk/depletion/ReactionMultiplicities/src/read.hpp b/src/NDItk/depletion/ReactionMultiplicities/src/read.hpp index 9afd585..971e9eb 100644 --- a/src/NDItk/depletion/ReactionMultiplicities/src/read.hpp +++ b/src/NDItk/depletion/ReactionMultiplicities/src/read.hpp @@ -13,6 +13,7 @@ std::vector< int > data; while ( reactions-- ) { + // read MT number and number of reaction products data.push_back( njoy::tools::disco::FreeFormatInteger::read< int >( iter, end ) ); data.push_back( njoy::tools::disco::FreeFormatInteger::read< int >( iter, end ) ); int number = data.back(); @@ -24,6 +25,7 @@ } else { + // read 2 numbers for each reaction product number *= 2; while ( number-- ) { diff --git a/src/NDItk/depletion/ReactionMultiplicities/src/verify.hpp b/src/NDItk/depletion/ReactionMultiplicities/src/verify.hpp index 5a37db0..fbf0d5c 100644 --- a/src/NDItk/depletion/ReactionMultiplicities/src/verify.hpp +++ b/src/NDItk/depletion/ReactionMultiplicities/src/verify.hpp @@ -3,7 +3,6 @@ * * The following verification tests are performed: * - there is at least one reaction - * - the number of groups for each reaction is the same * * @param[in] reactions the reactions to be verified */ diff --git a/src/NDItk/depletion/ReactionMultiplicities/test/ReactionMultiplicities.test.cpp b/src/NDItk/depletion/ReactionMultiplicities/test/ReactionMultiplicities.test.cpp index c023353..a29051a 100644 --- a/src/NDItk/depletion/ReactionMultiplicities/test/ReactionMultiplicities.test.cpp +++ b/src/NDItk/depletion/ReactionMultiplicities/test/ReactionMultiplicities.test.cpp @@ -214,7 +214,6 @@ void verifyChunk( const ReactionMultiplicities& chunk ) { CHECK( 2 == chunk.reactions()[1].multiplicities()[0] ); CHECK( 1 == chunk.reactions()[1].multiplicities()[1] ); - auto multiplicities = chunk.reaction( 2 ); CHECK( 2 == chunk.reaction( 2 ).identifier() ); CHECK( 2 == chunk.reaction( 2 ).numberReactionProducts() ); CHECK( 1 == chunk.reaction( 2 ).reactionProducts()[0] ); From ed43167dbba4e969ead4bd1a485329a800e78dad Mon Sep 17 00:00:00 2001 From: Wim Haeck Date: Mon, 7 Oct 2024 15:17:58 -0600 Subject: [PATCH 2/2] More changes due to review --- .../FissionNeutronMultiplicity.python.cpp | 3 ++- .../FissionNeutronProduction.python.cpp | 3 ++- .../FissionNeutronSpectrumMatrix.python.cpp | 1 + .../FissionNeutronSpectrumVector.python.cpp | 1 + src/NDItk/MultigroupTable/src/verify.hpp | 16 ++++++++-------- .../ReactionMultiplicities/src/ctor.hpp | 3 +++ .../multigroup/AverageFissionEnergyRelease.hpp | 2 +- src/NDItk/multigroup/CrossSection.hpp | 2 +- src/NDItk/multigroup/EnergyGroupStructure.hpp | 2 +- .../multigroup/FissionNeutronMultiplicity.hpp | 2 +- .../FissionNeutronMultiplicity/src/ctor.hpp | 5 ++++- .../test/FissionNeutronMultiplicity.test.cpp | 2 +- .../multigroup/FissionNeutronProduction.hpp | 2 +- .../FissionNeutronProduction/src/ctor.hpp | 5 ++++- .../multigroup/FissionNeutronSpectrumMatrix.hpp | 2 +- .../FissionNeutronSpectrumMatrix/src/ctor.hpp | 5 ++++- .../FissionNeutronSpectrumMatrix/src/verify.hpp | 1 + .../test/FissionNeutronSpectrumMatrix.test.cpp | 12 +++++++++++- .../multigroup/FissionNeutronSpectrumVector.hpp | 2 +- .../FissionNeutronSpectrumVector/src/ctor.hpp | 5 ++++- src/NDItk/multigroup/FluxWeights.hpp | 2 +- src/NDItk/multigroup/HeatingNumbers.hpp | 2 +- src/NDItk/multigroup/Kerma.hpp | 2 +- src/NDItk/multigroup/LegendreMoment.hpp | 2 +- src/NDItk/multigroup/Metadata.hpp | 2 +- .../multigroup/OutgoingParticleTransportData.hpp | 2 +- src/NDItk/multigroup/OutgoingParticleTypes.hpp | 2 +- src/NDItk/multigroup/ReactionCrossSections.hpp | 3 +-- src/NDItk/multigroup/ScatteringMatrix.hpp | 3 +-- src/NDItk/multigroup/TotalCrossSection.hpp | 2 +- src/NDItk/multigroup/Velocities.hpp | 2 +- 31 files changed, 64 insertions(+), 36 deletions(-) diff --git a/python/src/multigroup/FissionNeutronMultiplicity.python.cpp b/python/src/multigroup/FissionNeutronMultiplicity.python.cpp index 1c9c1b5..0a16004 100644 --- a/python/src/multigroup/FissionNeutronMultiplicity.python.cpp +++ b/python/src/multigroup/FissionNeutronMultiplicity.python.cpp @@ -38,6 +38,7 @@ void wrapFissionNeutronMultiplicity( python::module& module, python::module& ) { "Initialise the record\n\n" "Arguments:\n" " self the record\n" + " type the fission type (prompt, delayed or total)\n" " values the fission neutron multiplicity values" ) .def_property_readonly( @@ -63,7 +64,7 @@ void wrapFissionNeutronMultiplicity( python::module& module, python::module& ) { "record\n\n" "Arguments:\n" " string the string representing the record\n" - " number the fission neutron multiplicity values" + " number the number of groups" ); // add standard record definitions diff --git a/python/src/multigroup/FissionNeutronProduction.python.cpp b/python/src/multigroup/FissionNeutronProduction.python.cpp index e505549..85593f1 100644 --- a/python/src/multigroup/FissionNeutronProduction.python.cpp +++ b/python/src/multigroup/FissionNeutronProduction.python.cpp @@ -38,6 +38,7 @@ void wrapFissionNeutronProduction( python::module& module, python::module& ) { "Initialise the record\n\n" "Arguments:\n" " self the record\n" + " type the fission type (prompt, delayed or total)\n" " values the fission neutron production values" ) .def_property_readonly( @@ -63,7 +64,7 @@ void wrapFissionNeutronProduction( python::module& module, python::module& ) { "record\n\n" "Arguments:\n" " string the string representing the record\n" - " number the fission neutron production values" + " number the number of groups" ); // add standard record definitions diff --git a/python/src/multigroup/FissionNeutronSpectrumMatrix.python.cpp b/python/src/multigroup/FissionNeutronSpectrumMatrix.python.cpp index a59c7ef..df1e1a7 100644 --- a/python/src/multigroup/FissionNeutronSpectrumMatrix.python.cpp +++ b/python/src/multigroup/FissionNeutronSpectrumMatrix.python.cpp @@ -38,6 +38,7 @@ void wrapFissionNeutronSpectrumMatrix( python::module& module, python::module& ) "Initialise the record\n\n" "Arguments:\n" " self the record\n" + " type the fission type (prompt, delayed or total)\n" " values the fission neutron spectrum matrix values" ) .def_property_readonly( diff --git a/python/src/multigroup/FissionNeutronSpectrumVector.python.cpp b/python/src/multigroup/FissionNeutronSpectrumVector.python.cpp index 2076373..e7a8056 100644 --- a/python/src/multigroup/FissionNeutronSpectrumVector.python.cpp +++ b/python/src/multigroup/FissionNeutronSpectrumVector.python.cpp @@ -38,6 +38,7 @@ void wrapFissionNeutronSpectrumVector( python::module& module, python::module& ) "Initialise the record\n\n" "Arguments:\n" " self the record\n" + " type the fission type (prompt, delayed or total)\n" " values the fission neutron spectrum vector values" ) .def_property_readonly( diff --git a/src/NDItk/MultigroupTable/src/verify.hpp b/src/NDItk/MultigroupTable/src/verify.hpp index 16fe7fe..1f1ebd3 100644 --- a/src/NDItk/MultigroupTable/src/verify.hpp +++ b/src/NDItk/MultigroupTable/src/verify.hpp @@ -89,15 +89,15 @@ void verify() { // secondary particles if ( this->metadata().numberOutgoingParticles().has_value() ) { - const auto types = this->metadata().numberOutgoingParticles().value(); - if ( types > 0 ) { + const auto number = this->metadata().numberOutgoingParticles().value(); + if ( number > 0 ) { - if ( ( this->outgoingParticleTypes().numberOutgoingParticles() != types ) || - ( ! this->outgoingParticleTransportData().empty() && this->outgoingParticleTransportData().numberOutgoingParticles() != types ) || - ( this->outgoing_structure_.size() && this->outgoing_structure_.size() != types ) || - ( this->outgoing_production_.size() && this->outgoing_production_.size() != types ) || - ( this->outgoing_heating_.size() && this->outgoing_heating_.size() != types ) || - ( this->outgoing_kerma_.size() && this->outgoing_kerma_.size() != types ) ) { + if ( ( this->outgoingParticleTypes().numberOutgoingParticles() != number ) || + ( ! this->outgoingParticleTransportData().empty() && this->outgoingParticleTransportData().numberOutgoingParticles() != number ) || + ( this->outgoing_structure_.size() && this->outgoing_structure_.size() != number ) || + ( this->outgoing_production_.size() && this->outgoing_production_.size() != number ) || + ( this->outgoing_heating_.size() && this->outgoing_heating_.size() != number ) || + ( this->outgoing_kerma_.size() && this->outgoing_kerma_.size() != number ) ) { Log::error( "Found inconsistent number of outgoing particle types across the table" ); Log::info( "Number of outgoing particles in the metadata: {}", diff --git a/src/NDItk/depletion/ReactionMultiplicities/src/ctor.hpp b/src/NDItk/depletion/ReactionMultiplicities/src/ctor.hpp index 68e6784..6dd8fe1 100644 --- a/src/NDItk/depletion/ReactionMultiplicities/src/ctor.hpp +++ b/src/NDItk/depletion/ReactionMultiplicities/src/ctor.hpp @@ -34,6 +34,8 @@ ReactionMultiplicities() : IntegerListRecord( base::Keyword( "rprod" ) ) {} /** * @brief Constructor for a multiplicity type + * + * @param[in] type the multiplicity type (all, few or rmo) */ ReactionMultiplicities( ReactionMultiplicityType type ) : IntegerListRecord( base::Keyword( "rprod", type ) ) {} @@ -41,6 +43,7 @@ ReactionMultiplicities( ReactionMultiplicityType type ) : /** * @brief Constructor * + * @param[in] type the multiplicity type (all, few or rmo) * @param[in] multiplicities the multiplicity data */ ReactionMultiplicities( std::vector< Multiplicities > multiplicities ) : diff --git a/src/NDItk/multigroup/AverageFissionEnergyRelease.hpp b/src/NDItk/multigroup/AverageFissionEnergyRelease.hpp index 0fc44dc..5837987 100644 --- a/src/NDItk/multigroup/AverageFissionEnergyRelease.hpp +++ b/src/NDItk/multigroup/AverageFissionEnergyRelease.hpp @@ -13,7 +13,7 @@ namespace multigroup { /** * @brief An average fission energy release record for multigroup - * neutron and photon data + * neutron data */ class AverageFissionEnergyRelease : protected base::RealListRecord { diff --git a/src/NDItk/multigroup/CrossSection.hpp b/src/NDItk/multigroup/CrossSection.hpp index 4eb57f4..818f178 100644 --- a/src/NDItk/multigroup/CrossSection.hpp +++ b/src/NDItk/multigroup/CrossSection.hpp @@ -13,7 +13,7 @@ namespace NDItk { namespace multigroup { /** - * @brief A cross section subrecord for multigroup neutron and photon data + * @brief A cross section subrecord for multigroup neutron data */ class CrossSection : protected base::SubListRecord< CrossSection, double > { diff --git a/src/NDItk/multigroup/EnergyGroupStructure.hpp b/src/NDItk/multigroup/EnergyGroupStructure.hpp index df1050c..e830401 100644 --- a/src/NDItk/multigroup/EnergyGroupStructure.hpp +++ b/src/NDItk/multigroup/EnergyGroupStructure.hpp @@ -12,7 +12,7 @@ namespace NDItk { namespace multigroup { /** - * @brief An energy group structure record for multigroup neutron and photon data + * @brief An energy group structure record for multigroup neutron data * * This corresponds to an e_bounds or e_bounds_x record for the primary * energy boundaries or outgoing particle energy boundaries. diff --git a/src/NDItk/multigroup/FissionNeutronMultiplicity.hpp b/src/NDItk/multigroup/FissionNeutronMultiplicity.hpp index 486fdd4..88cdaec 100644 --- a/src/NDItk/multigroup/FissionNeutronMultiplicity.hpp +++ b/src/NDItk/multigroup/FissionNeutronMultiplicity.hpp @@ -13,7 +13,7 @@ namespace NDItk { namespace multigroup { /** - * @brief A fission neutron multiplicity record for multigroup neutron and photon data + * @brief A fission neutron multiplicity record for multigroup neutron data */ class FissionNeutronMultiplicity : protected base::RealListRecord { diff --git a/src/NDItk/multigroup/FissionNeutronMultiplicity/src/ctor.hpp b/src/NDItk/multigroup/FissionNeutronMultiplicity/src/ctor.hpp index ee44caa..1862064 100644 --- a/src/NDItk/multigroup/FissionNeutronMultiplicity/src/ctor.hpp +++ b/src/NDItk/multigroup/FissionNeutronMultiplicity/src/ctor.hpp @@ -4,13 +4,16 @@ FissionNeutronMultiplicity() : RealListRecord( base::Keyword( "nu" ) ) {} /** - * @brief Default constructor + * @brief Constructor for a fission type + * + * @param[in] type the fission type (prompt, delayed or total) */ FissionNeutronMultiplicity( FissionType type ) : RealListRecord( base::Keyword( "nu", type ) ) {} /** * @brief Constructor * + * @param[in] type the fission type (prompt, delayed or total) * @param[in] values the fission neutron multiplicity values */ FissionNeutronMultiplicity( FissionType type, diff --git a/src/NDItk/multigroup/FissionNeutronMultiplicity/test/FissionNeutronMultiplicity.test.cpp b/src/NDItk/multigroup/FissionNeutronMultiplicity/test/FissionNeutronMultiplicity.test.cpp index 11c5dbe..c3c927c 100644 --- a/src/NDItk/multigroup/FissionNeutronMultiplicity/test/FissionNeutronMultiplicity.test.cpp +++ b/src/NDItk/multigroup/FissionNeutronMultiplicity/test/FissionNeutronMultiplicity.test.cpp @@ -72,7 +72,7 @@ SCENARIO( "FissionNeutronMultiplicity" ) { GIVEN( "invalid data for a FissionNeutronMultiplicity instance" ) { - WHEN( "the number of weight values is insufficient" ) { + WHEN( "the number of multiplicity values is insufficient" ) { THEN( "an exception is thrown" ) { diff --git a/src/NDItk/multigroup/FissionNeutronProduction.hpp b/src/NDItk/multigroup/FissionNeutronProduction.hpp index bd04e4b..7b1b448 100644 --- a/src/NDItk/multigroup/FissionNeutronProduction.hpp +++ b/src/NDItk/multigroup/FissionNeutronProduction.hpp @@ -13,7 +13,7 @@ namespace NDItk { namespace multigroup { /** - * @brief A fission neutron production record for multigroup neutron and photon data + * @brief A fission neutron production record for multigroup neutron data */ class FissionNeutronProduction : protected base::RealListRecord { diff --git a/src/NDItk/multigroup/FissionNeutronProduction/src/ctor.hpp b/src/NDItk/multigroup/FissionNeutronProduction/src/ctor.hpp index aae29bd..e51b66d 100644 --- a/src/NDItk/multigroup/FissionNeutronProduction/src/ctor.hpp +++ b/src/NDItk/multigroup/FissionNeutronProduction/src/ctor.hpp @@ -4,13 +4,16 @@ FissionNeutronProduction() : RealListRecord( base::Keyword( "nu_sig_f" ) ) {} /** - * @brief Default constructor + * @brief Constructor for a fission type + * + * @param[in] type the fission type (prompt, delayed or total) */ FissionNeutronProduction( FissionType type ) : RealListRecord( base::Keyword( "nu_sig_f", type ) ) {} /** * @brief Constructor * + * @param[in] type the fission type (prompt, delayed or total) * @param[in] values the fission neutron production values */ FissionNeutronProduction( FissionType type, diff --git a/src/NDItk/multigroup/FissionNeutronSpectrumMatrix.hpp b/src/NDItk/multigroup/FissionNeutronSpectrumMatrix.hpp index 97f8e8b..e1929ea 100644 --- a/src/NDItk/multigroup/FissionNeutronSpectrumMatrix.hpp +++ b/src/NDItk/multigroup/FissionNeutronSpectrumMatrix.hpp @@ -14,7 +14,7 @@ namespace NDItk { namespace multigroup { /** - * @brief A fission neutron spectrum matrix record for multigroup neutron and photon data + * @brief A fission neutron spectrum matrix record for multigroup neutron data */ class FissionNeutronSpectrumMatrix : protected base::RealListRecord { diff --git a/src/NDItk/multigroup/FissionNeutronSpectrumMatrix/src/ctor.hpp b/src/NDItk/multigroup/FissionNeutronSpectrumMatrix/src/ctor.hpp index e3400d0..bbac2ae 100644 --- a/src/NDItk/multigroup/FissionNeutronSpectrumMatrix/src/ctor.hpp +++ b/src/NDItk/multigroup/FissionNeutronSpectrumMatrix/src/ctor.hpp @@ -4,13 +4,16 @@ FissionNeutronSpectrumMatrix() : RealListRecord( base::Keyword( "chi_mat" ) ) {} /** - * @brief Default constructor + * @brief Constructor for a fission type + * + * @param[in] type the fission type (prompt, delayed or total) */ FissionNeutronSpectrumMatrix( FissionType type ) : RealListRecord( base::Keyword( "chi_mat", type ) ) {} /** * @brief Constructor * + * @param[in] type the fission type (prompt, delayed or total) * @param[in] values the fission neutron spectrum matrix values */ FissionNeutronSpectrumMatrix( FissionType type, diff --git a/src/NDItk/multigroup/FissionNeutronSpectrumMatrix/src/verify.hpp b/src/NDItk/multigroup/FissionNeutronSpectrumMatrix/src/verify.hpp index 517ebe1..0d3c7c8 100644 --- a/src/NDItk/multigroup/FissionNeutronSpectrumMatrix/src/verify.hpp +++ b/src/NDItk/multigroup/FissionNeutronSpectrumMatrix/src/verify.hpp @@ -3,6 +3,7 @@ * * The following verification tests are performed: * - there is at least one value + * - verify matrix size * * @param[in] values the production values to be verified */ diff --git a/src/NDItk/multigroup/FissionNeutronSpectrumMatrix/test/FissionNeutronSpectrumMatrix.test.cpp b/src/NDItk/multigroup/FissionNeutronSpectrumMatrix/test/FissionNeutronSpectrumMatrix.test.cpp index a425658..02bae8b 100644 --- a/src/NDItk/multigroup/FissionNeutronSpectrumMatrix/test/FissionNeutronSpectrumMatrix.test.cpp +++ b/src/NDItk/multigroup/FissionNeutronSpectrumMatrix/test/FissionNeutronSpectrumMatrix.test.cpp @@ -78,7 +78,7 @@ SCENARIO( "FissionNeutronSpectrumMatrix" ) { GIVEN( "invalid data for a FissionNeutronSpectrumMatrix instance" ) { - WHEN( "the number of weight values is insufficient" ) { + WHEN( "the number of matrix values is insufficient" ) { THEN( "an exception is thrown" ) { @@ -88,6 +88,16 @@ SCENARIO( "FissionNeutronSpectrumMatrix" ) { } // THEN } // WHEN + WHEN( "the matrix is not square" ) { + + THEN( "an exception is thrown" ) { + + std::vector< double > three = { 1., 2., 3. }; + + CHECK_THROWS( FissionNeutronSpectrumMatrix( FissionType::Prompt, std::move( three ) ) ); + } // THEN + } // WHEN + WHEN( "reading the data of the record and the number of " "values is insufficient" ) { diff --git a/src/NDItk/multigroup/FissionNeutronSpectrumVector.hpp b/src/NDItk/multigroup/FissionNeutronSpectrumVector.hpp index cc14c80..ce4eefa 100644 --- a/src/NDItk/multigroup/FissionNeutronSpectrumVector.hpp +++ b/src/NDItk/multigroup/FissionNeutronSpectrumVector.hpp @@ -13,7 +13,7 @@ namespace NDItk { namespace multigroup { /** - * @brief A fission neutron spectrum vector record for multigroup neutron and photon data + * @brief A fission neutron spectrum vector record for multigroup neutron data */ class FissionNeutronSpectrumVector : protected base::RealListRecord { diff --git a/src/NDItk/multigroup/FissionNeutronSpectrumVector/src/ctor.hpp b/src/NDItk/multigroup/FissionNeutronSpectrumVector/src/ctor.hpp index 0cfb85c..ebe6def 100644 --- a/src/NDItk/multigroup/FissionNeutronSpectrumVector/src/ctor.hpp +++ b/src/NDItk/multigroup/FissionNeutronSpectrumVector/src/ctor.hpp @@ -4,13 +4,16 @@ FissionNeutronSpectrumVector() : RealListRecord( base::Keyword( "chi_vec" ) ) {} /** - * @brief Default constructor + * @brief Constructor for a fission type + * + * @param[in] type the fission type (prompt, delayed or total) */ FissionNeutronSpectrumVector( FissionType type ) : RealListRecord( base::Keyword( "chi_vec", type ) ) {} /** * @brief Constructor * + * @param[in] type the fission type (prompt, delayed or total) * @param[in] values the fission neutron spectrum vector values */ FissionNeutronSpectrumVector( FissionType type, diff --git a/src/NDItk/multigroup/FluxWeights.hpp b/src/NDItk/multigroup/FluxWeights.hpp index 1798faf..dc28ba9 100644 --- a/src/NDItk/multigroup/FluxWeights.hpp +++ b/src/NDItk/multigroup/FluxWeights.hpp @@ -12,7 +12,7 @@ namespace NDItk { namespace multigroup { /** - * @brief A flux weight record for multigroup neutron and photon data + * @brief A flux weight record for multigroup neutron data */ class FluxWeights : protected base::RealListRecord { diff --git a/src/NDItk/multigroup/HeatingNumbers.hpp b/src/NDItk/multigroup/HeatingNumbers.hpp index cc766e4..098f7bb 100644 --- a/src/NDItk/multigroup/HeatingNumbers.hpp +++ b/src/NDItk/multigroup/HeatingNumbers.hpp @@ -12,7 +12,7 @@ namespace NDItk { namespace multigroup { /** - * @brief A heating numbers record for multigroup neutron and photon data + * @brief A heating numbers record for multigroup neutron data */ class HeatingNumbers : protected base::RealListRecord { diff --git a/src/NDItk/multigroup/Kerma.hpp b/src/NDItk/multigroup/Kerma.hpp index 75277f0..05cbd20 100644 --- a/src/NDItk/multigroup/Kerma.hpp +++ b/src/NDItk/multigroup/Kerma.hpp @@ -12,7 +12,7 @@ namespace NDItk { namespace multigroup { /** - * @brief A kerma record for multigroup neutron and photon data + * @brief A kerma record for multigroup neutron data */ class Kerma : protected base::RealListRecord { diff --git a/src/NDItk/multigroup/LegendreMoment.hpp b/src/NDItk/multigroup/LegendreMoment.hpp index 7146d89..5c0139d 100644 --- a/src/NDItk/multigroup/LegendreMoment.hpp +++ b/src/NDItk/multigroup/LegendreMoment.hpp @@ -14,7 +14,7 @@ namespace NDItk { namespace multigroup { /** - * @brief A Legendre moment subrecord for multigroup neutron and photon data + * @brief A Legendre moment subrecord for multigroup neutron data */ class LegendreMoment : protected base::SubListRecord< LegendreMoment, double > { diff --git a/src/NDItk/multigroup/Metadata.hpp b/src/NDItk/multigroup/Metadata.hpp index 0561dc1..ad5ea29 100644 --- a/src/NDItk/multigroup/Metadata.hpp +++ b/src/NDItk/multigroup/Metadata.hpp @@ -16,7 +16,7 @@ namespace NDItk { namespace multigroup { /** - * @brief Metadata associated with multigroup neutron and photon data + * @brief Metadata associated with multigroup neutron data */ class Metadata { diff --git a/src/NDItk/multigroup/OutgoingParticleTransportData.hpp b/src/NDItk/multigroup/OutgoingParticleTransportData.hpp index 08ed2ea..71a3065 100644 --- a/src/NDItk/multigroup/OutgoingParticleTransportData.hpp +++ b/src/NDItk/multigroup/OutgoingParticleTransportData.hpp @@ -12,7 +12,7 @@ namespace NDItk { namespace multigroup { /** - * @brief An outgoing particle type record for multigroup neutron and photon data + * @brief An outgoing particle type record for multigroup neutron data */ class OutgoingParticleTransportData : protected base::StringListRecord { diff --git a/src/NDItk/multigroup/OutgoingParticleTypes.hpp b/src/NDItk/multigroup/OutgoingParticleTypes.hpp index 17b02b3..75f11d6 100644 --- a/src/NDItk/multigroup/OutgoingParticleTypes.hpp +++ b/src/NDItk/multigroup/OutgoingParticleTypes.hpp @@ -12,7 +12,7 @@ namespace NDItk { namespace multigroup { /** - * @brief An outgoing particle type record for multigroup neutron and photon data + * @brief An outgoing particle type record for multigroup neutron data */ class OutgoingParticleTypes : protected base::IntegerListRecord { diff --git a/src/NDItk/multigroup/ReactionCrossSections.hpp b/src/NDItk/multigroup/ReactionCrossSections.hpp index f0af0a7..2ef7c61 100644 --- a/src/NDItk/multigroup/ReactionCrossSections.hpp +++ b/src/NDItk/multigroup/ReactionCrossSections.hpp @@ -15,8 +15,7 @@ namespace NDItk { namespace multigroup { /** - * @brief A reaction cross section record for multigroup neutron and photon - * data + * @brief A reaction cross section record for multigroup neutron data */ class ReactionCrossSections : protected base::RealListRecord { diff --git a/src/NDItk/multigroup/ScatteringMatrix.hpp b/src/NDItk/multigroup/ScatteringMatrix.hpp index ee1ad9c..766cdbf 100644 --- a/src/NDItk/multigroup/ScatteringMatrix.hpp +++ b/src/NDItk/multigroup/ScatteringMatrix.hpp @@ -15,8 +15,7 @@ namespace NDItk { namespace multigroup { /** - * @brief A scattering matrix record for multigroup neutron and photon - * data + * @brief A scattering matrix record for multigroup neutron data */ class ScatteringMatrix : protected base::RealListRecord { diff --git a/src/NDItk/multigroup/TotalCrossSection.hpp b/src/NDItk/multigroup/TotalCrossSection.hpp index bf5585b..ab0a428 100644 --- a/src/NDItk/multigroup/TotalCrossSection.hpp +++ b/src/NDItk/multigroup/TotalCrossSection.hpp @@ -12,7 +12,7 @@ namespace NDItk { namespace multigroup { /** - * @brief A total cross section record for multigroup neutron and photon data + * @brief A total cross section record for multigroup neutron data */ class TotalCrossSection : protected base::RealListRecord { diff --git a/src/NDItk/multigroup/Velocities.hpp b/src/NDItk/multigroup/Velocities.hpp index a8c42f0..90a340d 100644 --- a/src/NDItk/multigroup/Velocities.hpp +++ b/src/NDItk/multigroup/Velocities.hpp @@ -12,7 +12,7 @@ namespace NDItk { namespace multigroup { /** - * @brief A velocity record for multigroup neutron and photon data + * @brief A velocity record for multigroup neutron data */ class Velocities : protected base::RealListRecord {