Feature/multigroup part10

.clang-format

@@ -0,0 +1,18 @@
+---
+BasedOnStyle: LLVM
+AlwaysBreakTemplateDeclarations: Yes
+BreakBeforeBraces: Custom
+BraceWrapping:
+  BeforeElse: true
+ColumnLimit: 100
+EmptyLineAfterAccessModifier: Always
+IndentCaseLabels: true
+IndentPPDirectives: BeforeHash
+InsertBraces: true
+PointerAlignment: Left
+SpacesInAngles: Always
+SpacesInParens: Custom
+SpacesInParensOptions:
+  InConditionalStatements: true
+  Other: true
+

.github/workflows/ContinuousIntegration.yml

@@ -16,8 +16,8 @@ jobs:
     runs-on: ${{matrix.os}}
     strategy:
       matrix:
-        os: [ ubuntu-20.04, macos-11 ]
-        cxx: [ clang++, g++-10 ]
+        os: [ ubuntu-22.04, macos-12 ]
+        cxx: [ clang++, g++-12 ]
         build_type: [ Debug, Release ]
 
     steps:

CMakeLists.txt

@@ -107,6 +107,10 @@ if( NDItk.python )
       python/src/multigroup/ReactionCrossSections.python.cpp
       python/src/multigroup/TotalCrossSection.python.cpp
       python/src/multigroup/AverageFissionEnergyRelease.python.cpp
+      python/src/multigroup/FissionNeutronMultiplicity.python.cpp
+      python/src/multigroup/FissionNeutronProduction.python.cpp
+      python/src/multigroup/FissionNeutronSpectrumVector.python.cpp
+      python/src/multigroup/FissionNeutronSpectrumMatrix.python.cpp
       python/src/multigroup/Velocities.python.cpp
       python/src/multigroup/HeatingNumbers.python.cpp
       python/src/multigroup/Kerma.python.cpp

cmake/unit_testing.cmake

@@ -48,6 +48,10 @@ add_subdirectory( src/NDItk/multigroup/AverageFissionEnergyRelease/test )
 add_subdirectory( src/NDItk/multigroup/Velocities/test )
 add_subdirectory( src/NDItk/multigroup/HeatingNumbers/test )
 add_subdirectory( src/NDItk/multigroup/Kerma/test )
+add_subdirectory( src/NDItk/multigroup/FissionNeutronMultiplicity/test )
+add_subdirectory( src/NDItk/multigroup/FissionNeutronProduction/test )
+add_subdirectory( src/NDItk/multigroup/FissionNeutronSpectrumMatrix/test )
+add_subdirectory( src/NDItk/multigroup/FissionNeutronSpectrumVector/test )
 add_subdirectory( src/NDItk/multigroup/OutgoingParticleTypes/test )
 add_subdirectory( src/NDItk/multigroup/OutgoingParticleTransportData/test )
 add_subdirectory( src/NDItk/multigroup/LegendreMoment/test )

cmake/unit_testing_python.cmake

