Feature/distributions part4

CMakeLists.txt

@@ -102,6 +102,7 @@ if( dryad.python )
       python/src/ReferenceFrame.python.cpp
       python/src/TabulatedCrossSection.python.cpp
       python/src/TabulatedMultiplicity.python.cpp
+      python/src/TabulatedAverageEnergy.python.cpp
       python/src/LegendreAngularDistribution.python.cpp
       python/src/LegendreAngularDistributions.python.cpp
       python/src/TabulatedAngularDistribution.python.cpp

cmake/unit_testing.cmake

@@ -29,6 +29,7 @@ endfunction()
 add_subdirectory( src/dryad/id/ElementID/test )
 
 add_subdirectory( src/dryad/TabulatedMultiplicity/test )
+add_subdirectory( src/dryad/TabulatedAverageEnergy/test )
 add_subdirectory( src/dryad/LegendreAngularDistribution/test )
 add_subdirectory( src/dryad/LegendreAngularDistributions/test )
 add_subdirectory( src/dryad/TabulatedAngularDistribution/test )

cmake/unit_testing_python.cmake

@@ -25,6 +25,7 @@ message( STATUS "Adding dryad Python unit testing" )
 add_python_test( id.ElementID id/Test_dryad_id_ElementID.py )
 
 add_python_test( TabulatedMultiplicity         Test_dryad_TabulatedMultiplicity.py )
+add_python_test( TabulatedAverageEnergy        Test_dryad_TabulatedAverageEnergy.py )
 add_python_test( LegendreAngularDistribution   Test_dryad_LegendreAngularDistribution.py )
 add_python_test( LegendreAngularDistributions  Test_dryad_LegendreAngularDistributions.py )
 add_python_test( TabulatedAngularDistribution  Test_dryad_TabulatedAngularDistribution.py )

python/src/ReactionProduct.python.cpp

@@ -62,6 +62,12 @@ void wrapReactionProduct( python::module& module, python::module& ) {
     &Component::multiplicity,
     "The multiplicity"
   )
