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

[Transfers]
  [pp_transfer]
    direction = from_multiapp
    postprocessor = average
    variable = from_sub
    type = MultiAppPostprocessorInterpolationTransfer
    multi_app = sub
  []
[]

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.
postprocessorThe Postprocessor to interpolate.
C++ Type:PostprocessorName
Options:
Description:The Postprocessor to interpolate.
variableThe auxiliary variable to store the transferred values in.
C++ Type:AuxVariableName
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.
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.

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

(moose/test/tests/transfers/multiapp_postprocessor_interpolation_transfer/master.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
[]

[Variables]
  [u]
  []
[]

[AuxVariables]
  [from_sub]
  []
[]

[Kernels]
  [diff]
    type = Diffusion
    variable = u
  []
[]

[BCs]
  [left]
    type = DirichletBC
    variable = u
    boundary = left
    value = 0
  []
  [right]
    type = DirichletBC
    variable = u
    boundary = right
    value = 1
  []
[]

[Executioner]
  type = Transient
  num_steps = 1
  dt = 1

  solve_type = 'PJFNK'

  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = true
[]

[MultiApps]
  [sub]
    positions = '0.2 0.2 0 0.7 0.7 0'
    type = TransientMultiApp
    app_type = MooseTestApp
    input_files = 'sub0.i sub1.i'
  []
[]

[Transfers]
  [pp_transfer]
    direction = from_multiapp
    postprocessor = average
    variable = from_sub
    type = MultiAppPostprocessorInterpolationTransfer
    multi_app = sub
  []
[]

Overview
Example Input File Syntax
Input Parameters