@@ -32,6 +32,10 @@ add_python_test( multigroup.EnergyGroupStructure          multigroup/Test_NDItk_
 add_python_test( multigroup.ReactionCrossSections         multigroup/Test_NDItk_multigroup_ReactionCrossSections.py )
 add_python_test( multigroup.TotalCrossSection             multigroup/Test_NDItk_multigroup_TotalCrossSection.py )
 add_python_test( multigroup.AverageFissionEnergyRelease   multigroup/Test_NDItk_multigroup_AverageFissionEnergyRelease.py )
+add_python_test( multigroup.FissionNeutronMultiplicity    multigroup/Test_NDItk_multigroup_FissionNeutronMultiplicity.py )
+add_python_test( multigroup.FissionNeutronProduction      multigroup/Test_NDItk_multigroup_FissionNeutronProduction.py )
+add_python_test( multigroup.FissionNeutronSpectrumMatrix  multigroup/Test_NDItk_multigroup_FissionNeutronSpectrumMatrix.py )
+add_python_test( multigroup.FissionNeutronSpectrumVector  multigroup/Test_NDItk_multigroup_FissionNeutronSpectrumVector.py )
 add_python_test( multigroup.Velocities                    multigroup/Test_NDItk_multigroup_Velocities.py )
 add_python_test( multigroup.HeatingNumbers                multigroup/Test_NDItk_multigroup_HeatingNumbers.py )
 add_python_test( multigroup.Kerma                         multigroup/Test_NDItk_multigroup_Kerma.py )

python/examples/.ipynb_checkpoints/NDItk-getting-started-example-1-checkpoint.ipynb

@@ -0,0 +1,111 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "f53a715b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "\n",
+    "# a recursive function to find all files with a given extension in a directory\n",
+    "def getFilesInFolder( directory, extension ) :\n",
+    "\n",
+    "    files = os.listdir( directory )\n",
+    "    everything = list()\n",
+    "\n",
+    "    for entry in files :\n",
+    "\n",
+    "        file = os.path.join( directory, entry )\n",
+    "\n",
+    "        if os.path.isdir( file ) :\n",
+    "\n",
+    "            everything += getFilesInFolder( file, extension )\n",
+    "\n",
+    "        else :\n",
+    "\n",
+    "            everything.append( file )\n",
+    "\n",
+    "    return [ file for file in everything if file.endswith( extension ) ]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "74836354",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "FAILED /Users/wim/Projects/libraries/ndi/mt80_30/t20/50118.851nm\n",
+      "-------------------------\n",
+      "   1 files\n",
+      "   1 failed\n",
+      "elapsed time = 0.000673 s\n",
+      "-------------------------\n"
+     ]
+    }
+   ],
+   "source": [
+    "import NDItk\n",
+    "import time\n",
+    "\n",
+    "path = '/Users/wim/Projects/libraries/ndi/mt80_30'\n",
+    "files = getFilesInFolder( path, '1001.851nm' )\n",
+    "failed = []\n",
+    "\n",
+    "start = time.perf_counter()\n",
+    "for file in files :\n",
+    "\n",
+    "    try :\n",
+    "\n",
+    "        table = NDItk.MultigroupTable.from_file( file )\n",
+    "\n",
+    "    except :\n",
+    "\n",
+    "        print( 'FAILED', file )\n",
+    "        failed.append( file )\n",
+    "\n",
+    "end = time.perf_counter()\n",
+    "\n",
+    "print( '-------------------------' )\n",
+    "print( '{:4} files'.format( len( files ) ) )\n",
+    "print( '{:4} failed'.format( len( failed ) ) )\n",
+    "print( 'elapsed time = {:.3} s'.format( end - start ) )\n",
+    "print( '-------------------------' )"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "9d108125",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.8.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

python/examples/NDItk-getting-started-example-1.ipynb

@@ -0,0 +1,121 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "f53a715b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "\n",
+    "# a recursive function to find all files with a given extension in a directory\n",
+    "def getFilesInFolder( directory, extension ) :\n",
+    "\n",
+    "    files = os.listdir( directory )\n",
+    "    everything = list()\n",
+    "\n",
+    "    for entry in files :\n",
+    "\n",
+    "        file = os.path.join( directory, entry )\n",
+    "\n",
+    "        if os.path.isdir( file ) :\n",
+    "\n",
+    "            everything += getFilesInFolder( file, extension )\n",
+    "\n",
+    "        else :\n",
+    "\n",
+    "            everything.append( file )\n",
+    "\n",
+    "    return [ file for file in everything if file.endswith( extension ) ]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "74836354",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "-------------------------\n",
+      "13455 files\n",
+      "   0 failed\n",
+      "elapsed time = 5.79e+02 s\n",
+      "-------------------------\n"
+     ]
+    }
+   ],
+   "source": [
+    "import NDItk\n",
+    "import time\n",
+    "\n",
+    "path = '/Users/wim/Projects/libraries/ndi/mt80'\n",
+    "files = getFilesInFolder( path, 'nm' )\n",
+    "failed = []\n",
+    "\n",
+    "start = time.perf_counter()\n",
+    "for file in files :\n",
+    "\n",
+    "    try :\n",
+    "\n",
+    "        table = NDItk.MultigroupTable.from_file( file )\n",
+    "\n",
+    "    except :\n",
+    "\n",
+    "        print( 'FAILED', file )\n",
+    "        failed.append( file )\n",
+    "\n",
+    "end = time.perf_counter()\n",
+    "\n",
+    "print( '-------------------------' )\n",
+    "print( '{:4} files'.format( len( files ) ) )\n",
+    "print( '{:4} failed'.format( len( failed ) ) )\n",
+    "print( 'elapsed time = {:.3} s'.format( end - start ) )\n",
+    "print( '-------------------------' )"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "9d108125",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import NDItk\n",
+    "table = NDItk.MultigroupTable.from_file( '/Users/wim/Projects/libraries/ndi/mt80_30/t22/38086.853nm' )"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "3ed6d2e8",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.8.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

python/src/MultigroupTable.python.cpp

@@ -21,6 +21,10 @@ void wrapMultigroupTable( python::module& module, python::module& ) {
   using TotalCrossSection = njoy::NDItk::multigroup::TotalCrossSection;
   using ReactionCrossSections = njoy::NDItk::multigroup::ReactionCrossSections;
   using AverageFissionEnergyRelease = njoy::NDItk::multigroup::AverageFissionEnergyRelease;
+  using FissionNeutronMultiplicity = njoy::NDItk::multigroup::FissionNeutronMultiplicity;
+  using FissionNeutronProduction = njoy::NDItk::multigroup::FissionNeutronProduction;
+  using FissionNeutronSpectrumMatrix = njoy::NDItk::multigroup::FissionNeutronSpectrumMatrix;
+  using FissionNeutronSpectrumVector = njoy::NDItk::multigroup::FissionNeutronSpectrumVector;
   using OutgoingParticleTypes = njoy::NDItk::multigroup::OutgoingParticleTypes;
   using OutgoingParticleTransportData = njoy::NDItk::multigroup::OutgoingParticleTransportData;
   using HeatingNumbers = njoy::NDItk::multigroup::HeatingNumbers;
@@ -155,6 +159,46 @@ void wrapMultigroupTable( python::module& module, python::module& ) {
     &Table::averageFissionEnergyRelease,
     "The average fission energy release record"
   )
+  .def(
+
+    "fission_neutron_multiplicity",
+    &Table::fissionNeutronMultiplicity,
+    python::arg( "type" ),
+    "The fission neutron multiplicity record for the requested fission type"
+    "Arguments:\n"
+    "    self    the table\n"
+    "    type    the fission type"
+  )
+  .def(
+
+    "fission_neutron_production",
+    &Table::fissionNeutronProduction,
+    python::arg( "type" ),
+    "The fission neutron production record for the requested fission type"
+    "Arguments:\n"
+    "    self    the table\n"
+    "    type    the fission type"
+  )
+  .def(
+
+    "fission_neutron_spectrum_matrix",
+    &Table::fissionNeutronSpectrumMatrix,
+    python::arg( "type" ),
+    "The fission neutron spectrum matrix record for the requested fission type"
+    "Arguments:\n"
+    "    self    the table\n"
+    "    type    the fission type"
+  )
+  .def(
+
+    "fission_neutron_spectrum_vector",
+    &Table::fissionNeutronSpectrumVector,
+    python::arg( "type" ),
+    "The fission neutron spectrum vector record for the requested fission type"
+    "Arguments:\n"
+    "    self    the table\n"
+    "    type    the fission type"
+  )
   .def_property_readonly(
 
     "primary_heating_numbers",

python/src/depletion/ReactionMultiplicities.python.cpp

@@ -52,6 +52,12 @@ void wrapReactionMultiplicities( python::module& module, python::module& ) {
     "    type              the multiplicity type (all, few or rmo)\n"
     "    multiplicities    the multiplicity data"
   )
+  .def_property_readonly(
+
+    "type",
+    &Record::type,
+    "The multiplicity type defined by this record"
+  )
   .def_property_readonly(
 
     "number_reactions",

python/src/multigroup.python.cpp

@@ -21,6 +21,10 @@ namespace multigroup {
   void wrapHeatingNumbers( python::module&, python::module& );
   void wrapKerma( python::module&, python::module& );
   void wrapAverageFissionEnergyRelease( python::module&, python::module& );
+  void wrapFissionNeutronMultiplicity( python::module&, python::module& );
+  void wrapFissionNeutronProduction( python::module&, python::module& );
+  void wrapFissionNeutronSpectrumMatrix( python::module&, python::module& );
+  void wrapFissionNeutronSpectrumVector( python::module&, python::module& );
   void wrapOutgoingParticleTypes( python::module&, python::module& );
   void wrapOutgoingParticleTransportData( python::module&, python::module& );
   void wrapLegendreMoment( python::module&, python::module& );
@@ -47,6 +51,10 @@ void wrapMultigroup( python::module& module, python::module& viewmodule ) {
   multigroup::wrapHeatingNumbers( submodule, viewmodule );
   multigroup::wrapKerma( submodule, viewmodule );
   multigroup::wrapAverageFissionEnergyRelease( submodule, viewmodule );
+  multigroup::wrapFissionNeutronMultiplicity( submodule, viewmodule );
+  multigroup::wrapFissionNeutronProduction( submodule, viewmodule );
+  multigroup::wrapFissionNeutronSpectrumMatrix( submodule, viewmodule );
+  multigroup::wrapFissionNeutronSpectrumVector( submodule, viewmodule );
   multigroup::wrapOutgoingParticleTypes( submodule, viewmodule );
   multigroup::wrapOutgoingParticleTransportData( submodule, viewmodule );
   multigroup::wrapLegendreMoment( submodule, viewmodule );