OpenMCCellTransform

UserObject that applies either translation or rotation on one or more OpenMC cells. The transform is driven by a transform array of three MOOSE postprocessors/scalar values

Description

This user object can be used to either translate or rotate an openmc.Universe which is the fill of an openmc.Cell.

warningwarning:The specified transformation is only applied to the universe which fills the cell.

This userobject doesn't translate or rotate the surfaces of the specified cell. Instead, the given transform will be used to shift/rotate the universe fill. Note that it is possible to create undesired void regions with a poorly defined cell/universe/transformation combination, which may result in lost particles. If you want to use moving mesh capabilities for general cell surfaces, consider using the MoabSkinner with DAGMC geometries instead.

Example Input Syntax

To translate a universe, the transform array takes (, , ) translations. Below is an example which will translate the universe inside a specified OpenMC cell:

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [translate_cells]
    type = OpenMCCellTransform<<<{"description": "UserObject that applies either translation or rotation on one or more OpenMC cells. The transform is driven by a transform array of three MOOSE postprocessors/scalar values", "href": "OpenMCCellTransform.html"}>>>
    transform_type<<<{"description": "Type of transform to apply: 'translation' (dx,dy,dz) or 'rotation'(\u03c6, \u03b8, \u03c8) in degrees, where the angles are the rotations about the x, y, and z axes, respectively."}>>> = 'translation'
    vector_value<<<{"description": "An array of three values/postprocessors. For translation this array expects (dx, dy, dz) in mesh units. For rotation this array expects '\u03c6, \u03b8, \u03c8' in degrees."}>>> = 'shift_x shift_y 0'
    cell_ids<<<{"description": "List of OpenMC cell IDs whose filled universes will be transformed."}>>> = '2011'
    execute_on<<<{"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."}>>> = 'timestep_begin'
  []
[]
(test/tests/userobjects/openmc_cell_transform/translate_cells.i)

To rotate a universe, the transform array takes (, , ) which are the rotation angles in degrees about x, y, and z axes. Below is an example which will rotate the universe inside a specified OpenMC cell:

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [rotate_cells]
    type = OpenMCCellTransform<<<{"description": "UserObject that applies either translation or rotation on one or more OpenMC cells. The transform is driven by a transform array of three MOOSE postprocessors/scalar values", "href": "OpenMCCellTransform.html"}>>>
    transform_type<<<{"description": "Type of transform to apply: 'translation' (dx,dy,dz) or 'rotation'(\u03c6, \u03b8, \u03c8) in degrees, where the angles are the rotations about the x, y, and z axes, respectively."}>>> = 'rotation'
    vector_value<<<{"description": "An array of three values/postprocessors. For translation this array expects (dx, dy, dz) in mesh units. For rotation this array expects '\u03c6, \u03b8, \u03c8' in degrees."}>>> = '0 0 psi'
    cell_ids<<<{"description": "List of OpenMC cell IDs whose filled universes will be transformed."}>>> = '2011'
    execute_on<<<{"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."}>>> = 'timestep_begin'
  []
[]
(test/tests/userobjects/openmc_cell_transform/rotate_cells.i)

Input Parameters

  • cell_idsList of OpenMC cell IDs whose filled universes will be transformed.

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

    Controllable:No

    Description:List of OpenMC cell IDs whose filled universes will be transformed.

  • vector_valueAn array of three values/postprocessors. For translation this array expects (dx, dy, dz) in mesh units. For rotation this array expects 'φ, θ, ψ' in degrees.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:An array of three values/postprocessors. For translation this array expects (dx, dy, dz) in mesh units. For rotation this array expects 'φ, θ, ψ' in degrees.

Required Parameters

  • transform_typetranslationType of transform to apply: 'translation' (dx,dy,dz) or 'rotation'(φ, θ, ψ) in degrees, where the angles are the rotations about the x, y, and z axes, respectively.

    Default:translation

    C++ Type:MooseEnum

    Options:translation, rotation

    Controllable:No

    Description:Type of transform to apply: 'translation' (dx,dy,dz) or 'rotation'(φ, θ, ψ) in degrees, where the angles are the rotations about the x, y, and z axes, respectively.

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:XFEM_MARK, 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, TRANSFER

    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

Input Files