- assemblyThe NEML2Assembly object to use to provide assembly information
C++ Type:UserObjectName
Controllable:No
Description:The NEML2Assembly object to use to provide assembly information
- displacementsThe displacements variables whose function space will be used to define the test functions.
C++ Type:std::vector<NonlinearVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The displacements variables whose function space will be used to define the test functions.
- executorThe NEML2ModelExecutor used to perform the constitutive update (where stress is an output variable). If you are using the NEML2 action, the parameter executor_name can be used to specify the name of the NEML2ModelExecutor.
C++ Type:UserObjectName
Controllable:No
Description:The NEML2ModelExecutor used to perform the constitutive update (where stress is an output variable). If you are using the NEML2 action, the parameter executor_name can be used to specify the name of the NEML2ModelExecutor.
- feThe NEML2FEInterpolation object to use to couple variables
C++ Type:UserObjectName
Controllable:No
Description:The NEML2FEInterpolation object to use to couple variables
- residualThe tag for the residual
C++ Type:std::string
Controllable:No
Description:The tag for the residual
- stressThe name of the NEML2 variable to use as the stress.
C++ Type:std::string
Controllable:No
Description:The name of the NEML2 variable to use as the stress.
NEML2StressDivergence
For a batch of material points, calculate the residual at each point in the form of , for where is the number of displacement variables.
The kernel then assembles the integrated residual into the global residual vector.
Limitations
The current weak form is Cartesian-only; hoop/metric terms for axisymmetric or spherical coordinates are not present.
This object assembles residuals only; no Jacobian contributions are produced. This system currently targets only explicit solves.
Requires 1-3 displacement variables and uses the test functions from those variables' FE spaces.
Pair this with a matching, block-restricted
NEML2Assembly/NEML2FEInterpolationif you have mixed element types/orders.
Syntax
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.
Material Property Retrieval Parameters
Example input files
Input Files
- (modules/solid_mechanics/test/tests/neml2/explicit_dynamics/neml2_adaptivity.i)
- (modules/solid_mechanics/test/tests/neml2/explicit_dynamics/neml2.i)
The detailed documentation of this object/syntax is only available when MOOSE is compiled with NEML2. To enable NEML2, please follow the NEML2 installation guide.