ElementGroupCentroidPositions

Gets the Positions of the centroid of groups of elements. Groups may be defined using subdomains or element extra ids.

Overview

This Positions object can be used to keep track of the centroids of assemblies, fuel pins, or axial levels of fuel pins, using the assembly_id, pin_id and plane_id respectively in the Reactor module.

Each block or extra element id specified in the parameters creates new bins; it does not indicate a wider group of element to compute the centroid of.

So for example, if three blocks and two types of extra element ids are specified, and for the latter two and four specific ids are specified, then the centroids will be computed for each of the 3 * 2 * 4 groups of elements.

commentnote

If any group of element is empty, the ElementGroupCentroidPositions will emit a warning and automatically remove it from the positions calculated.

commentnote

This object does not support distributed meshes. If you require its use with distributed meshes use a replicated mesh to generate the positions then after converting them to the expected format, load them from file using a FilePositions. If you are also using displaced meshes, then contact a MOOSE developer.

Example input syntax

In this example, we first compute the Positions of the centroids of each subdomain in the mesh.

[Positions]
  [all_mesh_blocks]
    type = ElementGroupCentroidPositions
    grouping_type = 'block'
  []
[]
(moose/test/tests/positions/element_group_centroid_positions.i)

We also show we can narrow this down to a single group

[Positions]
  [block_1]
    type = ElementGroupCentroidPositions
    block = 1
    grouping_type = 'block'
  []
[]
(moose/test/tests/positions/element_group_centroid_positions.i)

We then introduce extra element integer ids. Every position will correspond to the centroid of elements that are in a given subdomain, and also hold the extra element integer ids specified. Every additional element integer creates more combinations, more groups of elements for which the centroids are computed and stored.

[Positions]
  [block_and_one_id]
    type = ElementGroupCentroidPositions
    block = '1 2'
    extra_id_name = 'pin_id'
    extra_id = '1 2 4'
    grouping_type = 'block_and_extra_id'
  []

  [block_and_two_id]
    type = ElementGroupCentroidPositions
    block = '1 2'
    extra_id_name = 'assembly_id pin_id'
    extra_id = '1; 1 2 4'
    grouping_type = 'block_and_extra_id'
  []
[]
(moose/test/tests/positions/element_group_centroid_positions.i)

With this example, we show that specifying a simple space, like this ; ; will request all the available values for the element ids. This is easier than specifying them all in the input.

[Positions]
  [block_and_three_id]
    type = ElementGroupCentroidPositions
    block = '1 2'
    extra_id_name = 'assembly_id pin_id material_id'
    extra_id = '0; 1 2 4 6;'
    grouping_type = 'block_and_extra_id'
  []
[]
(moose/test/tests/positions/element_group_centroid_positions.i)

Finally, we do not use the block parameter to generate the centroids of the groups corresponding to combinations of three extra element ids.

[Positions]
  [three_ids]
    type = ElementGroupCentroidPositions
    extra_id_name = 'assembly_id pin_id material_id'
    extra_id = '0; 1 2 4 6;'
    grouping_type = 'extra_id'
  []
[]
(moose/test/tests/positions/element_group_centroid_positions.i)

Input Parameters

  • blockThe list of blocks (ids or names) that this object will be applied

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

  • execute_onNONEThe 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:NONE

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

    Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, 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.

  • extra_idSpecific ID(s), for each extra id name, for grouping elements. If empty, all *valid* ids will be used to bin

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Specific ID(s), for each extra id name, for grouping elements. If empty, all *valid* ids will be used to bin

  • extra_id_nameName(s) of the extra element ID(s) to use

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Name(s) of the extra element ID(s) to use

  • grouping_typeblockType of group of elements

    Default:block

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:block, extra_id, block_and_extra_id

    Controllable:No

    Description:Type of group of elements

  • initial_positionsPositions at the beginning of the simulation

    C++ Type:PositionsName

    Unit:(no unit assumed)

    Controllable:No

    Description:Positions at the beginning of the simulation

  • 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

    Unit:(no unit assumed)

    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.

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

    Unit:(no unit assumed)

    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).

  • auto_broadcastFalseWether Positions should be broadcasted across all ranks

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Wether Positions should be broadcasted across all ranks

  • auto_sortFalseWhether Positions should be sorted by coordinates

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether Positions should be sorted by coordinates

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

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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • 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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    Controllable:No

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

  • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

  • 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

    Unit:(no unit assumed)

    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