MultiAppMFEMShapeEvaluationTransfer

Allows transfers of MFEM variables between MFEM-based applications via local evaluation of shape functions at target nodal projection points. The variables may be defined on different meshes and FESpaces of different orders, but must share the same dimensionality, and both belong to an MFEMProblem in their respective applications.

General Description

MultiAppMFEMShapeEvaluationTransfer executes transfers in three steps:

Extraction of a vector of node positions in the ParFiniteElementSpace of the destination mfem::ParGridFunction, using MFEMNodalProjector.
Interpolation of the source mfem::ParGridFunction at this set of node locations, using mfem::FindPointsGSLIB to perform the required gather/scatter operations to obtain a set of points on the local mesh partition, and perform shape function evaluations at these points.
Projection of the evaluated source variable values onto the destination variable nodes, to set the destination variable degrees of freedom, using MFEMNodalProjector.

For transfers between identical variables defined on the same mesh, users are recommended to use MultiAppMFEMCopyTransfer for performance.

Features Supported

All MFEM to MFEM transfers executed from this class should be able to support:

transfers of scalar and vector variables
transfers between variables belonging to different finite element spaces and orders
transfers between complex variables
transfers between variables defined on submeshes and parent meshes
arbitrary number of parallel processes for both the source and target application
transfers between parent and child applications
transfers between sibling applications (child to child)
transfers from multiple variables to multiple variables

Input Parameters

source_variablesVariable(s) to transfer from.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Variable(s) to transfer from.
variablesVariable(s) to store transferred values in.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Variable(s) to store transferred values in.

Required Parameters

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. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:SAME_AS_MULTIAPP
C++ Type:ExecFlagEnum
Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, CUSTOM, SAME_AS_MULTIAPP, POST_ADAPTIVITY
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
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
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

Input Files

(test/tests/mfem/transfers/mfem_parent_mfem_sub/mfem_parent_vector.i)
(test/tests/mfem/transfers/mfem_parent_mfem_sub/mfem_parent_embedded_submesh.i)
(test/tests/mfem/transfers/mfem_parent_mfem_sub/parent.i)
(test/tests/mfem/transfers/mfem_sub_mfem_sub/parent.i)
(test/tests/mfem/transfers/mfem_parent_mfem_sub/parent_complex.i)
(test/tests/mfem/transfers/sibling_transfers/mfem_main_between_multiapp.i)

(test/tests/mfem/transfers/mfem_parent_mfem_sub/mfem_parent_vector.i)

[Mesh]
  type = MFEMMesh
  file = ../../mesh/cube.e
[]

[Problem]
  type = MFEMProblem
  solve = false
[]

[FESpaces]
  [H1FESpace]
    type = MFEMVectorFESpace
    fec_type = H1
    fec_order = FIRST
  []
  [HCurlFESpace]
    type = MFEMVectorFESpace
    fec_type = ND
    fec_order = FIRST
  []
  [HDivFESpace]
    type = MFEMVectorFESpace
    fec_type = RT
    fec_order = CONSTANT
  []
  [L2FESpace]
    type = MFEMVectorFESpace
    fec_type = L2
    fec_order = CONSTANT
  []
[]

[Variables]
  [mfem_parent_h1_vector_var]
    type = MFEMVariable
    fespace = H1FESpace
  []
  [mfem_parent_hcurl_vector_var]
    type = MFEMVariable
    fespace = HCurlFESpace
  []
  [mfem_parent_hdiv_vector_var]
    type = MFEMVariable
    fespace = HDivFESpace
  []
  [mfem_parent_l2_vector_var]
    type = MFEMVariable
    fespace = L2FESpace
  []
[]

[AuxVariables]
  [mfem_sub_h1_vector_var]
    type = MFEMVariable
    fespace = H1FESpace
  []
  [mfem_sub_hcurl_vector_var]
    type = MFEMVariable
    fespace = HCurlFESpace
  []
  [mfem_sub_hdiv_vector_var]
    type = MFEMVariable
    fespace = HDivFESpace
  []
  [mfem_sub_l2_vector_var]
    type = MFEMVariable
    fespace = L2FESpace
  []
[]

[Functions]
  [vector_field]
    type = ParsedVectorFunction
    expression_x = 'sin(pi * y)'
    expression_y = 'sin(pi * z)'
    expression_z = 'sin(pi * x)'
  []
[]

