MultiAppInterpolationTransfer

The MultiAppInterpolationTransfer transfers the source variable to the nearest node on the target mesh using mesh interpolation, including the ability to utilize the displaced configuration for either or both the source and target.

Example Syntax

[Transfers]
  [./fromsub]
    type = MultiAppInterpolationTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = u
    variable = from_sub
  [../]
[]
(test/tests/transfers/multiapp_interpolation_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<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.

  • distance_tol1e-10If the distance between two points is smaller than distance_tol, two points will be considered as identical

    Default:1e-10

    C++ Type:double

    Options:

    Description:If the distance between two points is smaller than distance_tol, two points will be considered as identical

  • exclude_gap_blocksGap subdomains we want to exclude when constructing/using virtually translated points

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

    Options:

    Description:Gap subdomains we want to exclude when constructing/using virtually translated points

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

  • interp_typeinverse_distanceThe algorithm to use for interpolation.

    Default:inverse_distance

    C++ Type:MooseEnum

    Options:inverse_distance, radial_basis

    Description:The algorithm to use for interpolation.

  • num_points3The number of nearest points to use for interpolation.

    Default:3

    C++ Type:unsigned int

    Options:

    Description:The number of nearest points to use for interpolation.

  • power2The polynomial power to use for calculation of the decay in the interpolation.

    Default:2

    C++ Type:double

    Options:

    Description:The polynomial power to use for calculation of the decay in the interpolation.

  • radius-1Radius to use for radial_basis interpolation. If negative then the radius is taken as the max distance between points.

    Default:-1

    C++ Type:double

    Options:

    Description:Radius to use for radial_basis interpolation. If negative then the radius is taken as the max distance between points.

  • shrink_gap_width0gap width with which we want to temporarily shrink mesh in transfering solution

    Default:0

    C++ Type:double

    Options:

    Description:gap width with which we want to temporarily shrink mesh in transfering solution

  • shrink_meshSOURCEWhich mesh we want to shrink

    Default:SOURCE

    C++ Type:MooseEnum

    Options:SOURCE, TARGET

    Description:Which mesh we want to shrink

  • 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