- first_source_variableFirst variable to sum.
C++ Type:VariableName
Unit:(no unit assumed)
Controllable:No
Description:First variable to sum.
- second_source_variableSecond variable to sum.
C++ Type:VariableName
Unit:(no unit assumed)
Controllable:No
Description:Second variable 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
MFEMSumAux
Summary
Calculates the sum of two variables sharing an FE space, each optionally scaled by a real constant, and stores the result in a third.
Overview
AuxKernel for calculating the sum of two MFEM variables that are defined on the same finite element space, and storing the result in a third. Both variables may be (optionally) scaled by a real scalar constant prior to addition.
where 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 two variables sharing an FE space, each optionally scaled by a real constant, and stores the result in a third.", "href": "MFEMSumAux.html"}>>>
variable<<<{"description": "The name of the variable that this object applies to"}>>> = e_field
first_source_variable<<<{"description": "First variable to sum."}>>> = induced_e_field
second_source_variable<<<{"description": "Second variable to sum."}>>> = 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
execution_order_group<<<{"description": "Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group."}>>> = 3
[]
[]Input Parameters
- first_scale_factor1Factor to scale the first variable by prior to sum.
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Factor to scale the first variable by prior to sum.
- second_scale_factor1Factor to scale the second variable by prior to sum.
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Factor to scale the second variable by prior to sum.
Optional Parameters
- allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
- 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
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.
- execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
- force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
- force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
- force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
Execution Scheduling 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:Yes
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
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
- prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
- use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.