- modelName of the NEML2 model, i.e., the string inside the brackets [] in the NEML2 input file that corresponds to the model you want to use.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Name of the NEML2 model, i.e., the string inside the brackets [] in the NEML2 input file that corresponds to the model you want to use.
CauchyStressFromNEML2UO
To use this object, you need to have the NEML2 library installed. Refer to the documentation for guidance on how to enable it. To build this library MOOSE must be configured with LIBTORCH support! (Original description: Gather input variables required for an objective stress integration from all quadrature points. The batched input vector is sent through a NEML2 material model to perform the constitutive update.)
Description
This object uses the specified NEML2 material model to perform mesh-wise batched material update. The input material properties and variables at all quadrature points on the mesh are first gathered together, then the NEML2 material model is used to map the inputs (strain, temperature, time, etc.) to the outputs (stress etc.). The material model's forward operator is defined in the NEML2 input file. The outputs are gathered into an internal data structure, and a CauchyStressFromNEML2Receiver object is required to assign the outputs to their corresponding material properties.
Example Input Syntax
Input Parameters
- blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
- devicecpuDevice on which to evaluate the NEML2 model. The string supplied must follow the following schema: (cpu|cuda)[:
] where cpu or cuda specifies the device type, and : optionally specifies a device index. For example, device='cpu' sets the target compute device to be CPU, and device='cuda:1' sets the target compute device to be CUDA with device ID 1. Default:cpu
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Device on which to evaluate the NEML2 model. The string supplied must follow the following schema: (cpu|cuda)[:
] where cpu or cuda specifies the device type, and : optionally specifies a device index. For example, device='cpu' sets the target compute device to be CPU, and device='cuda:1' sets the target compute device to be CUDA with device ID 1. - enable_ADFalseSet to true to enable PyTorch AD. When set to false (default), no function graph or gradient is computed, which speeds up model evaluation.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Set to true to enable PyTorch AD. When set to false (default), no function graph or gradient is computed, which speeds up model evaluation.
- execute_onINITIAL LINEAR NONLINEARThe 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:INITIAL LINEAR NONLINEAR
C++ Type:ExecFlagEnum
Unit:(no unit assumed)
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.
- mechanical_strainmechanical_strainName of the mechanical strain material property.
Default:mechanical_strain
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:Name of the mechanical strain material property.
- neml2_strainENEML2 variable accessor for strain
Default:E
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:NEML2 variable accessor for strain
- neml2_stressSNEML2 variable accessor for stress
Default:S
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:NEML2 variable accessor for stress
- neml2_temperatureTNEML2 variable accessor for temperature
Default:T
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:NEML2 variable accessor for temperature
- neml2_timetNEML2 variable accessor for time
Default:t
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:NEML2 variable accessor for time
- 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.
- scalar_material_property_namesNames of the material properties (gathered from MOOSE) whose values are used to set parameter values in the NEML2 material model.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Names of the material properties (gathered from MOOSE) whose values are used to set parameter values in the NEML2 material model.
- scalar_material_property_valuesThe list of userobjects for scalar-valued material properties. These userobjects should be of type BatchPropertyDerivativeRankTwoTensorReal. The property values gathered by each of the userobject will be used as parameter values in the NEML2 material model, and the derivatives of the Cauchy stress w.r.t. each of the parameter will be set into the corresponding userobject.
C++ Type:std::vector<UserObjectName>
Unit:(no unit assumed)
Controllable:No
Description:The list of userobjects for scalar-valued material properties. These userobjects should be of type BatchPropertyDerivativeRankTwoTensorReal. The property values gathered by each of the userobject will be used as parameter values in the NEML2 material model, and the derivatives of the Cauchy stress w.r.t. each of the parameter will be set into the corresponding userobject.
- temperatureThe temperature
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The temperature
- 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
Unit:(no unit assumed)
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.
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
Unit:(no unit assumed)
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).
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- 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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
- implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form
- seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:The seed for the master random number generator
- 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
Unit:(no unit assumed)
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.