+  .def_property_readonly(
+
+    "average_energy",
+    &Component::averageEnergy,
+    "The average reaction product energy"
+  )
   .def_property_readonly(
 
     "distribution_data",
@@ -74,6 +80,13 @@ void wrapReactionProduct( python::module& module, python::module& ) {
     &Component::isLinearised,
     "Flag indicating whether or not the reaction product is linearised"
   )
+  .def_property_readonly(
+
+    "has_average_energy",
+    &Component::hasAverageEnergy,
+    "Flag indicating whether or not the reaction product has average reaction "
+    "product energy data"
+  )
   .def_property_readonly(
 
     "has_distribution_data",

python/src/TabulatedAverageEnergy.python.cpp

@@ -0,0 +1,100 @@
+// system includes
+#include <pybind11/pybind11.h>
+#include <pybind11/stl.h>
+#include <pybind11/operators.h>
+
+// local includes
+#include "definitions.hpp"
+#include "dryad/TabulatedAverageEnergy.hpp"
+
+// namespace aliases
+namespace python = pybind11;
+
+void wrapTabulatedAverageEnergy( python::module& module, python::module& ) {
+
+  // type aliases
+  using Component = njoy::dryad::TabulatedAverageEnergy;
+  using InterpolationType = njoy::dryad::InterpolationType;
+  using ToleranceConvergence = njoy::dryad::ToleranceConvergence;
+
+  // wrap views created by this component
+
+  // create the component
+  python::class_< Component > component(
+
+    module,
+    "TabulatedAverageEnergy",
+    "An average reaction product energy table"
+  );
+
+  // wrap the component
+  component
+  .def(
+
+    python::init< std::vector< double >, std::vector< double >,
+                  std::vector< std::size_t >,
+                  std::vector< InterpolationType > >(),
+    python::arg( "energies" ), python::arg( "values" ),
+    python::arg( "boundaries" ), python::arg( "interpolants" ),
+    "Initialise the average reaction product energy table\n\n"
+    "Arguments:\n"
+    "    self           the average reaction product energy table\n"
+    "    energies       the energy values\n"
+    "    values         the average energy values\n"
+    "    boundaries     the boundaries of the interpolation regions\n"
+    "    interpolants   the interpolation types of the interpolation regions,\n"
+    "                   see InterpolationType for all interpolation types"
+  )
+  .def(
+
+    python::init< std::vector< double >, std::vector< double >,
+                  InterpolationType >(),
+    python::arg( "energies" ), python::arg( "values" ),
+    python::arg( "interpolant" ) = InterpolationType::LinearLinear,
+    "Initialise the average reaction product energy table\n\n"
+    "Arguments:\n"
+    "    self           the average reaction product energy table\n"
+    "    energies       the energy values\n"
+    "    values         the average energy values\n"
+    "    interpolant    the interpolation type (default lin-lin),\n"
+    "                   see InterpolationType for all interpolation types"
+  )
+  .def_property_readonly(
+
+    "energies",
+    &Component::energies,
+    "The energy values"
+  )
+  .def_property_readonly(
+
+    "values",
+    &Component::values,
+    "The average energy values"
+  )
+  .def_property_readonly(
+
+    "lower_energy_limit",
+    &Component::lowerEnergyLimit,
+    "The lower energy limit"
+  )
+  .def_property_readonly(
+
+    "upper_energy_limit",
+    &Component::upperEnergyLimit,
+    "The upper energy limit"
+  )
+  .def(
+
+    "__call__",
+    [] ( const Component& self, double energy ) -> decltype(auto)
+       { return self( energy ); },
+    python::arg( "energy" ),
+    "Evaluate the table for a given energy value\n\n"
+    "Arguments:\n"
+    "    self      the table\n"
+    "    energy    the energy value"
+  );
+
+  // add standard tabulated data definitions
+  addStandardTabulatedDefinitions< Component >( component );
+}

python/src/dryad.python.cpp

@@ -25,6 +25,7 @@ void wrapTabulatedEnergyDistribution( python::module&, python::module& );
 void wrapTabulatedEnergyDistributions( python::module&, python::module& );
 void wrapTabulatedCrossSection( python::module&, python::module& );
 void wrapTabulatedMultiplicity( python::module&, python::module& );
+void wrapTabulatedAverageEnergy( python::module&, python::module& );
 void wrapReactionProduct( python::module&, python::module& );
 void wrapReaction( python::module&, python::module& );
 void wrapProjectileTarget( python::module&, python::module& );
@@ -61,6 +62,7 @@ PYBIND11_MODULE( dryad, module ) {
 
   // wrap components - reaction products
   wrapTabulatedMultiplicity( module, viewmodule );
+  wrapTabulatedAverageEnergy( module, viewmodule );
   wrapLegendreAngularDistribution( module, viewmodule );
   wrapLegendreAngularDistributions( module, viewmodule );
   wrapTabulatedAngularDistribution( module, viewmodule );

python/test/Test_dryad_ReactionProduct.py

@@ -24,11 +24,15 @@ def verify_chunk( self, chunk ) :
             self.assertEqual( True, isinstance( chunk.multiplicity, int ) )
             self.assertEqual( 1, chunk.multiplicity )
 
+            # average reaction product energy
+            self.assertEqual( None, chunk.average_energy )
+
             # distribution data
             self.assertEqual( None, chunk.distribution_data )
 
             # metadata
             self.assertEqual( True, chunk.is_linearised )
+            self.assertEqual( False, chunk.has_average_energy )
             self.assertEqual( False, chunk.has_distribution_data )
 
         def verify_tabulated_chunk( self, chunk ) :
@@ -60,11 +64,15 @@ def verify_tabulated_chunk( self, chunk ) :
             self.assertEqual( InterpolationType.LinearLog, chunk.multiplicity.interpolants[1] )
             self.assertEqual( False, chunk.multiplicity.is_linearised )
 
+            # average reaction product energy
+            self.assertEqual( None, chunk.average_energy )
+
             # distribution data
             self.assertEqual( None, chunk.distribution_data )
 
             # metadata
             self.assertEqual( False, chunk.is_linearised )
+            self.assertEqual( False, chunk.has_average_energy )
             self.assertEqual( False, chunk.has_distribution_data )
 
         def verify_tabulated_linearised_chunk( self, chunk ) :
@@ -110,11 +118,15 @@ def verify_tabulated_linearised_chunk( self, chunk ) :
             self.assertEqual( InterpolationType.LinearLinear, chunk.multiplicity.interpolants[1] )
             self.assertEqual( True, chunk.multiplicity.is_linearised )
 
+            # average reaction product energy
+            self.assertEqual( None, chunk.average_energy )
+
             # distribution data
             self.assertEqual( None, chunk.distribution_data )
 
             # metadata
             self.assertEqual( True, chunk.is_linearised )
+            self.assertEqual( False, chunk.has_average_energy )
             self.assertEqual( False, chunk.has_distribution_data )
 
         # the data is given explicitly using an integer multiplicity