OpenMCDomainFilterEditor

A UserObject for creating and managing OpenMC domain tally filters

Description

This user object can be used to create or control new domain filters 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

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [new_filter]
    type = OpenMCDomainFilterEditor<<<{"description": "A UserObject for creating and managing OpenMC domain tally filters", "href": "OpenMCDomainFilterEditor.html"}>>>
    create_filter<<<{"description": "Whether to create the filter if it doesn't exist"}>>> = true
    filter_id<<<{"description": "The ID of the filter to modify"}>>> = 100
    filter_type<<<{"description": "The type of filter"}>>> = 'cell'
    bins<<<{"description": "The bins to apply in the filter"}>>> = '1'
  []
  [tally_scatter]
    type = OpenMCTallyEditor<<<{"description": "A UserObject for creating and managing OpenMC tallies", "href": "OpenMCTallyEditor.html"}>>>
    create_tally<<<{"description": "Whether to create the tally if it doesn't exist"}>>> = true
    tally_id<<<{"description": "The ID of the tally to modify"}>>> = 100
    scores<<<{"description": "The scores to apply in the tally"}>>> = 'absorption'
    filter_ids<<<{"description": "The filter IDs to apply in the tally"}>>> = '100'
    nuclides<<<{"description": "The nuclides to apply in the tally"}>>> = ''
  []
[]
(cardinal/test/tests/userobjects/openmc_tally_editor/add_filter.i)

Input Parameters

  • binsThe bins to apply in the filter

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

    Controllable:Yes

    Description:The bins to apply in the filter

  • filter_idThe ID of the filter to modify

    C++ Type:int

    Controllable:No

    Description:The ID of the filter to modify

  • filter_typenoneThe type of filter

    Default:none

    C++ Type:MooseEnum

    Options:cell, material, universe, mesh, none

    Controllable:No

    Description:The type of filter

Required Parameters

  • create_filterFalseWhether to create the filter if it doesn't exist

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether to create the filter if it doesn't exist

Optional Parameters

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Controllable:No

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, CUSTOM

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

  • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

    Default:0

    C++ Type:int

    Controllable:No

    Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

  • force_postauxFalseForces the UserObject to be executed in POSTAUX

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in POSTAUX

  • force_preauxFalseForces the UserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in PREAUX

  • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in PREIC during initial setup

Execution Scheduling 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.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Material Property Retrieval Parameters