- multiappsName(s) of the multiapps providing the positions
C++ Type:std::vector<MultiAppName>
Controllable:No
Description:Name(s) of the multiapps providing the positions
MultiAppPositions
Obtain positions from MultiApps. This may only be used to set the positions of those same multiapps if an 'initial_positions' parameter is used.
Overview
MultiApps have a position that is used to translate their frame of reference compared to the main app frame of reference. This position can be used to align the meshes for the transfers or for outputting the MultiApps Exodus results at the translated positions.
warningwarning
This should not** be used to generate new MultiApps. The MultiApps have already been created when the positions are gathered.
Example MultiApp File Syntax
In this example, the MultiAppPositions is obtaining the positions of three MultiApps.
[Positions]
[multiapp]
type = MultiAppPositions
multiapps = 'm1 m2 m3'
[]
[]
[MultiApps]
[m1]
type = CentroidMultiApp
input_files = 'multiapp_positions.i'
cli_args = "MultiApps/active='';Positions/active=''"
[]
[m2]
type = FullSolveMultiApp
input_files = 'multiapp_positions.i'
cli_args = "MultiApps/active='';Positions/active=''"
[]
[m3]
type = FullSolveMultiApp
input_files = 'multiapp_positions.i'
positions = '0.2 0.4 1
0 0 6'
cli_args = "MultiApps/active='';Positions/active=''"
[]
[]
Input Parameters
- execute_onINITIALThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.
Default:INITIAL
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.
- initial_positionsPositions at the beginning of the simulation
C++ Type:ReporterName
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
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_apps_centroidFalseWhether to use the mesh centroid offset by the app position rather than just the position of each child app
Default:False
C++ Type:bool
Controllable:No
Description:Whether to use the mesh centroid offset by the app position rather than just the position of each child app
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).
- auto_broadcastFalseWether Positions should be broadcasted across all ranks
Default:False
C++ Type:bool
Controllable:No
Description:Wether Positions should be broadcasted across all ranks
- auto_sortFalseWhether Positions should be sorted by coordinates
Default:False
C++ Type:bool
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>
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.
- 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
- outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
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
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.