MultiAppCopyTransfer

The MultiAppCopyTransfer allows for copying variables (both nonlinear and auxiliary) between MultiApps. All types of variables, including higher order, elemental, and nodal are supported. The only limitation is that the meshes in the parent and sub application must be identical.

Siblings transfer behavior

This transfer supports sending data from a MultiApp to a MultiApp if and only if the number of subapps in the source MultiApp matches the number of subapps in the target MultiApp, and they are distributed the same way on the parallel processes. Each source app is then matched to the target app with the same subapp index.

Example Syntax

[Transfers]
  [./to_sub]
    type = MultiAppCopyTransfer
    source_variable = u
    variable = u
    to_multi_app = sub
  [../]
[]
(moose/test/tests/transfers/multiapp_copy_transfer/linear_lagrange_to_sub/parent.i)

Input Parameters

  • source_variableThe variable to transfer from.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The variable to transfer from.

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

Required Parameters

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

    Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, SAME_AS_MULTIAPP

    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_blocksSubdomain restriction to transfer from (defaults to all the origin app domain)

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Subdomain restriction to transfer from (defaults to all the origin app domain)

  • 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

  • from_solution_tagThe tag of the solution vector to be transferred (default to the solution)

    C++ Type:TagName

    Unit:(no unit assumed)

    Controllable:No

    Description:The tag of the solution vector to be transferred (default to the solution)

  • to_blocksSubdomain restriction to transfer to, (defaults to all the target app domain)

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Subdomain restriction to transfer to, (defaults to all the target app domain)

  • 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

  • to_solution_tagThe tag of the solution vector to be transferred to (default to the solution)

    C++ Type:TagName

    Unit:(no unit assumed)

    Controllable:No

    Description:The tag of the solution vector to be transferred to (default to the solution)

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