[ICs]
  [h1_vector_ic]
    type = MFEMVectorIC
    variable = mfem_parent_h1_vector_var
    vector_coefficient = vector_field
  []
  [hcurl_vector_ic]
    type = MFEMVectorIC
    variable = mfem_parent_hcurl_vector_var
    vector_coefficient = vector_field
  []
  [hdiv_vector_ic]
    type = MFEMVectorIC
    variable = mfem_parent_hdiv_vector_var
    vector_coefficient = vector_field
  []
  [l2_vector_ic]
    type = MFEMVectorIC
    variable = mfem_parent_l2_vector_var
    vector_coefficient = vector_field
  []
[]

[Executioner]
  type = MFEMSteady
  device = cpu
[]

[MultiApps]
  [mfem_app]
    type = FullSolveMultiApp
    input_files = mfem_sub_vector.i
    execute_on = 'INITIAL'
  []
[]

[Transfers]
  [transfer_from_subapp]
    type = MultiAppMFEMShapeEvaluationTransfer
    source_variables = 'mfem_sub_h1_vector_var mfem_sub_hcurl_vector_var mfem_sub_hdiv_vector_var mfem_sub_l2_vector_var'
    variables = 'mfem_sub_h1_vector_var mfem_sub_hcurl_vector_var mfem_sub_hdiv_vector_var mfem_sub_l2_vector_var'
    from_multi_app = mfem_app
  []
[]

[Postprocessors]
  [H1_Var_L2_Error]
    type = MFEMVectorL2Error
    variable = mfem_parent_h1_vector_var
    function = mfem_sub_h1_vector_var
    execute_on = TIMESTEP_END
  []
  [HCurl_Var_L2_Error]
    type = MFEMVectorL2Error
    variable = mfem_parent_hcurl_vector_var
    function = mfem_sub_hcurl_vector_var
    execute_on = TIMESTEP_END
  []
  [HDiv_Var_L2_Error]
    type = MFEMVectorL2Error
    variable = mfem_parent_hdiv_vector_var
    function = mfem_sub_hdiv_vector_var
    execute_on = TIMESTEP_END
  []
  [L2_Var_L2_Error]
    type = MFEMVectorL2Error
    variable = mfem_parent_l2_vector_var
    function = mfem_sub_l2_vector_var
    execute_on = TIMESTEP_END
  []
[]

[Outputs]
  file_base = 'mfem_parent_mfem_sub_vector_h1_hcurl_hdiv_l2_hex'
  csv = true
[]

(test/tests/mfem/transfers/mfem_parent_mfem_sub/mfem_parent_embedded_submesh.i)

[Mesh]
  type = MFEMMesh
  file = ../../mesh/cylinder-hex-q2.gen
[]

[Problem]
  type = MFEMProblem
  solve = false
[]

[FESpaces]
  [H1FESpace]
    type = MFEMScalarFESpace
    fec_type = H1
    fec_order = FIRST
  []
[]

[Variables]
  [potential]
    type = MFEMVariable
    fespace = H1FESpace
  []
[]

[Executioner]
  type = MFEMSteady
[]

[MultiApps]
  [mfem_app]
    type = FullSolveMultiApp
    input_files = mfem_sub_embedded_submesh.i
    execute_on = 'INITIAL'
  []
[]

[Transfers]
  [h1_transfer_from_subapp]
    type = MultiAppMFEMShapeEvaluationTransfer
    source_variables = submesh_potential
    variables = potential
    from_multi_app = mfem_app
  []
[]

[Outputs]
  [ParaViewDataCollection]
    type = MFEMParaViewDataCollection
    file_base = OutputData/EmbeddedSubmesh
    vtk_format = ASCII
  []
[]

(test/tests/mfem/transfers/mfem_parent_mfem_sub/parent.i)

[Mesh]
  type = MFEMMesh
  file = ../../mesh/square.msh
[]

[Problem]
  type = MFEMProblem
  solve = false
[]

[FESpaces]
  [H1FESpace]
    type = MFEMScalarFESpace
    fec_type = H1
    fec_order = FIRST
  []
[]

[AuxVariables]
  [u]
    type = MFEMVariable
    fespace = H1FESpace
  []
[]

[Executioner]
  type = MFEMSteady
[]

[MultiApps]
  [subapp]
    type = FullSolveMultiApp
    input_files = sub.i
    execute_on = INITIAL
  []
[]

[Transfers]
  active = 'copy_from_sub'
  [copy_from_sub]
    type = MultiAppMFEMCopyTransfer
    source_variables = u
    variables = u
    from_multi_app = subapp
  []
  [general_transfer_from_sub]
    type = MultiAppMFEMShapeEvaluationTransfer
    source_variables = u
    variables = u
    from_multi_app = subapp
  []
