Sensitivity analysis for tallies

CMakeLists.txt

@@ -431,6 +431,7 @@ list(APPEND libopenmc_SOURCES
   src/tallies/filter_distribcell.cpp
   src/tallies/filter_energy.cpp
   src/tallies/filter_energyfunc.cpp
+  src/tallies/filter_importance.cpp
   src/tallies/filter_legendre.cpp
   src/tallies/filter_material.cpp
   src/tallies/filter_materialfrom.cpp
@@ -452,6 +453,7 @@ list(APPEND libopenmc_SOURCES
   src/tallies/filter_zernike.cpp
   src/tallies/tally.cpp
   src/tallies/tally_scoring.cpp
+  src/tallies/sensitivity.cpp
   src/tallies/trigger.cpp
   src/thermal.cpp
   src/timer.cpp

docs/source/pythonapi/base.rst

@@ -128,6 +128,7 @@ Constructing Tallies
    openmc.SurfaceFilter
    openmc.MeshFilter
    openmc.MeshBornFilter
+   openmc.ImportanceFilter
    openmc.MeshMaterialFilter
    openmc.MeshSurfaceFilter
    openmc.EnergyFilter
@@ -151,6 +152,8 @@ Constructing Tallies
    openmc.MeshMaterialVolumes
    openmc.Trigger
    openmc.TallyDerivative
+   openmc.SensitivityTally
+   openmc.Sensitivity
    openmc.Tally
    openmc.Tallies
 

docs/source/pythonapi/capi.rst

@@ -76,6 +76,7 @@ Classes
    Mesh
    MeshFilter
    MeshBornFilter
+   ImportanceFilter
    MeshSurfaceFilter
    MuFilter
    Nuclide
@@ -89,6 +90,7 @@ Classes
    SphericalMesh
    SurfaceFilter
    Tally
+   SensitivityTally
    TemporarySession
    UniverseFilter
    UnstructuredMesh

include/openmc/constants.h

@@ -288,6 +288,8 @@ enum class MgxsType {
 
 enum class TallyResult { VALUE, SUM, SUM_SQ, SIZE };
 
+enum class SensitivityTallyResult { VALUE, SUM, SUM_SQ, PREVIOUS_VALUE };
+
 enum class TallyType { VOLUME, MESH_SURFACE, SURFACE, PULSE_HEIGHT };
 
 enum class TallyEstimator { ANALOG, TRACKLENGTH, COLLISION };

include/openmc/filter_importance.h

@@ -0,0 +1,58 @@
+#ifndef OPENMC_TALLIES_FILTER_IMPORTANCE_H
+#define OPENMC_TALLIES_FILTER_IMPORTANCE_H
+
+#include <cstdint>
+
+#include <gsl/gsl-lite.hpp>
+#include "openmc/vector.h"
+#include "openmc/tallies/filter.h"
+
+namespace openmc {
+
+//==============================================================================
+//! Multiplies each tally by the importance corresponding to the mesh index 
+//==============================================================================
+
+class ImportanceFilter : public Filter {
+public:
+  //----------------------------------------------------------------------------
+  // Constructors, destructors
+
+  ~ImportanceFilter() = default;
+
+  //----------------------------------------------------------------------------
+  // Methods
+
+  std::string type_str() const override {return "importance";}
+  FilterType type() const override { return FilterType::IMPORTANCE; }
+
+  void from_xml(pugi::xml_node node) override;
+
+  void get_all_bins(const Particle& p, TallyEstimator estimator, FilterMatch& match)
+  const override;
+
+  void to_statepoint(hid_t filter_group) const override;
+
+  std::string text_label(int bin) const override;
+
+  //----------------------------------------------------------------------------
+  // Accessors
+
+  const std::vector<double>& importance() const { return importance_; }
+  void set_importance(gsl::span<const double> importance);
+
+  virtual int32_t mesh() const {return mesh_;}
+
+  virtual void set_mesh(int32_t mesh);
+
+protected:
+  //----------------------------------------------------------------------------
+  // Data members
+
+  std::vector<double> importance_;
+
+  int32_t mesh_;
+};
+
+} // namespace openmc
+#endif // OPENMC_TALLIES_FILTER_IMPORTANCE_H

include/openmc/particle_data.h

@@ -44,9 +44,12 @@ struct SourceSite {
   Position r;
   Direction u;
   double E;
+  double E_parent;
   double time {0.0};
   double wgt {1.0};
   int delayed_group {0};
+  int surf_id {0};
+  int fission_nuclide;
   int surf_id {SURFACE_NONE};
   ParticleType particle;
 
@@ -430,8 +433,13 @@ class ParticleData : public GeometryState {
 
   double E_;
   double E_last_;
+  double E_parent_; //!< energy of parent neutron in eV
   int g_ {0};
   int g_last_;
+
+  // Other birth data
+  int fission_nuclide_;  //!< this particle was born as a result of this nuclide fissioning
+  // a double for fission cross section at birth? if so, I need to also add it to the bank...
 
   double wgt_ {1.0};
   double wgt_born_ {1.0};
@@ -470,6 +478,8 @@ class ParticleData : public GeometryState {
   int64_t current_work_;
 
   vector<double> flux_derivs_;
+
+  std::vector<std::vector<double>> cumulative_sensitivities_;  // for sensitivities for this particle
 
   vector<FilterMatch> filter_matches_;
 
@@ -532,6 +542,8 @@ class ParticleData : public GeometryState {
   const double& E() const { return E_; }
   double& E_last() { return E_last_; }
   const double& E_last() const { return E_last_; }
+  double& E_parent() { return E_parent_; }              // for sensitivity analysis
+  const double& E_parent() const { return E_parent_; }  // for SA
   int& g() { return g_; }
   const int& g() const { return g_; }
   int& g_last() { return g_last_; }
@@ -629,6 +641,12 @@ class ParticleData : public GeometryState {
   // Used in tally derivatives
   double& flux_derivs(int i) { return flux_derivs_[i]; }
   const double& flux_derivs(int i) const { return flux_derivs_[i]; }
+
+  // Used in sensitivity analysis
+  std::vector<double>& cumulative_sensitivities(int i) { return cumulative_sensitivities_[i]; }
+  const std::vector<double>& cumulative_sensitivities(int i) const { return cumulative_sensitivities_[i]; }
+  int& fission_nuclide() { return fission_nuclide_; }
+  const int& fission_nuclide() const { return fission_nuclide_; }
 
   // Matches of tallies
   decltype(filter_matches_)& filter_matches() { return filter_matches_; }
@@ -697,6 +715,40 @@ class ParticleData : public GeometryState {
       d = 0;
     }
   }
+
+  void resize_flux_derivs(int newSize)
+  {
+    flux_derivs_.resize(newSize, 0.0);
+  }
+
+  // Resize and initialize sensitivity vectors
+  void resize_init_cumulative_sensitivities(int newSize)
+  {
+    cumulative_sensitivities_.resize(newSize, {0.0});
+  }
+
+  void resize_init_cumulative_sensitivities_vec(int indx, int newSize)
+  {
+    cumulative_sensitivities_[indx].resize(newSize, 0.0);
+  }
+
+  void resize_alloc_filter_matches(int newSize)
+  {
+    filter_matches_.resize(newSize);
+    for (auto &match: filter_matches_){
+      match.bins_.resize(1, 0.0);
+      match.weights_.resize(1, 0.0);
+      match.i_bin_ = 0;
+      // bins_present_ default is false from header
+    }
+  }
+
+  void initialize_cumulative_sensitivities()
+  {
+    for (auto& it : cumulative_sensitivities_){
+      std::fill(it.begin(), it.end(), 0.0);
+    }
+  }
 };
 
 } // namespace openmc

include/openmc/simulation.h

@@ -72,6 +72,9 @@ void initialize_generation();
 //! Full initialization of a particle history
 void initialize_history(Particle& p, int64_t index_source);
 
+//! Helper function for initialize_history() that is called independently elsewhere
+void initialize_history_partial(Particle& p);
+
 //! Finalize a batch
 //!
 //! Handles synchronization and accumulation of tallies, calculation of Shannon

include/openmc/tallies/filter.h

@@ -33,6 +33,7 @@ enum class FilterType {
   MATERIALFROM,
   MESH,
   MESHBORN,
+  IMPORTANCE,
   MESH_MATERIAL,
   MESH_SURFACE,
   MU,

include/openmc/tallies/filter_importance.h

@@ -0,0 +1,58 @@
+#ifndef OPENMC_TALLIES_FILTER_IMPORTANCE_H
+#define OPENMC_TALLIES_FILTER_IMPORTANCE_H
+
+#include <cstdint>
+
+#include <gsl/gsl-lite.hpp>
+#include "openmc/vector.h"
+#include "openmc/tallies/filter.h"
+
+namespace openmc {
+
+//==============================================================================
+//! Multiplies each tally by the importance corresponding to the mesh index 
+//==============================================================================
+
+class ImportanceFilter : public Filter {
+public:
+  //----------------------------------------------------------------------------
+  // Constructors, destructors
+
+  ~ImportanceFilter() = default;
+
+  //----------------------------------------------------------------------------
+  // Methods
+
+  std::string type_str() const override {return "importance";}
+  FilterType type() const override { return FilterType::IMPORTANCE; }
+
+  void from_xml(pugi::xml_node node) override;
+
+  void get_all_bins(const Particle& p, TallyEstimator estimator, FilterMatch& match)
+  const override;
+
+  void to_statepoint(hid_t filter_group) const override;
+
+  std::string text_label(int bin) const override;
+
+  //----------------------------------------------------------------------------
+  // Accessors
+
+  const std::vector<double>& importance() const { return importance_; }
+  void set_importance(gsl::span<const double> importance);
+
+  virtual int32_t mesh() const {return mesh_;}
+
+  virtual void set_mesh(int32_t mesh);
+
+protected:
+  //----------------------------------------------------------------------------
+  // Data members
+
+  std::vector<double> importance_;
+
+  int32_t mesh_;
+};
+
+} // namespace openmc
+#endif // OPENMC_TALLIES_FILTER_IMPORTANCE_H