MultiAppProjectionTransfer

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

The projection mapping may be cached at the first execution of the transfer for better performance in later executions using the "fixed_meshes" parameter. This is incompatible with adaptivity and refinement of the mesh.

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
    to_multi_app = sub
    source_variable = u
    variable = u_nodal
  []
  [elemental_tosub]
    type = MultiAppProjectionTransfer
    to_multi_app = sub
    source_variable = u
    variable = u_elemental
  []
  [elemental_to_sub_elemental]
    type = MultiAppProjectionTransfer
    to_multi_app = sub
    source_variable = x
    variable = x_elemental
  []
  [elemental_to_sub_nodal]
    type = MultiAppProjectionTransfer
    to_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
    from_multi_app = sub
    source_variable = v
    variable = v_nodal
  []
  [v_elemental_tr]
    type = MultiAppProjectionTransfer
    from_multi_app = sub
    source_variable = v
    variable = v_elemental
  []
  [x_elemental_tr]
    type = MultiAppProjectionTransfer
    from_multi_app = sub
    source_variable = x
    variable = x_elemental
  []
  [x_nodal_tr]
    type = MultiAppProjectionTransfer
    from_multi_app = sub
    source_variable = x
    variable = x_nodal
  []
[]

Input Parameters

source_variableThe variable to transfer from.
C++ Type:std::vector<VariableName>
Controllable:No
Description:The variable to transfer from.
variableThe auxiliary variable to store the transferred values in.
C++ Type:std::vector<AuxVariableName>
Controllable:No
Description:The auxiliary variable to store the transferred values in.

Required Parameters

bbox_factor1Multiply bounding box width (in all directions) by the prescribed factor. Values less than 1 will shrink the bounding box; values greater than 1 will enlarge the bounding box. It is generally not advised to ever shrink the bounding box. On the other hand it may be helpful to enlarge the bounding box. Larger bounding boxes will lead to more accurate determination of the closest node/element with the tradeoff of more communication.
Default:1
C++ Type:double
Controllable:No
Description:Multiply bounding box width (in all directions) by the prescribed factor. Values less than 1 will shrink the bounding box; values greater than 1 will enlarge the bounding box. It is generally not advised to ever shrink the bounding box. On the other hand it may be helpful to enlarge the bounding box. Larger bounding boxes will lead to more accurate determination of the closest node/element with the tradeoff of more communication.
check_multiapp_execute_onTrueWhen false the check between the multiapp and transfer execute on flags is not performed.
Default:True
C++ Type:bool
Controllable:No
Description:When false the check between the multiapp and transfer execute on flags is not performed.
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, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS, SAME_AS_MULTIAPP.
Default:SAME_AS_MULTIAPP
C++ Type:ExecFlagEnum
Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS, SAME_AS_MULTIAPP
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, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS, 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
Controllable:No
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_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
proj_typel2The type of the projection.
Default:l2
C++ Type:MooseEnum
Options:l2
Controllable:No
Description:The type of the projection.
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.
skip_coordinate_collapsingTrueWhether to skip coordinate collapsing (translation and rotation are still performed, only XYZ, RZ etc collapsing is skipped) when performing mapping and inverse mapping coordinate transformation operations. This parameter should only be set by users who really know what they're doing.
Default:True
C++ Type:bool
Controllable:No
Description:Whether to skip coordinate collapsing (translation and rotation are still performed, only XYZ, RZ etc collapsing is skipped) when performing mapping and inverse mapping coordinate transformation operations. This parameter should only be set by users who really know what they're doing.
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

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
Controllable:No
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.
from_postprocessors_to_be_preservedThe name of the Postprocessor in the from-app to evaluate an adjusting factor.
C++ Type:std::vector<PostprocessorName>
Controllable:No
Description:The name of the Postprocessor in the from-app to evaluate an adjusting factor.
to_postprocessors_to_be_preservedThe name of the Postprocessor in the to-app to evaluate an adjusting factor.
C++ Type:std::vector<PostprocessorName>
Controllable:No
Description:The name of the Postprocessor in the to-app to evaluate an adjusting factor.

Conservative Transfer Parameters

(../moose/test/tests/transfers/multiapp_projection_transfer/tosub_parent.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
    expression = 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
    to_multi_app = sub
    source_variable = u
    variable = u_nodal
  []
  [elemental_tosub]
    type = MultiAppProjectionTransfer
    to_multi_app = sub
    source_variable = u
    variable = u_elemental
  []
  [elemental_to_sub_elemental]
    type = MultiAppProjectionTransfer
    to_multi_app = sub
    source_variable = x
    variable = x_elemental
  []
  [elemental_to_sub_nodal]
    type = MultiAppProjectionTransfer
    to_multi_app = sub
    source_variable = x
    variable = x_nodal
  []
[]

(../moose/test/tests/transfers/multiapp_projection_transfer/fromsub_parent.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
    from_multi_app = sub
    source_variable = v
    variable = v_nodal
  []
  [v_elemental_tr]
    type = MultiAppProjectionTransfer
    from_multi_app = sub
    source_variable = v
    variable = v_elemental
  []
  [x_elemental_tr]
    type = MultiAppProjectionTransfer
    from_multi_app = sub
    source_variable = x
    variable = x_elemental
  []
  [x_nodal_tr]
    type = MultiAppProjectionTransfer
    from_multi_app = sub
    source_variable = x
    variable = x_nodal
  []
[]