- coefficientThe vector coefficient. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a numeric vector value (enclosed in curly braces).
C++ Type:MFEMVectorCoefficientName
Controllable:No
Description:The vector coefficient. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a numeric vector value (enclosed in curly braces).
- variableThe variable to apply the initial condition on.
C++ Type:VariableName
Unit:(no unit assumed)
Controllable:No
Description:The variable to apply the initial condition on.
MFEMVectorIC
Summary
Sets the initial values of an MFEM vector variable from a user-specified vector coefficient.
Overview
MFEMVectorIC is used to set initial conditions of vector valued MFEM variables from an mfem::VectorCoefficient. The initial condition will be applied on all subdomains in the mesh.
Example Input File Syntax
[ICs<<<{"href": "../../../syntax/ICs/index.html"}>>>]
[h1_vector_ic]
type = MFEMVectorIC<<<{"description": "Sets the initial values of an MFEM vector variable from a user-specified vector coefficient.", "href": "MFEMVectorIC.html"}>>>
variable<<<{"description": "The variable to apply the initial condition on."}>>> = h1_vector
coefficient<<<{"description": "The vector coefficient. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a numeric vector value (enclosed in curly braces)."}>>> = external_vector_field
[]
[l2_vector_ic]
type = MFEMVectorIC<<<{"description": "Sets the initial values of an MFEM vector variable from a user-specified vector coefficient.", "href": "MFEMVectorIC.html"}>>>
variable<<<{"description": "The variable to apply the initial condition on."}>>> = l2_vector
coefficient<<<{"description": "The vector coefficient. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a numeric vector value (enclosed in curly braces)."}>>> = external_vector_field
[]
[nd_vector_ic]
type = MFEMVectorIC<<<{"description": "Sets the initial values of an MFEM vector variable from a user-specified vector coefficient.", "href": "MFEMVectorIC.html"}>>>
variable<<<{"description": "The variable to apply the initial condition on."}>>> = nd_vector
coefficient<<<{"description": "The vector coefficient. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a numeric vector value (enclosed in curly braces)."}>>> = external_vector_field
[]
[rt_vector_ic]
type = MFEMVectorIC<<<{"description": "Sets the initial values of an MFEM vector variable from a user-specified vector coefficient.", "href": "MFEMVectorIC.html"}>>>
variable<<<{"description": "The variable to apply the initial condition on."}>>> = rt_vector
coefficient<<<{"description": "The vector coefficient. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a numeric vector value (enclosed in curly braces)."}>>> = external_vector_field
[]
[]Input 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).
- 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.