MultiAppMeshFunctionTransfer

Transfers field data at the MultiApp position using solution the finite element function from the main/parent application, via a 'libMesh::MeshFunction' object.

Example Input File Syntax

The following examples demonstrate the use the MultiAppMeshFunctionTransfer for transferring data to (Listing 1) and from (Listing 2) sub-applications.

Listing 1: Example use of MultiAppMeshFunctionTransfer for transferring data to sub-applications.

[Transfers]
  [to_sub]
    source_variable = u
    variable = transferred_u
    type = MultiAppMeshFunctionTransfer
    to_multi_app = sub
  []

  [elemental_to_sub]
    source_variable = u
    variable = elemental_transferred_u
    type = MultiAppMeshFunctionTransfer
    to_multi_app = sub
  []
[]
(../../../SoftwareDownloads/moose/test/tests/transfers/multiapp_mesh_function_transfer/tosub.i)

Listing 2: Example use of MultiAppMeshFunctionTransfer for transferring data from sub-applications.

[Transfers]
  [from_sub]
    source_variable = 'sub_u sub_u'
    variable = 'transferred_u elemental_transferred_u'
    type = MultiAppMeshFunctionTransfer
    from_multi_app = sub
  []
[]
(../../../SoftwareDownloads/moose/test/tests/transfers/multiapp_mesh_function_transfer/fromsub.i)

Input Parameters

  • source_variableThe variable to transfer from.

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

    Controllable:No

    Description:The variable to transfer from.

  • variableThe auxiliary variable to store the transferred values in.

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

    Controllable:No

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

Required Parameters

  • bbox_factor1Multiply bounding box width (in all directions) by the prescribed factor. Values less than 1 will shrink the bounding box; values greater than 1 will enlarge the bounding box. It is generally not advised to ever shrink the bounding box. On the other hand it may be helpful to enlarge the bounding box. Larger bounding boxes will lead to more accurate determination of the closest node/element with the tradeoff of more communication.

    Default:1

    C++ Type:double

    Controllable:No

    Description:Multiply bounding box width (in all directions) by the prescribed factor. Values less than 1 will shrink the bounding box; values greater than 1 will enlarge the bounding box. It is generally not advised to ever shrink the bounding box. On the other hand it may be helpful to enlarge the bounding box. Larger bounding boxes will lead to more accurate determination of the closest node/element with the tradeoff of more communication.

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

    Default:True

    C++ Type:bool

    Controllable:No

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

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

    Default:False

    C++ Type:bool

    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

    Controllable:No

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

  • error_on_missFalseWhether or not to error in the case that a target point is not found in the source domain.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether or not to error in the case that a target point is not found in the source domain.

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

    Default:SAME_AS_MULTIAPP

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, SAME_AS_MULTIAPP, ALWAYS

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

  • from_multi_appThe name of the MultiApp to receive data from

    C++ Type:MultiAppName

    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

    Controllable:No

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

  • to_multi_appThe name of the MultiApp to transfer the data to

    C++ Type:MultiAppName

    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

    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

    Controllable:No

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

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

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

    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>

    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>

    Controllable:No

    Description:The name of the Postprocessor in the to-app to evaluate an adjusting factor.

Conservative Transfer Parameters