- first_source_vecVector MFEMVariable U
C++ Type:VariableName
Unit:(no unit assumed)
Controllable:No
Description:Vector MFEMVariable U
- second_source_vecVector MFEMVariable V
C++ Type:VariableName
Unit:(no unit assumed)
Controllable:No
Description:Vector MFEMVariable V
- 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
MFEMDotProductAux
Summary
Project s(x) * (U . V) onto a scalar MFEM auxvariable.
Overview
AuxKernel for calculating the inner product of two vector fields and projecting onto an L2 finite element space mfem auxvariable.
where and are the two fields and is an optional scaling.
Example Input File Syntax
[AuxKernels<<<{"href": "../../../syntax/AuxKernels/index.html"}>>>]
inactive<<<{"description": "If specified blocks matching these identifiers will be skipped."}>>> = "joule_Q_aux"
[curl]
type = MFEMCurlAux<<<{"description": "Calculates the curl of an H(curl) conforming ND source variable and stores the result on an H(div) conforming RT result auxvariable", "href": "MFEMCurlAux.html"}>>>
variable<<<{"description": "The name of the variable that this object applies to"}>>> = db_dt_field
source<<<{"description": "Vector H(curl) MFEMVariable to take the curl of."}>>> = e_field
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
[]
[joule_Q_aux]
type = MFEMDotProductAux<<<{"description": "Project s(x) * (U . V) onto a scalar MFEM auxvariable.", "href": "MFEMDotProductAux.html"}>>>
variable<<<{"description": "The name of the variable that this object applies to"}>>> = joule_heating
first_source_vec<<<{"description": "Vector MFEMVariable U"}>>> = e_field
second_source_vec<<<{"description": "Vector MFEMVariable V"}>>> = e_field
scale_factor<<<{"description": "Constant multiplier applied to the dot product"}>>> = 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
[]
[]Input Parameters
- scale_factor1Constant multiplier applied to the dot product
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Constant multiplier applied to the dot product
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.