[]

[Outputs]
  [ParaViewDataCollection]
    type = MFEMParaViewDataCollection
    file_base = OutputData/Diffusion
    vtk_format = ASCII
  []
[]

(test/tests/mfem/transfers/mfem_sub_mfem_sub/parent.i)

[Mesh]
  type = MFEMMesh
  file = ../../mesh/square.msh
[]

[Problem]
  type = MFEMProblem
  solve = false
[]

[FESpaces]
  [H1FESpace]
    type = MFEMScalarFESpace
    fec_type = H1
    fec_order = FIRST
  []
[]

[MultiApps]
  [recv_app]
    type = FullSolveMultiApp
    input_files = sub_recv.i
    execute_on = FINAL
  []
  [send_app]
    type = FullSolveMultiApp
    input_files = sub_send.i
    execute_on = INITIAL
  []
[]

[Executioner]
  type = MFEMSteady
  device = cpu
[]

[Transfers]
  active = 'copy_between_sub'
  [copy_between_sub]
    type = MultiAppMFEMCopyTransfer
    source_variables = send
    variables = recv
    from_multi_app = send_app
    to_multi_app = recv_app
  []
  [general_transfer_between_sub]
    type = MultiAppMFEMShapeEvaluationTransfer
    source_variables = send
    variables = recv
    from_multi_app = send_app
    to_multi_app = recv_app
  []
[]

(test/tests/mfem/transfers/mfem_parent_mfem_sub/parent_complex.i)

[Mesh]
  type = MFEMMesh
  file = ../../mesh/square.msh
[]

[Problem]
  type = MFEMProblem
  solve = false
  numeric_type = complex
[]

[FESpaces]
  [H1FESpace]
    type = MFEMScalarFESpace
    fec_type = H1
    fec_order = FIRST
  []
[]

[AuxVariables]
  [u]
    type = MFEMComplexVariable
    fespace = H1FESpace
  []
[]

[Executioner]
  type = MFEMSteady
[]

[MultiApps]
  [subapp]
    type = FullSolveMultiApp
    input_files = sub_complex.i
    execute_on = INITIAL
  []
[]

[Transfers]
  active = 'copy_from_sub'
  [copy_from_sub]
    type = MultiAppMFEMCopyTransfer
    source_variables = u
    variables = u
    from_multi_app = subapp
  []
  [general_transfer_from_sub]
    type = MultiAppMFEMShapeEvaluationTransfer
    source_variables = u
    variables = u
    from_multi_app = subapp
  []
[]

[Outputs]
  [ParaViewDataCollection]
    type = MFEMParaViewDataCollection
    file_base = OutputData/DiffusionComplex
    vtk_format = ASCII
  []
[]

(test/tests/mfem/transfers/sibling_transfers/mfem_main_between_multiapp.i)

# Base input for testing between-multiapp transfers. It has the following complexities:
# - multiapps may not be run with the same number of ranks
# - both nodal and elemental variables
# - transfers between mixes of nodal and elemental variables
# Tests derived from this input may add or remove complexities through command line arguments

[Problem]
  type = MFEMProblem
  solve = false
[]

[Mesh]
  type = MFEMMesh
  file = ../../mesh/square_quad9.e
[]

[MultiApps]
  [mfem_send]
    type = TransientMultiApp
    input_files = mfem_sub_between_diffusion.i
  []
  [mfem_recv]
    type = TransientMultiApp
    input_files = mfem_sub_between_diffusion.i
    cli_args = Outputs/inactive=''
  []
[]

[Transfers]
  # Nodal to nodal variables
  [mfem_to_mfem_nodal_nodal]
    type = MultiAppMFEMShapeEvaluationTransfer
    from_multi_app = mfem_send
    to_multi_app = mfem_recv
    source_variables = sent_nodal
    variables = received_nodal
  []
[]

[Executioner]
  type = MFEMTransient
  num_steps = 2
[]

# Positions used to create multiple subapps for the 1 to N tests
[Positions]
  [mfem_send_locs]
    type = InputPositions
    positions = '0 0 0'
  []
  [mfem_recv_locs]
    type = InputPositions
    positions = '0 0 0
                 0.1 0.4 0
                 0.7 0.2 0'
  []
[]

[Outputs]
  file_base = OutputData/MFEMtoMFEMSiblingTransfer
[]

General Description
Features Supported
Input Parameters
Input Files