- from_neml2The `NEML2` library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: NEML2 output variable to read from)
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The `NEML2` library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: NEML2 output variable to read from)
- neml2_executorThe `NEML2` library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: User object managing the execution of the NEML2 model.)
C++ Type:UserObjectName
Unit:(no unit assumed)
Controllable:No
Description:The `NEML2` library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: User object managing the execution of the NEML2 model.)
- to_mooseThe `NEML2` library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: MOOSE material property used to store the NEML2 output variable (or its derivative))
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:The `NEML2` library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: MOOSE material property used to store the NEML2 output variable (or its derivative))
NEML2ToMOOSEMaterialProperty
Users are NOT expected to directly use this object in an input file. Instead, it is always recommended to use the NEML2 action.
Description
This family of objects assign a NEML2 output variable given by "from_neml2" back to the quadrature points. The data is stored as a MOOSE material property with name given by "to_moose".
Note that if the "neml2_input_derivative" parameter is specified, the derivative of the NEML2 output variable with respect to the input variable is retrieved instead. If the "neml2_parameter_derivative" parameter is specified, the derivative of the NEML2 output variable with respect to the model parameter is retrieved instead.
The following flavors exist:
| Class | MOOSE MaterialProperty type |
|---|---|
NEML2ToMOOSERealMaterialProperty | Real |
NEML2ToMOOSESymmetricRankTwoTensorMaterialProperty | SymmetricRankTwoTensor |
NEML2ToMOOSESymmetricRankFourTensorMaterialProperty | SymmetricRankFourTensor |
NEML2ToMOOSEStdVectorMaterialProperty | std::vector<Real> |
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
- boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
- computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
- constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
Default:NONE
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
- declare_suffixAn optional suffix parameter that can be appended to any declared 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 declared properties. The suffix will be prepended with a '_' character.
- moose_material_property_initThe `NEML2` library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: Optional material property as the initial condition)
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:The `NEML2` library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: Optional material property as the initial condition)
- neml2_input_derivativeThe `NEML2` library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: If supplied return the derivative of the NEML2 output variable with respect to this)
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The `NEML2` library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: If supplied return the derivative of the NEML2 output variable with respect to this)
- neml2_parameter_derivativeThe `NEML2` library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: If supplied return the derivative of neml2_variable with respect to this)
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The `NEML2` library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: If supplied return the derivative of neml2_variable with respect to this)
- 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
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
- 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.
- 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.
Advanced Parameters
- output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
- outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object
Default:none
C++ Type:std::vector<OutputName>
Unit:(no unit assumed)
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object