MultiAppUserObjectTransfer

!syntax description /Transfers/MultiAppUserObjectTransfer

Description MultiAppUserObjectTransfer transfers information from a UserObject in the master/sub application to an AuxVariable in the sub/master application based on the direction of transfer (to_multiapp/from_multiApp).

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 master application is queried from the master 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 master application, it is first determined whether the node is contained within the bounding box of the sub application. If the master node lies within a sub application's bounding box, the value of the sub application UserObject at that location is transferred to the master AuxVariable. A similar approach is followed for the elemental AuxVariable but with the centroid of the master element instead of nodal position.

When all_master_nodes_contained_in_sub_app option is set to true, an error is generated if the master node/element does not lie within the bounding boxes of any of the sub applications. An error is also generated if the master node/element lies within the bounding boxes of 2 or more sub applications.

Input Parameters

  • variableThe auxiliary variable to store the transferred values in.

    C++ Type:AuxVariableName

    Options:

    Description:The auxiliary variable to store the transferred values in.

  • directionWhether this Transfer will be 'to' or 'from' a MultiApp.

    C++ Type:MooseEnum

    Options:to_multiapp from_multiapp

    Description:Whether this Transfer will be 'to' or 'from' a MultiApp.

  • user_objectThe UserObject you want to transfer values from. Note: This might be a UserObject from your MultiApp's input file!

    C++ Type:UserObjectName

    Options:

    Description:The UserObject you want to transfer values from. Note: This might be a UserObject from your MultiApp's input file!

  • multi_appThe name of the MultiApp to use.

    C++ Type:MultiAppName

    Options:

    Description:The name of the MultiApp to use.

Required Parameters

  • check_multiapp_execute_onTrueWhen false the check between the multiapp and transfer execute on flags is not preformed.

    Default:True

    C++ Type:bool

    Options:

    Description:When false the check between the multiapp and transfer execute on flags is not preformed.

  • execute_onSAME_AS_MULTIAPPThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, SAME_AS_MULTIAPP.

    Default:SAME_AS_MULTIAPP

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM SAME_AS_MULTIAPP

    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, FINAL, CUSTOM, SAME_AS_MULTIAPP.

  • all_master_nodes_contained_in_sub_appFalseSet to true if every master node is mapped to a distinct point on one of the subApps during a transfer from sub App to Master App. If master node cannot be found within bounding boxes of any of the subApps, an error is generated.

    Default:False

    C++ Type:bool

    Options:

    Description:Set to true if every master node is mapped to a distinct point on one of the subApps during a transfer from sub App to Master App. If master node cannot be found within bounding boxes of any of the subApps, an error is generated.

  • displaced_source_meshFalseWhether or not to use the displaced mesh for the source mesh.

    Default:False

    C++ Type:bool

    Options:

    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

    Options:

    Description:Whether or not to use the displaced mesh for the target mesh.

Optional Parameters

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

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    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

    Options:

    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

Input Files

References