Tally and Domain Filter Editor UOs

doc/content/source/problems/OpenMCCellAverageProblem.md

@@ -296,6 +296,8 @@ regions where there are no cells at that level.
 
 ## Adding Tallies
 
+### Mapped Tallies
+
 This class takes the tally objects initialized by the `[Tallies]` block and use them to construct
 tally auxvariables. At the moment there are two options for discretizing tallies spatially in Cardinal:
 
@@ -308,6 +310,8 @@ $k$-eigenvalue or fixed-source problem). By default, the normalization is done a
 tally added over the entire OpenMC domain. By setting `normalize_by_global_tally` to false, however,
 the tally is instead normalized by the sum of the tally itself.
 
+### Mapped Tally Scores
+
 You can customize the type of score that Cardinal uses to normalize tallies to `power` with the `source_rate_normalization`
 parameter. Options include:
 
@@ -341,7 +345,9 @@ by Cardinal. Note that for all area or volume units in [tally_units], that those
 | `flux` | particle - cm / source particle | particle / area / second |
 | `H3_production` | tritium / source particle | tritium / volume / second |
 
-This units-transformation
+### Tally Normalization
+
+The tally units-transformation
 process involves *division by a volume*. In Cardinal, there are two different notions of volume:
 
 - The volume of the `[Mesh]` elements which *map* to a tally bin region
@@ -378,6 +384,15 @@ already are exactly the same volume, then no special thought is needed for the t
 normalization, and the value will be exactly consistent with the interpretation
 used in OpenMC.
 
