MultiAppProjectionTransfer

Perform a projection between a master and sub-application mesh of a field variable.

Example Input File Syntax

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

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

[Transfers]
  [tosub]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = u
    variable = u_nodal
  []
  [elemental_tosub]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = u
    variable = u_elemental
  []
  [elemental_to_sub_elemental]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = x
    variable = x_elemental
  []
  [elemental_to_sub_nodal]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = x
    variable = x_nodal
  []
[]

/opt/civet/build_0/moose/test/tests/transfers/multiapp_projection_transfer/tosub_master.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmin = 0
  xmax = 9
  ymin = 0
  ymax = 9
  nx = 9
  ny = 9
[]

[Variables]
  [u]
  []
[]

[AuxVariables]
  [x]
    order = CONSTANT
    family = MONOMIAL
  []
[]

[Functions]
  [x_func]
    type = ParsedFunction
    value = x
  []
[]

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

[AuxKernels]
  [x_func_aux]
    type = FunctionAux
    variable = x
    function = x_func
    execute_on = initial
  []
[]

[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 = 'NEWTON'
[]

[Outputs]
  exodus = true
[]

[Debug]
#  show_actions = true
[]

[MultiApps]
  [sub]
    type = TransientMultiApp
    app_type = MooseTestApp
    execute_on = timestep_end
    positions = '1 1 0 5 5 0'
    input_files = tosub_sub.i
  []
[]

[Transfers]
  [tosub]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = u
    variable = u_nodal
  []
  [elemental_tosub]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = u
    variable = u_elemental
  []
  [elemental_to_sub_elemental]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = x
    variable = x_elemental
  []
  [elemental_to_sub_nodal]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = x
    variable = x_nodal
  []
[]

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

[Transfers]
  [v_nodal_tr]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = v
    variable = v_nodal
  []
  [v_elemental_tr]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = v
    variable = v_elemental
  []
  [x_elemental_tr]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = x
    variable = x_elemental
  []
  [x_nodal_tr]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = x
    variable = x_nodal
  []
[]

/opt/civet/build_0/moose/test/tests/transfers/multiapp_projection_transfer/fromsub_master.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmin = 0
  ymin = 0
  xmax = 9
  ymax = 9
  nx = 9
  ny = 9
[]

[Variables]
  [u]
  []
[]

[AuxVariables]
  [v_nodal]
  []
  [v_elemental]
    order = CONSTANT
    family = MONOMIAL
  []
  [x_nodal]
  []
  [x_elemental]
    order = CONSTANT
    family = MONOMIAL
  []
[]

[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 = 'NEWTON'
[]

[Outputs]
  [out]
    type = Exodus
    elemental_as_nodal = true
  []
[]

[MultiApps]
  [sub]
    type = TransientMultiApp
    app_type = MooseTestApp
    positions = '1 1 0 5 5 0'
    input_files = fromsub_sub.i
  []
[]

[Transfers]
  [v_nodal_tr]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = v
    variable = v_nodal
  []
  [v_elemental_tr]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = v
    variable = v_elemental
  []
  [x_elemental_tr]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = x
    variable = x_elemental
  []
  [x_nodal_tr]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = x
    variable = x_nodal
  []
[]

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 some information to 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 some information to 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.
proj_typel2The type of the projection.
Default:l2
C++ Type:MooseEnum
Options:l2
Description:The type of the projection.
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

test/tests/transfers/multiapp_projection_transfer/tosub_master.i
test/tests/restart/restart_subapp_not_master/two_step_solve_master.i
test/tests/transfers/multiapp_projection_transfer/high_order_master.i
test/tests/transfers/multiapp_projection_transfer/fromsub_master.i
test/tests/transfers/multiapp_projection_transfer/fixed_meshes_master.i

test/tests/transfers/multiapp_projection_transfer/tosub_master.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmin = 0
  xmax = 9
  ymin = 0
  ymax = 9
  nx = 9
  ny = 9
[]

[Variables]
  [u]
  []
[]

[AuxVariables]
  [x]
    order = CONSTANT
    family = MONOMIAL
  []
[]

[Functions]
  [x_func]
    type = ParsedFunction
    value = x
  []
[]

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

[AuxKernels]
  [x_func_aux]
    type = FunctionAux
    variable = x
    function = x_func
    execute_on = initial
  []
[]

[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 = 'NEWTON'
[]

[Outputs]
  exodus = true
[]

[Debug]
#  show_actions = true
[]

[MultiApps]
  [sub]
    type = TransientMultiApp
    app_type = MooseTestApp
    execute_on = timestep_end
    positions = '1 1 0 5 5 0'
    input_files = tosub_sub.i
  []
[]

[Transfers]
  [tosub]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = u
    variable = u_nodal
  []
  [elemental_tosub]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = u
    variable = u_elemental
  []
  [elemental_to_sub_elemental]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = x
    variable = x_elemental
  []
  [elemental_to_sub_nodal]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = x
    variable = x_nodal
  []
[]

test/tests/restart/restart_subapp_not_master/two_step_solve_master.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmin = -1
  xmax =  1
  ymin = -1
  ymax =  1
  nx = 2
  ny = 2
  elem_type = QUAD9
[]

[Functions]
  [./exact_fn]
    type = ParsedFunction
    value = t*t*(x*x+y*y)
  [../]

  [./forcing_fn]
    type = ParsedFunction
    value = 2*t*(x*x+y*y)-4*t*t
  [../]
[]

[Variables]
  [./u]
    family = LAGRANGE
    order = SECOND
  [../]
[]

[ICs]
  active = ''
  [./u_var]
    type = FunctionIC
    variable = u
    function = exact_fn
  [../]
[]

[Kernels]
  [./td]
    type = TimeDerivative
    variable = u
  [../]

  [./diff]
    type = Diffusion
    variable = u
  [../]

  [./ffn]
    type = BodyForce
    variable = u
    function = forcing_fn
  [../]
[]

[BCs]
  [./all]
    type = FunctionDirichletBC
    variable = u
    boundary = 'left right top bottom'
    function = exact_fn
  [../]
[]

[Postprocessors]
  [./average]
    type = ElementAverageValue
    variable = u
    execute_on = 'initial timestep_end'
  [../]
[]

[Executioner]
  type = Transient
  start_time = 2.0
  end_time = 4.0
  dt = 1.0
[]

[MultiApps]
  [./full_solve]
    type = FullSolveMultiApp
    execute_on = initial
    positions = '0 0 0'
    # input file will come from cli-args
  [../]
[]

[Transfers]
  [./transfer_u]
    type = MultiAppProjectionTransfer
    multi_app = full_solve
    direction = FROM_MULTIAPP
    variable = u
    source_variable = u
  [../]
[]

[Outputs]
  #file_base will come from cli-args
  exodus = true
[]

test/tests/transfers/multiapp_projection_transfer/high_order_master.i

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

[Functions]
  [./test_function]
    type = ParsedFunction
    value = '2.5*x^2 + 0.75*y^2 + 0.15*x*y'
  [../]
[]

[AuxVariables]
  [./from_sub]
    family = monomial
    order = first
  [../]
  [./test_var]
    family = monomial
    order = first
    [./InitialCondition]
      type = FunctionIC
      function = test_function
    [../]
  [../]
[]

[Variables]
  [./u]
  [../]
[]

[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 = Steady
  solve_type = PJFNK
[]

[Outputs]
  execute_on = 'timestep_end'
  exodus = true
[]

[MultiApps]
  [./sub]
    type = FullSolveMultiApp
    app_type = MooseTestApp
    execute_on = initial
    positions = '0.0 0.0 0.0'
    input_files = high_order_sub.i
  [../]
[]

[Transfers]
  [./from]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    execute_on = same_as_multiapp
    multi_app = sub
    source_variable = test_var
    variable = from_sub
  [../]
  [./to]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    execute_on = same_as_multiapp
    multi_app = sub
    source_variable = test_var
    variable = from_master
  [../]
[]

test/tests/transfers/multiapp_projection_transfer/fromsub_master.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmin = 0
  ymin = 0
  xmax = 9
  ymax = 9
  nx = 9
  ny = 9
[]

[Variables]
  [u]
  []
[]

[AuxVariables]
  [v_nodal]
  []
  [v_elemental]
    order = CONSTANT
    family = MONOMIAL
  []
  [x_nodal]
  []
  [x_elemental]
    order = CONSTANT
    family = MONOMIAL
  []
[]

[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 = 'NEWTON'
[]

[Outputs]
  [out]
    type = Exodus
    elemental_as_nodal = true
  []
[]

[MultiApps]
  [sub]
    type = TransientMultiApp
    app_type = MooseTestApp
    positions = '1 1 0 5 5 0'
    input_files = fromsub_sub.i
  []
[]

[Transfers]
  [v_nodal_tr]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = v
    variable = v_nodal
  []
  [v_elemental_tr]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = v
    variable = v_elemental
  []
  [x_elemental_tr]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = x
    variable = x_elemental
  []
  [x_nodal_tr]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = x
    variable = x_nodal
  []
[]

test/tests/transfers/multiapp_projection_transfer/fixed_meshes_master.i

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

[Variables]
  [./u]
  [../]
[]

[AuxVariables]
  [./from_sub]
  [../]
  [./elemental_from_sub]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[Kernels]
  [./diff]
    type = Diffusion
    variable = u
  [../]
  [./td]
    type = TimeDerivative
    variable = u
  [../]
[]

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

[Executioner]
  type = Transient
  num_steps = 2
  dt = 0.01
  solve_type = NEWTON
[]

[Outputs]
  exodus = true
  #
[]

[MultiApps]
  [./sub]
    type = TransientMultiApp
    app_type = MooseTestApp
    positions = '0.0 0.0 0'
    input_files = fixed_meshes_sub.i
  [../]
[]

[Transfers]
  [./from_sub]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = u
    variable = from_sub
    fixed_meshes = true
  [../]
  [./elemental_from_sub]
    type = MultiAppProjectionTransfer
    direction = from_multiapp
    multi_app = sub
    source_variable = u
    variable = elemental_from_sub
    fixed_meshes = true
  [../]
  [./to_sub]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = u
    variable = from_master
    fixed_meshes = true
  [../]
  [./elemental_to_sub]
    type = MultiAppProjectionTransfer
    direction = to_multiapp
    multi_app = sub
    source_variable = u
    variable = elemental_from_master
    fixed_meshes = true
  [../]
[]

Example Input File Syntax
Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools