Merge branch 'fix/directory' into 'develop'

Fix/directory

See merge request njoy/ENDFtk!15

Author: whaeck

ReleaseNotes.md

@@ -11,6 +11,7 @@ This update makes the following changes on interface functions:
   - Miscellaneous documentation updates were made.
 
 In addition, the following issues were corrected:
+  - In some ENDF files (such as the JEFF 3.3 decay library files), the directory records in MF1 MT451 sometimes have superfluous zeros in column 1 and 2 (similar to how END records sometimes have supefluous zeros in columns 1 through 6). Previously, ENDFtk flagged these directory records as errors. This has been corrected, although these columns will still be left blank when printing them out (in the same way as END records).
   - A minor bug in the rectangular matrix covariance block was corrected. The values for the row and column energies are lifted out of a larger array using the std::ranges::take and std::ranges::drop function. For the column energies, we forgot to properly end the sequence. As a result, the end() iterator of the range did not point to the end of the column energies but to the end of the covariance values, which is now corrected.
   - In MF8 MT457 DiscreteSpectrum, NT=8 (which can occur for electrons, i.e. STYP=8), was explicitly disallowed by ENDFtk. This was corrected and a new constructor reflecting this usage was added as well.
   - The STA variable in MF1 MT451 was interpreted incorrectly and this has now been fixed. An additional isUnstable() function has been added to the interface.

src/ENDFtk/DirectoryRecord.hpp

@@ -18,14 +18,17 @@ namespace ENDFtk {
    *
    *  See ENDF102, section 1.1 for more information.
    */
-  class DirectoryRecord : protected record::Base< record::Integer< 33 >,
+  class DirectoryRecord : protected record::Base< record::Real,
+                                                  record::Real,
+                                                  record::Integer< 11 >,
                                                   record::Integer< 11 >,
                                                   record::Integer< 11 >,
                                                   record::Integer< 11 > > {
 
     /* type aliases */
     using base =
-      record::Base< record::Integer< 33 >, record::Integer< 11 >,
+      record::Base< record::Real, record::Real,
+                    record::Integer< 11 >, record::Integer< 11 >,
                     record::Integer< 11 >, record::Integer< 11 > >;
     using tail = record::TailVerifying< record::MAT, record::MF, record::MT >;
 
@@ -42,7 +45,7 @@ namespace ENDFtk {
      *  @param[in] mod   the modification number
      */
     DirectoryRecord( long mf, long mt, long nc, long mod ) :
-      base( mf, mt, nc, mod ){}
+      base( 0.0, 0.0, mf, mt, nc, mod ){}
 
 //! @todo pybind11 variant needs default constructor workaround
 #ifdef PYBIND11
@@ -86,10 +89,10 @@ namespace ENDFtk {
     ImmutableReturnType< index >                                  \
     name () const { return std::get< index >( this->fields ); }
 
-    DEFINE_GETTER( MF, 0 )
-    DEFINE_GETTER( MT, 1 )
-    DEFINE_GETTER( NC, 2 )
-    DEFINE_GETTER( MOD, 3 )
+    DEFINE_GETTER( MF, 2 )
+    DEFINE_GETTER( MT, 3 )
+    DEFINE_GETTER( NC, 4 )
+    DEFINE_GETTER( MOD, 5 )
 
   #undef DEFINE_GETTER
 

src/ENDFtk/DirectoryRecord/test/DirectoryRecord.test.cpp

@@ -12,6 +12,7 @@ using Catch::Matchers::WithinRel;
 using namespace njoy::ENDFtk;
 
 std::string chunk();
+std::string chunkWithSuperfluousZeros();
 void verifyChunk( const DirectoryRecord& );
 std::string invalidChunk();
 
@@ -67,6 +68,30 @@ SCENARIO( "DirectoryRecord" ) {
         CHECK( buffer == string );
       } // THEN
     } // WHEN
+
+    WHEN( "the data is read from a string/stream with superfluous zeros" ) {
+
+      auto superfluous = chunkWithSuperfluousZeros();
+      auto begin = superfluous.begin();
+      auto end = superfluous.end();
+      long lineNumber = 1;
+
+      DirectoryRecord chunk( begin, end, lineNumber, 125, 1, 451 );
+
+      THEN( "a DirectoryRecord can be constructed and members can be tested" ) {
+
+        verifyChunk( chunk );
+      } // THEN
+
+      THEN( "it can be printed without the superfluous zeros" ) {
+
+        std::string buffer;
+        auto output = std::back_inserter( buffer );
+        chunk.print( output, 125, 1, 451 );
+
+        CHECK( buffer == string );
+      } // THEN
+    } // WHEN
   } // GIVEN
 
   GIVEN( "invalid data for a DirectoryRecord" ) {
@@ -107,6 +132,12 @@ std::string chunk() {
     "                                1        451        101          5 125 1451     \n";
 }
 
+std::string chunkWithSuperfluousZeros() {
+
+  return
+    " 0.00000+00 0.00000+00          1        451        101          5 125 1451     \n";
+}
+
 void verifyChunk( const DirectoryRecord& chunk ) {
 
   CHECK( 1 == chunk.MF() );