AddTallyAction

commentnote

AddTallyAction can only add tallies to problems which contain a OpenMCCellAverageProblem in the [Problem] block. Otherwise, attempting to add a tally will result in an error.

Overview

The AddTallyAction action is responsible for adding local tallies to a simulation through the [Tallies] block in a Cardinal input file.

For all requested tallies other than unstructured mesh tallies, a single tally object is added per sub-block in [Tallies]. When an unstructured mesh tally is requested N tally objects will be added, where N is the number of positions in mesh_translations / the number of positions in the file named mesh_translations_file. These translated mesh tallies store their scores in the same auxvariable(s), and the tally scores are normalized by the sum over all bins in the associated OpenMCCellAverageProblem. mesh_translations and mesh_translations_file are only applicable to MeshTally objects.

Example Input File Syntax

An example where multiple unstructured mesh tallies are added can be found below. AddTallyActionadds three mesh tallies, where each tally has one of the positions listed in the file named mesh_translations_file.

[Problem]
  type = OpenMCCellAverageProblem
  verbose = true
  power = 1500.0
  temperature_blocks = '0'
  normalize_by_global_tally = false
  cell_level = 1
  scaling = 100.0

  [Tallies]
    [heat_source]
      type = MeshTally
      mesh_translations = '0 0 0.02
                           0 0 0.06
                           0 0 0.10'
      mesh_template = mesh_in.e
      name = heat_source
    []
  []
[]
(tutorials/pebbles/openmc_um.i)

An example of adding non-translated tallies can be found below, where both a CellTally and MeshTally are added to the problem.

[Problem]
  type = OpenMCCellAverageProblem
  particles = 10000
  inactive_batches = 100
  batches = 1000
  initial_properties = xml
  verbose = true
  cell_level = 0

  normalize_by_global_tally = true
  check_tally_sum = true

  power = 100.0

  source_rate_normalization = 'heating_local'

  [Tallies]
    [Mesh_Tally]
      type = MeshTally
      score = 'flux'
    []
    [Cell_Tally]
      type = CellTally
      score = 'heating_local'
    []
  []
[]
(doc/content/source/actions/multi_tally_example.i)

Available Tally Objects

  • Cardinal App
  • CellTallyA class which implements distributed cell tallies.
  • MeshTallyA class which implements unstructured mesh tallies.

Input Parameters

  • active__all__ If specified only the blocks named will be visited and made active

    Default:__all__

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:If specified only the blocks named will be visited and made active

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:If specified blocks matching these identifiers will be skipped.

  • mesh_translationsCoordinates to which each mesh template should be translated, if multiple unstructured meshes are desired. Units must match those used to define the [Mesh].

    C++ Type:std::vector<libMesh::Point>

    Controllable:No

    Description:Coordinates to which each mesh template should be translated, if multiple unstructured meshes are desired. Units must match those used to define the [Mesh].

  • mesh_translations_fileFile providing the coordinates to which each mesh template should be translated, if multiple unstructured meshes are desired. Units must match those used to define the [Mesh]

    C++ Type:std::vector<FileName>

    Controllable:No

    Description:File providing the coordinates to which each mesh template should be translated, if multiple unstructured meshes are desired. Units must match those used to define the [Mesh]

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • isObjectActionTrueIndicates that this is a MooseObjectAction.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Indicates that this is a MooseObjectAction.

Advanced Parameters