MultiAppNearestNodeTransfer

Transfer the value to the target domain from the nearest node in the source domain.

Example Input File Syntax

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

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

[Transfers]
  [to_sub_nodal_to_nodal]
    type = MultiAppNearestNodeTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = u
    variable = nodal_source_from_master_nodal
  []
  [to_sub_nodal_to_elemental]
    type = MultiAppNearestNodeTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = u
    variable = nodal_source_from_master_elemental
  []
  [to_sub_elemental_to_nodal]
    type = MultiAppNearestNodeTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = u_elemental
    variable = elemental_source_from_master_nodal
  []
  [to_sub_elemental_to_elemental]
    type = MultiAppNearestNodeTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = u_elemental
    variable = elemental_source_from_master_elemental
  []
[]
(test/tests/transfers/multiapp_nearest_node_transfer/tosub_master.i)

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

[Transfers]
  [from_sub_nodal_from_nodal]
    type = MultiAppNearestNodeTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = u
    variable = nodal_source_from_sub_nodal
  []
  [from_sub_nodal_from_elemental]
    type = MultiAppNearestNodeTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = u
    variable = nodal_source_from_sub_elemental
  []
  [from_sub_elemental_from_nodal]
    type = MultiAppNearestNodeTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = u_elemental
    variable = elemental_source_from_sub_nodal
  []
  [from_sub_elemental_from_elemental]
    type = MultiAppNearestNodeTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = u_elemental
    variable = elemental_source_from_sub_elemental
  []
[]
(test/tests/transfers/multiapp_nearest_node_transfer/fromsub_master.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

    Options:

    Description:The variable to transfer from.

  • variableThe auxiliary variable to store the transferred values in.

    C++ Type:std::vector

    Options:

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

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

  • fixed_meshesFalseSet to true when the meshes are not changing (ie, no movement or adaptivity). This will cache nearest node neighbors to greatly speed up the transfer.

    Default:False

    C++ Type:bool

    Options:

    Description:Set to true when the meshes are not changing (ie, no movement or adaptivity). This will cache nearest node neighbors to greatly speed up the transfer.

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

    C++ Type:std::vector

    Options:

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

  • source_boundaryThe boundary we are transferring from (if not specified, whole domain is used).

    C++ Type:BoundaryName

    Options:

    Description:The boundary we are transferring from (if not specified, whole domain is used).

  • target_boundaryThe boundary we are transferring to (if not specified, whole domain is used).

    C++ Type:BoundaryName

    Options:

    Description:The boundary we are transferring to (if not specified, whole domain is used).

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

    C++ Type:std::vector

    Options:

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

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