+## Tally and Filter Editors
+
+Cardinal provides UserObjects for editing tallies and filters.
+
+  - [OpenMCTallyEditor](https://cardinal.cels.anl.gov/source/userobjects/OpenMCTallyEditor.html)
+  - [OpenMCDomainFilterEditor](https://cardinal.cels.anl.gov/source/userobjects/OpenMCTallyEditor.html)
+
+These objects provide online control of tally and filter parameters, respectively. These objects can be used to interact with tallies and/or filters that are mapped in Cardinal as part of the `OpenMCCellAverageProblem` or are present in a `tallies.xml` file for the problem being run (unmapped tallies). These objects can be used to create tallies as well -- in this case the new objects will **not be mapped** to the mesh mirror.
+
 ## Other Features
 
 While this class mainly facilitates data transfers to and from OpenMC, a number of

doc/content/source/userobjects/OpenMCDomainFilterEditor.md

@@ -0,0 +1,20 @@
+# OpenMCDomainFilterEditor
+
+!syntax description /UserObjects/OpenMCDomainFilterEditor
+
+## Description
+
+This user object can be used to create or control new domain filter in OpenMC.
+Currently suppored filter types are specified under the "filter_type" parameter.
+The filter bins are set using domain ID(s) in the OpenMC model.
+
+## Example Input Syntax
+
+!listing test/tests/userobjects/openmc_tally_editor/add_filter.i
+  block=UserObjects
+
+!syntax parameters /UserObjects/OpenMCDomainFilterEditor
+
+!syntax inputs /UserObjects/OpenMCDomainFilterEditor
+
+!syntax children /UserObjects/OpenMCDomainFilterEditor

doc/content/source/userobjects/OpenMCTallyEditor.md

@@ -0,0 +1,25 @@
+# OpenMCTallyEditor
+
+!syntax description /UserObjects/OpenMCTallyEditor
+
+## Description
+
+This user object can be used to change the nuclides, filters, and scores on a
+given OpenMC tally. This object is primarily used for facilitating depletion
+coupling of OpenMC to MOOSE, where we need to register new tallies with
+controllable parameters to account for changing compositions during depletion.
+
+## Example Input Syntax
+
+Below is an example which will create an OpenMC tally with controllable parameters
+tally to only obtain the fission heating from U-238 (ignoring the
+portion from U-235 in this particular tally).
+
+!listing test/tests/userobjects/openmc_tally_editor/nuclide_absorption.i
+  block=UserObjects
+
+!syntax parameters /UserObjects/OpenMCTallyEditor
+
+!syntax inputs /UserObjects/OpenMCTallyEditor
+
+!syntax children /UserObjects/OpenMCTallyEditor

include/base/CardinalEnums.h

@@ -34,6 +34,7 @@ MooseEnum getTallyTriggerEnum();
 MooseEnum getInitialPropertiesEnum();
 MultiMooseEnum getTallyScoreEnum();
 MooseEnum getNekMeshEnum();
+MooseEnum getFilterTypeEnum();
 
 namespace nek_mesh
 {
@@ -211,3 +212,12 @@ enum RelaxationEnum
   none
 };
 } // namespace relaxation
+
+enum OpenMCFilterType
+{
+  cell,
+  material,
+  universe,
+  mesh,
+  none
+};

include/base/OpenMCProblemBase.h

@@ -24,7 +24,8 @@
 #include "PostprocessorInterface.h"
 #include "CardinalEnums.h"
 #include "OpenMCNuclideDensities.h"
-#include "OpenMCTallyNuclides.h"
+#include "OpenMCDomainFilterEditor.h"
+#include "OpenMCTallyEditor.h"
 
 #include "mpi.h"
 #include "openmc/bank.h"
@@ -340,6 +341,18 @@ class OpenMCProblemBase : public CardinalProblem, public PostprocessorInterface
   /// Find all userobjects which are changing OpenMC data structures
   void getOpenMCUserObjects();
 
+  /// Ensure that the IDs of OpenMC objects in UserObjects don't clash
+  void checkOpenMCUserObjectIDs() const;
+
+  /// Execute all filter editor userobjects
+  void executeFilterEditors();
+
+  /// Execute all tally editor userobjects
+  void executeTallyEditors();
+
+  // execute all userobjects that change OpenMC filters
+  void executeTallyUpdates();
+
   /// Set the nuclide densities for any materials being modified via MOOSE
   void sendNuclideDensitiesToOpenMC();
 
@@ -439,8 +452,11 @@ class OpenMCProblemBase : public CardinalProblem, public PostprocessorInterface
   /// Userobjects for changing OpenMC material compositions
   std::vector<OpenMCNuclideDensities *> _nuclide_densities_uos;
 
-  /// Userobjects for changing OpenMC tally nuclides
-  std::vector<OpenMCTallyNuclides *> _tally_nuclides_uos;
+  /// Userobjects for creating/changing OpenMC filters
+  std::vector<OpenMCDomainFilterEditor *> _filter_editor_uos;
+
+  /// Userobjects for creating/changing OpenMC tallies
+  std::vector<OpenMCTallyEditor *> _tally_editor_uos;
 
   /// Mapping from local element indices to global element indices for this rank
   std::vector<unsigned int> _local_to_global_elem;

include/userobjects/OpenMCDomainFilterEditor.h

@@ -0,0 +1,70 @@
+/********************************************************************/
+/*                  SOFTWARE COPYRIGHT NOTIFICATION                 */
+/*                             Cardinal                             */
+/*                                                                  */
+/*                  (c) 2024 UChicago Argonne, LLC                  */
+/*                        ALL RIGHTS RESERVED                       */
+/*                                                                  */
+/*                 Prepared by UChicago Argonne, LLC                */
+/*               Under Contract No. DE-AC02-06CH11357               */
+/*                With the U. S. Department of Energy               */
+/*                                                                  */
+/*             Prepared by Battelle Energy Alliance, LLC            */
+/*               Under Contract No. DE-AC07-05ID14517               */
+/*                With the U. S. Department of Energy               */
+/*                                                                  */
+/*                 See LICENSE for full restrictions                */
+/********************************************************************/
+
+#pragma once
+
+#include "OpenMCUserObject.h"
+
+#include "CardinalEnums.h"
+
+// forward declarations
+class OpenMCProblemBase;
+
+/**
+ * User object to create and/or modify an OpenMC tally filter for a limited set of domain types.
+ */
+class OpenMCDomainFilterEditor : public OpenMCUserObject
+{
+public:
+  static InputParameters validParams();
+
+  OpenMCDomainFilterEditor(const InputParameters & parameters);
+
+  /// Virtual method overrides
+  virtual void execute() override;
+  virtual void initialize() override;
+  virtual void finalize() override {}
+
+  /**
+   * Get the index of the filter in OpenMC's data space
+   */
+  bool filter_exists() const;
+
+  /**
+   * Return the index of the filter in the OpenMC data space
+   */
+  int32_t filter_index() const;
+
+  /**
+   * Check that this object's filter type is valid and matches the type in the OpenMC data space
+   */
+  void check_filter_type_match() const;
+
+  std::string filterTypeEnumToString(OpenMCFilterType t) const;
+  OpenMCFilterType stringToFilterTypeEnum(const std::string & s) const;
+
+  std::string long_name() const { return "OpenMCDomainFilterEditor \"" + this->name() + "\""; }
+
+  // Accessors
+  int32_t filter_id() const { return _filter_id; }
+
+protected:
+  int32_t _filter_id;
+  OpenMCFilterType _filter_type;
+  const std::set<std::string> _allowed_types{"cell", "universe", "material", "mesh"};
+};

include/userobjects/OpenMCTallyEditor.h

@@ -0,0 +1,54 @@
+/********************************************************************/
+/*                  SOFTWARE COPYRIGHT NOTIFICATION                 */
+/*                             Cardinal                             */
+/*                                                                  */
+/*                  (c) 2024 UChicago Argonne, LLC                  */
+/*                        ALL RIGHTS RESERVED                       */
+/*                                                                  */
+/*                 Prepared by UChicago Argonne, LLC                */
+/*               Under Contract No. DE-AC02-06CH11357               */
+/*                With the U. S. Department of Energy               */
+/*                                                                  */
+/*             Prepared by Battelle Energy Alliance, LLC            */
+/*               Under Contract No. DE-AC07-05ID14517               */
+/*                With the U. S. Department of Energy               */
+/*                                                                  */
+/*                 See LICENSE for full restrictions                */
+/********************************************************************/
+
+#pragma once
+
+#include "OpenMCUserObject.h"
+
+// forward declarations
+class OpenMCProblemBase;
+
+/**
+ * User object to modify an OpenMC tally
+ */
+class OpenMCTallyEditor : public OpenMCUserObject
+{
+public:
+  static InputParameters validParams();
+
+  OpenMCTallyEditor(const InputParameters & parameters);
+
+  bool tally_exists() const;
+
+  // get the index of the tally in OpenMC's data space, creating it if necessary according to the
+  // input parameters
+  int32_t tally_index() const;
+
+  /// We don't want this user object to execute in MOOSE's control
+  virtual void execute() override;
+  virtual void initialize() override;
+  virtual void finalize() override {}
+
+  std::string long_name() const { return "OpenMCTallyEditor \"" + this->name() + "\""; }
+
+  // Accessors
+  int32_t tally_id() const { return _tally_id; }
+
+protected:
+  int32_t _tally_id;
+};

include/userobjects/OpenMCTallyNuclides.h → include/userobjects/OpenMCUserObject.h

@@ -2,7 +2,7 @@
 /*                  SOFTWARE COPYRIGHT NOTIFICATION                 */
 /*                             Cardinal                             */
 /*                                                                  */
-/*                  (c) 2021 UChicago Argonne, LLC                  */
+/*                  (c) 2024 UChicago Argonne, LLC                  */
 /*                        ALL RIGHTS RESERVED                       */
 /*                                                                  */
 /*                 Prepared by UChicago Argonne, LLC                */
@@ -20,29 +20,25 @@
 
 #include "GeneralUserObject.h"
 
+// forward declarations
+class OpenMCProblemBase;
+
 /**
- * User object to modify the nuclides in an OpenMC tally.
+ * User object to modify an OpenMC object
  */
-class OpenMCTallyNuclides : public GeneralUserObject
+class OpenMCUserObject : public GeneralUserObject
 {
 public:
   static InputParameters validParams();
 
-  OpenMCTallyNuclides(const InputParameters & parameters);
+  OpenMCUserObject(const InputParameters & parameters);
 
-  /// We don't want this user object to execute in MOOSE's control
-  virtual void execute() override {}
+  void execute() override;
 
-  virtual void initialize() override {}
-  virtual void finalize() override {}
+  std::string long_name() const { return "OpenMCUserObject \"" + this->name() + "\""; }
 
-  /// Instead, we want to have a separate method that we can call from the OpenMC problem
-  virtual void setValue();
+  const OpenMCProblemBase * openmc_problem() const;
 
 protected:
-  /// The tally index
-  int32_t _tally_index;
-
-  /// Nuclide names
-  const std::vector<std::string> & _names;
+  bool _first_execution;
 };

src/base/CardinalAppTypes.C

@@ -20,6 +20,8 @@
 #include "ExecFlagRegistry.h"
 
 #ifdef ENABLE_OPENMC_COUPLING
+const ExecFlagType EXEC_FILTER_GENERATORS = registerExecFlag("EXEC_FILTER_GENERATORS");
+const ExecFlagType EXEC_TALLY_GENERATORS = registerExecFlag("EXEC_TALLY_GENERATORS");
 const ExecFlagType EXEC_SEND_OPENMC_DENSITIES = registerExecFlag("SEND_OPENMC_DENSITIES");
 const ExecFlagType EXEC_SEND_OPENMC_TALLY_NUCLIDES = registerExecFlag("SEND_OPENMC_TALLY_NUCLIDES");
 #endif

src/base/CardinalEnums.C

@@ -96,3 +96,9 @@ getTallyScoreEnum()
 {
   return MultiMooseEnum("heating heating_local kappa_fission fission_q_prompt fission_q_recoverable damage_energy flux H3_production");
 }
+
+MooseEnum
+getFilterTypeEnum()
+{
+  return MooseEnum("cell material universe mesh none", "none");
+}

src/base/OpenMCCellAverageProblem.C

@@ -2322,8 +2322,6 @@ OpenMCCellAverageProblem::syncSolutions(ExternalProblem::Direction direction)
       // amounts of the different nuclides)
       sendNuclideDensitiesToOpenMC();
 
-      sendTallyNuclidesToOpenMC();
-
       if (_first_transfer && (_specified_temperature_feedback || _specified_density_feedback))
       {
         std::string incoming_transfer =