- user_objectThe UserObject you want to transfer values from. Note: This might be a UserObject from your MultiApp's input file!
C++ Type:UserObjectName
Unit:(no unit assumed)
Controllable:No
Description:The UserObject you want to transfer values from. Note: This might be a UserObject from your MultiApp's input file!
- variableThe auxiliary variable to store the transferred values in.
C++ Type:std::vector<AuxVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The auxiliary variable to store the transferred values in.
MultiAppUserObjectTransfer
Samples a variable's value in the Parent app domain at the point where the MultiApp is and copies that value into a post-processor in the MultiApp
Description
MultiAppUserObjectTransfer transfers information from a UserObject in the parent/sub application to an AuxVariable in the sub/parent application based on the direction of transfer (to_multiapp/from_multiApp).
The transfer can be restricted to a subdomain using the "block" parameter or a boundary using the "boundary" parameter.
To MultiApp
If the AuxVariable in the sub applications is a nodal AuxVariable, for each node in the sub application the value at the corresponding position in the parent application is queried from the parent UserObject, and this value is set to the AuxVariable at that node. A similar approach is followed for the elemental AuxVariable but with the centroid of the element instead of nodal position.
From MultiApp
For nodal AuxVariable in the parent application, it is first determined whether the node is contained within the bounding box of the sub application. If the parent node lies within a sub application's bounding box, the value of the sub application UserObject at that location is transferred to the parent AuxVariable. A similar approach is followed for the elemental AuxVariable but with the centroid of the parent element instead of nodal position.
When all_parent_nodes_contained_in_sub_app option is set to true, an error is generated if the parent node/element does not lie within the bounding boxes of any of the sub applications. An error is also generated if the parent node/element lies within the bounding boxes of 2 or more sub applications.
Input Parameters
- all_parent_nodes_contained_in_sub_appFalseSet to true if every parent app node is mapped to a distinct point on one of the subApps during a transfer from sub App to Parent App. If parent app node cannot be found within bounding boxes of any of the subApps, an error is generated.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Set to true if every parent app node is mapped to a distinct point on one of the subApps during a transfer from sub App to Parent App. If parent app node cannot be found within bounding boxes of any of the subApps, an error is generated.
- blockThe block we are transferring to (if not specified, whole domain is used).
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:The block we are transferring to (if not specified, whole domain is used).
- boundaryThe boundary we are transferring to (if not specified, whole domain is used unless 'block' parameter is used).
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:The boundary we are transferring to (if not specified, whole domain is used unless 'block' parameter is used).
- check_multiapp_execute_onTrueWhen false the check between the multiapp and transfer execute on flags is not performed.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:When false the check between the multiapp and transfer execute on flags is not performed.
- displaced_source_meshFalseWhether or not to use the displaced mesh for the source mesh.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not to use the displaced mesh for the source mesh.
- displaced_target_meshFalseWhether or not to use the displaced mesh for the target mesh.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not to use the displaced mesh for the target mesh.
- execute_onSAME_AS_MULTIAPPThe 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:SAME_AS_MULTIAPP
C++ Type:ExecFlagEnum
Unit:(no unit assumed)
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.
- from_multi_appThe name of the MultiApp to receive data from
C++ Type:MultiAppName
Unit:(no unit assumed)
Controllable:No
Description:The name of the MultiApp to receive data from
- nearest_sub_appFalseWhen True, a from_multiapp transfer will work by finding the nearest (using the `location`) sub-app and query that for the value to transfer
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:When True, a from_multiapp transfer will work by finding the nearest (using the `location`) sub-app and query that for the value to transfer
- skip_bounding_box_checkFalseSkip the check if the to_elem is within the bounding box of the from_app.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Skip the check if the to_elem is within the bounding box of the from_app.
- to_multi_appThe name of the MultiApp to transfer the data to
C++ Type:MultiAppName
Unit:(no unit assumed)
Controllable:No
Description:The name of the MultiApp to transfer the data to
Optional Parameters
- _called_legacy_paramsTrue
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
- 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.
- skip_coordinate_collapsingTrueWhether to skip coordinate collapsing (translation and rotation are still performed, only XYZ, RZ etc collapsing is skipped) when performing mapping and inverse mapping coordinate transformation operations. This parameter should only be set by users who really know what they're doing.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to skip coordinate collapsing (translation and rotation are still performed, only XYZ, RZ etc collapsing is skipped) when performing mapping and inverse mapping coordinate transformation operations. This parameter should only be set by users who really know what they're doing.
- 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
- allow_skipped_adjustmentFalseIf set to true, the transfer skips adjustment when from or to postprocessor values are either zero or have different signs. If set to false, an error is thrown when encountering these conditions.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:If set to true, the transfer skips adjustment when from or to postprocessor values are either zero or have different signs. If set to false, an error is thrown when encountering these conditions.
- from_postprocessors_to_be_preservedThe name of the Postprocessor in the from-app to evaluate an adjusting factor.
C++ Type:std::vector<PostprocessorName>
Unit:(no unit assumed)
Controllable:No
Description:The name of the Postprocessor in the from-app to evaluate an adjusting factor.
- to_postprocessors_to_be_preservedThe name of the Postprocessor in the to-app to evaluate an adjusting factor.
C++ Type:std::vector<PostprocessorName>
Unit:(no unit assumed)
Controllable:No
Description:The name of the Postprocessor in the to-app to evaluate an adjusting factor.