MultiAppMeshFunctionTransfer

Performs a transfer of field data to/from postprocessor data within sub-applications at locations specified by the sub-application position. The transfer utilizes the finite element function of the master application, via a libMesh::MeshFunction object, to perform the transfer.

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
    direction = to_multiapp
    variable = transferred_u
    type = MultiAppMeshFunctionTransfer
    multi_app = sub
  []

  [elemental_to_sub]
    source_variable = u
    direction = to_multiapp
    variable = elemental_transferred_u
    type = MultiAppMeshFunctionTransfer
    multi_app = sub
  []
[]
(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'
    direction = from_multiapp
    variable = 'transferred_u elemental_transferred_u'
    type = MultiAppMeshFunctionTransfer
    multi_app = sub
  []
[]
(test/tests/transfers/multiapp_mesh_function_transfer/fromsub.i)

Input Parameters

  • directionWhether this Transfer will be 'to' or 'from' a MultiApp, or bidirectional, by providing both FROM_MULTIAPP and TO_MULTIAPP.

    C++ Type:MultiMooseEnum

    Options:to_multiapp, from_multiapp

    Description:Whether this Transfer will be 'to' or 'from' a MultiApp, or bidirectional, by providing both FROM_MULTIAPP and TO_MULTIAPP.

  • multi_appThe name of the MultiApp to use.

    C++ Type:MultiAppName

    Options:

    Description:The name of the MultiApp to use.

  • source_variableThe variable to transfer from.

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

    Options:

    Description:The variable to transfer from.

  • variableThe auxiliary variable to store the transferred values in.

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

    Options:

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

Required 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

    Options:

    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.

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

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

  • 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

    Options:

    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.

    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.

  • from_postprocessors_to_be_preservedThe name of the Postprocessor in the from-app to evaluate an adjusting factor.

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

    Options:

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

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

    C++ Type:TagName

    Options:

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

  • to_postprocessors_to_be_preservedThe name of the Postprocessor in the to-app to evaluate an adjusting factor.

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

    Options:

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

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

    C++ Type:TagName

    Options:

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

Optional Parameters

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

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

    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