MFEMSumAux

Overview

AuxKernel for calculating the sum of two or more MFEM variables that are defined on the same finite element space, and storing the result in another. All variables may be (optionally) scaled by a real scalar constant prior to addition.

where and are defined on the same FE space, and are real scalar constants.

Example Input File Syntax

[AuxKernels<<<{"href": "../../../syntax/AuxKernels/index.html"}>>>]
  [update_induced_e_field]
    type = MFEMGradAux<<<{"description": "Calculates the gradient of an H1 conforming source variable and stores the result on an H(curl) conforming ND result auxvariable", "href": "MFEMGradAux.html"}>>>
    variable<<<{"description": "The name of the variable that this object applies to"}>>> = induced_e_field
    source<<<{"description": "Scalar H1 MFEMVariable to take the gradient of."}>>> = induced_potential
    scale_factor<<<{"description": "Factor to scale result auxvariable by."}>>> = -1.0
    execute_on<<<{"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."}>>> = TIMESTEP_END
  []
  [update_external_e_field]
    type = MFEMGradAux<<<{"description": "Calculates the gradient of an H1 conforming source variable and stores the result on an H(curl) conforming ND result auxvariable", "href": "MFEMGradAux.html"}>>>
    variable<<<{"description": "The name of the variable that this object applies to"}>>> = transition_external_e_field
    source<<<{"description": "Scalar H1 MFEMVariable to take the gradient of."}>>> = transition_external_potential
    scale_factor<<<{"description": "Factor to scale result auxvariable by."}>>> = -1.0
    execute_on<<<{"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."}>>> = TIMESTEP_END
  []
  [update_total_e_field]
    type = MFEMSumAux<<<{"description": "Calculates the sum of an arbitrary number of variables sharing an FE space, each optionally scaled by a real constant, and stores the result in an auxiliary variable.", "href": "MFEMSumAux.html"}>>>
    variable<<<{"description": "The name of the variable that this object applies to"}>>> = e_field
    source_variables<<<{"description": "The names of the MFEM variables to sum"}>>> = 'induced_e_field external_e_field'
    execute_on<<<{"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."}>>> = TIMESTEP_END
  []
[]
(test/tests/mfem/submeshes/cut_closed_coil.i)

Input Parameters

  • source_variablesThe names of the MFEM variables to sum

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:The names of the MFEM variables to sum

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name of the variable that this object applies to

Required Parameters

  • execute_onTIMESTEP_ENDThe 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:TIMESTEP_END

    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

    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.

  • scale_factorsThe factors to scale each MFEM variable by during summation

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The factors to scale each MFEM variable by during summation

Optional Parameters

  • 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:No

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files