MultiAppPostprocessorInterpolationTransfer

Transfer postprocessor data from sub-application into field data on the master application.

Overview

Performs a transfer of a PostProcessor value from sub-applications to a field variable on the parent application using interpolation based on the location of each sub-application.

Example Input File Syntax

The following input file snippet demonstrates the use of the MultiAppPostprocessorInterpolationTransfer to interpolate the average value from two sub-applications to a field variable in the parent application.

[Transfers]
  [pp_transfer]
    postprocessor = average
    variable = from_sub
    type = MultiAppPostprocessorInterpolationTransfer
    from_multi_app = sub
  []
[]
(../../../SoftwareDownloads/moose/test/tests/transfers/multiapp_postprocessor_interpolation_transfer/parent.i)

Input Parameters

  • postprocessorThe Postprocessor to interpolate.

    C++ Type:PostprocessorName

    Controllable:No

    Description:The Postprocessor to interpolate.

  • variableThe auxiliary variable to store the transferred values in.

    C++ Type:AuxVariableName

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

  • 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

  • interp_typeinverse_distanceThe algorithm to use for interpolation.

    Default:inverse_distance

    C++ Type:MooseEnum

    Options:inverse_distance, radial_basis

    Controllable:No

    Description:The algorithm to use for interpolation.

  • num_points3The number of nearest points to use for interpolation.

    Default:3

    C++ Type:unsigned int

    Controllable:No

    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

    Controllable:No

    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

    Controllable:No

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

  • 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

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