Note: Clicking on the option with a triangle bullet ▸ next to it will expand/collapse its detailed information.; Type name written in PascalCase typically refer to a NEML2 object type, oftentimes a primitive tensor type.; The 🔗 symbol denotes that the option can cross-reference another object.; You can always use Ctrl+F or Cmd+F to search the entire page.

Available objects and their input file syntax

Refer to System Documentation for detailed explanation about this system.

LDISolidMechanicsDriver

Driver for solid mechanics material model with optional thermal coupling. This driver is specialized for large deformation models using the incremental formulation.

cauchy_stress_rate Cauchy stress rate

Type: variable name
Default: forces/cauchy_stress_rate

control External control of the material update. Options are MIXED STRESS STRAIN

Type: EnumSelection
Default: STRAIN

cp_warmup Whether to perform a warm-up step for crystal plasticity models. The warm-up step uses a relaxed/damped elastic predictor for the very first time step.

Type: bool
Default: false

cp_warmup_elastic_scale Elastic step scale factor used for the crystal plasticity warm-up step

Type: number
Default: 1

cp_warmup_elastic_strain Elastic strain name used for the CP warm-up step

Type: variable name
Default: state/elastic_strain

deformation_rate Deformation rate

Type: variable name
Default: forces/deformation_rate

device Device on which to evaluate the material model. The string supplied must follow the following schema: (cpu|cuda)[:<device-index>] where cpu or cuda specifies the device type, and :<device-index> 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.

Type: string
Default: cpu

ic_MillerIndex_names Apply initial conditions to these MillerIndex variables

Type: list of variable name

ic_MillerIndex_values Initial condition values for the MillerIndex variables

Type: list of MillerIndex 🔗

ic_Quaternion_names Apply initial conditions to these Quaternion variables

Type: list of variable name

ic_Quaternion_values Initial condition values for the Quaternion variables

Type: list of Quaternion 🔗

ic_R2_names Apply initial conditions to these R2 variables

Type: list of variable name

ic_R2_values Initial condition values for the R2 variables

Type: list of R2 🔗

ic_R3_names Apply initial conditions to these R3 variables

Type: list of variable name

ic_R3_values Initial condition values for the R3 variables

Type: list of R3 🔗

ic_R4_names Apply initial conditions to these R4 variables

Type: list of variable name

ic_R4_values Initial condition values for the R4 variables

Type: list of R4 🔗

ic_R5_names Apply initial conditions to these R5 variables

Type: list of variable name

ic_R5_values Initial condition values for the R5 variables

Type: list of R5 🔗

ic_R8_names Apply initial conditions to these R8 variables

Type: list of variable name

ic_R8_values Initial condition values for the R8 variables

Type: list of R8 🔗

ic_Rot_names Apply initial conditions to these Rot variables

Type: list of variable name

ic_Rot_values Initial condition values for the Rot variables

Type: list of Rot 🔗

ic_SFFR4_names Apply initial conditions to these SFFR4 variables

Type: list of variable name

ic_SFFR4_values Initial condition values for the SFFR4 variables

Type: list of SFFR4 🔗

ic_SFR3_names Apply initial conditions to these SFR3 variables

Type: list of variable name

ic_SFR3_values Initial condition values for the SFR3 variables

Type: list of SFR3 🔗

ic_SR2_names Apply initial conditions to these SR2 variables

Type: list of variable name

ic_SR2_values Initial condition values for the SR2 variables

Type: list of SR2 🔗

ic_SSFR5_names Apply initial conditions to these SSFR5 variables

Type: list of variable name

ic_SSFR5_values Initial condition values for the SSFR5 variables

Type: list of SSFR5 🔗

ic_SSR4_names Apply initial conditions to these SSR4 variables

Type: list of variable name

ic_SSR4_values Initial condition values for the SSR4 variables

Type: list of SSR4 🔗

ic_SSSSR8_names Apply initial conditions to these SSSSR8 variables

Type: list of variable name

ic_SSSSR8_values Initial condition values for the SSSSR8 variables

Type: list of SSSSR8 🔗

ic_SWR4_names Apply initial conditions to these SWR4 variables

Type: list of variable name

ic_SWR4_values Initial condition values for the SWR4 variables

Type: list of SWR4 🔗

ic_Scalar_names Apply initial conditions to these Scalar variables

Type: list of variable name

ic_Scalar_values Initial condition values for the Scalar variables

Type: list of Scalar 🔗

ic_Tensor_names Apply initial conditions to these Tensor variables

Type: list of variable name

ic_Tensor_values Initial condition values for the Tensor variables

Type: list of Tensor 🔗

ic_Vec_names Apply initial conditions to these Vec variables

Type: list of variable name

ic_Vec_values Initial condition values for the Vec variables

Type: list of Vec 🔗

ic_WR2_names Apply initial conditions to these WR2 variables

Type: list of variable name

ic_WR2_values Initial condition values for the WR2 variables

Type: list of WR2 🔗

ic_WSR4_names Apply initial conditions to these WSR4 variables

Type: list of variable name

ic_WSR4_values Initial condition values for the WSR4 variables

Type: list of WSR4 🔗

ic_WWR4_names Apply initial conditions to these WWR4 variables

Type: list of variable name

ic_WWR4_values Initial condition values for the WWR4 variables

Type: list of WWR4 🔗

mixed_control_signal The name of the control signal for mixed control on the input axis

Type: variable name
Default: forces/control

mixed_driving_force Name of mixed driving force when using mixed control

Type: variable name
Default: forces/fixed_values

model The material model to be updated by the driver

Type: string

predictor Predictor used to set the initial guess for each time step. Options are LINEAR_EXTRAPOLATION PREVIOUS_STATE

Type: EnumSelection
Default: PREVIOUS_STATE

prescribed_cauchy_stress_rate Prescribed cauchy stress rate (when control = STRESS)

Type: Tensor 🔗

prescribed_deformation_rate Prescribed deformation rate (when control = STRAIN)

Type: Tensor 🔗

prescribed_mixed_control_signal The actual values of the control signal for mixed control. 0 implies strain/deformation control, 1 implies stress control

Type: Tensor 🔗

prescribed_mixed_driving_force The fixed, controlled values provided as user input for the mixed control case. Where the control signal is 0 these are strain/deformation values, where it is 1 these are stress values

Type: Tensor 🔗

prescribed_temperature Actual prescibed temperature values, when providing temperatures to the model

Type: Tensor 🔗

prescribed_time Time steps to perform the material update. The times tensor must have at least one batch dimension representing time steps

Type: Scalar 🔗

prescribed_vorticity Prescribed vorticity

Type: Tensor 🔗

save_as File path (absolute or relative to the working directory) to store the results

Type: string

show_input_axis Whether to show model input axis at the beginning

Type: bool
Default: false

show_output_axis Whether to show model output axis at the beginning

Type: bool
Default: false

show_parameters Whether to show model parameters at the beginning

Type: bool
Default: false

temperature Name of temperature

Type: variable name
Default: forces/T

time Time

Type: variable name
Default: forces/t

verbose Whether to output additional logging information

Type: bool
Default: false

vorticity Vorticity

Type: variable name
Default: forces/vorticity

Detailed documentation link

SDTSolidMechanicsDriver

Driver for solid mechanics material model with optional thermal coupling. This driver is specialized for small deformation models using the total formulation.