NEML2 2.0.0
•All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
[Drivers]

Table of Contents

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 means that the tensor value can be cross-reference another object. See Model parameters (revisited) for details.
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.

async_dispatch Whether to dispatch work asynchronously

  • Type: bool
  • Default: true
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
force_MillerIndex_names Prescribed driving force of tensor type MillerIndex

  • Type: list of variable name
force_MillerIndex_values Prescribed driving force values of tensor type MillerIndex

  • Type: list of MillerIndex 🔗
force_Quaternion_names Prescribed driving force of tensor type Quaternion

  • Type: list of variable name
force_Quaternion_values Prescribed driving force values of tensor type Quaternion

  • Type: list of Quaternion 🔗
force_R2_names Prescribed driving force of tensor type R2

  • Type: list of variable name
force_R2_values Prescribed driving force values of tensor type R2

  • Type: list of R2 🔗
force_R3_names Prescribed driving force of tensor type R3

  • Type: list of variable name
force_R3_values Prescribed driving force values of tensor type R3

  • Type: list of R3 🔗
force_R4_names Prescribed driving force of tensor type R4

  • Type: list of variable name
force_R4_values Prescribed driving force values of tensor type R4

  • Type: list of R4 🔗
force_R5_names Prescribed driving force of tensor type R5

  • Type: list of variable name
force_R5_values Prescribed driving force values of tensor type R5

  • Type: list of R5 🔗
force_R8_names Prescribed driving force of tensor type R8

  • Type: list of variable name
force_R8_values Prescribed driving force values of tensor type R8

  • Type: list of R8 🔗
force_Rot_names Prescribed driving force of tensor type Rot

  • Type: list of variable name
force_Rot_values Prescribed driving force values of tensor type Rot

  • Type: list of Rot 🔗
force_SFFR4_names Prescribed driving force of tensor type SFFR4

  • Type: list of variable name
force_SFFR4_values Prescribed driving force values of tensor type SFFR4

  • Type: list of SFFR4 🔗
force_SFR3_names Prescribed driving force of tensor type SFR3

  • Type: list of variable name
force_SFR3_values Prescribed driving force values of tensor type SFR3

  • Type: list of SFR3 🔗
force_SFR4_names Prescribed driving force of tensor type SFR4

  • Type: list of variable name
force_SFR4_values Prescribed driving force values of tensor type SFR4

  • Type: list of SFR4 🔗
force_SR2_names Prescribed driving force of tensor type SR2

  • Type: list of variable name
force_SR2_values Prescribed driving force values of tensor type SR2

  • Type: list of SR2 🔗
force_SSFR5_names Prescribed driving force of tensor type SSFR5

  • Type: list of variable name
force_SSFR5_values Prescribed driving force values of tensor type SSFR5

  • Type: list of SSFR5 🔗
force_SSR4_names Prescribed driving force of tensor type SSR4

  • Type: list of variable name
force_SSR4_values Prescribed driving force values of tensor type SSR4

  • Type: list of SSR4 🔗
force_SSSSR8_names Prescribed driving force of tensor type SSSSR8

  • Type: list of variable name
force_SSSSR8_values Prescribed driving force values of tensor type SSSSR8

  • Type: list of SSSSR8 🔗
force_SWR4_names Prescribed driving force of tensor type SWR4

  • Type: list of variable name
force_SWR4_values Prescribed driving force values of tensor type SWR4

  • Type: list of SWR4 🔗
force_Scalar_names Prescribed driving force of tensor type Scalar

  • Type: list of variable name
force_Scalar_values Prescribed driving force values of tensor type Scalar

  • Type: list of Scalar 🔗
force_Tensor_names Prescribed driving force of tensor type Tensor

  • Type: list of variable name
force_Tensor_values Prescribed driving force values of tensor type Tensor

  • Type: list of Tensor 🔗
force_Vec_names Prescribed driving force of tensor type Vec

  • Type: list of variable name
force_Vec_values Prescribed driving force values of tensor type Vec

  • Type: list of Vec 🔗
force_WFR4_names Prescribed driving force of tensor type WFR4

  • Type: list of variable name
force_WFR4_values Prescribed driving force values of tensor type WFR4

  • Type: list of WFR4 🔗
force_WR2_names Prescribed driving force of tensor type WR2

  • Type: list of variable name
force_WR2_values Prescribed driving force values of tensor type WR2

  • Type: list of WR2 🔗
force_WSR4_names Prescribed driving force of tensor type WSR4

  • Type: list of variable name
force_WSR4_values Prescribed driving force values of tensor type WSR4

  • Type: list of WSR4 🔗
force_WWR4_names Prescribed driving force of tensor type WWR4

  • Type: list of variable name
force_WWR4_values Prescribed driving force values of tensor type WWR4

  • Type: list of WWR4 🔗
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_SFR4_names Apply initial conditions to these SFR4 variables

  • Type: list of variable name
ic_SFR4_values Initial condition values for the SFR4 variables

  • Type: list of SFR4 🔗
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_WFR4_names Apply initial conditions to these WFR4 variables

  • Type: list of variable name
ic_WFR4_values Initial condition values for the WFR4 variables

  • Type: list of WFR4 🔗
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: SR2 🔗
prescribed_deformation_rate Prescribed deformation rate (when control = STRAIN)

  • Type: SR2 🔗
prescribed_mixed_control_signal The actual values of the control signal for mixed control. 0 implies strain/deformation control, 1 implies stress control

  • Type: SR2 🔗
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: SR2 🔗
prescribed_temperature Actual prescibed temperature values, when providing temperatures to the model

  • Type: Scalar 🔗
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: WR2 🔗
random_seed Random seed for any random number generation

  • Type: number
save_as File path (absolute or relative to the working directory) to store the results

  • Type: string
scheduler The work scheduler to use

  • 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.

async_dispatch Whether to dispatch work asynchronously

  • Type: bool
  • Default: true
control External control of the material update. Options are MIXED STRESS STRAIN

  • Type: EnumSelection
  • Default: STRAIN
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
force_MillerIndex_names Prescribed driving force of tensor type MillerIndex

  • Type: list of variable name
force_MillerIndex_values Prescribed driving force values of tensor type MillerIndex

  • Type: list of MillerIndex 🔗
force_Quaternion_names Prescribed driving force of tensor type Quaternion

  • Type: list of variable name
force_Quaternion_values Prescribed driving force values of tensor type Quaternion

  • Type: list of Quaternion 🔗
force_R2_names Prescribed driving force of tensor type R2

  • Type: list of variable name
force_R2_values Prescribed driving force values of tensor type R2

  • Type: list of R2 🔗
force_R3_names Prescribed driving force of tensor type R3

  • Type: list of variable name
force_R3_values Prescribed driving force values of tensor type R3

  • Type: list of R3 🔗
force_R4_names Prescribed driving force of tensor type R4

  • Type: list of variable name
force_R4_values Prescribed driving force values of tensor type R4

  • Type: list of R4 🔗
force_R5_names Prescribed driving force of tensor type R5

  • Type: list of variable name
force_R5_values Prescribed driving force values of tensor type R5

  • Type: list of R5 🔗
force_R8_names Prescribed driving force of tensor type R8

  • Type: list of variable name
force_R8_values Prescribed driving force values of tensor type R8

  • Type: list of R8 🔗
force_Rot_names Prescribed driving force of tensor type Rot

  • Type: list of variable name
force_Rot_values Prescribed driving force values of tensor type Rot

  • Type: list of Rot 🔗
force_SFFR4_names Prescribed driving force of tensor type SFFR4

  • Type: list of variable name
force_SFFR4_values Prescribed driving force values of tensor type SFFR4

  • Type: list of SFFR4 🔗
force_SFR3_names Prescribed driving force of tensor type SFR3

  • Type: list of variable name
force_SFR3_values Prescribed driving force values of tensor type SFR3

  • Type: list of SFR3 🔗
force_SFR4_names Prescribed driving force of tensor type SFR4

  • Type: list of variable name
force_SFR4_values Prescribed driving force values of tensor type SFR4

  • Type: list of SFR4 🔗
force_SR2_names Prescribed driving force of tensor type SR2

  • Type: list of variable name
force_SR2_values Prescribed driving force values of tensor type SR2

  • Type: list of SR2 🔗
force_SSFR5_names Prescribed driving force of tensor type SSFR5

  • Type: list of variable name
force_SSFR5_values Prescribed driving force values of tensor type SSFR5

  • Type: list of SSFR5 🔗
force_SSR4_names Prescribed driving force of tensor type SSR4

  • Type: list of variable name
force_SSR4_values Prescribed driving force values of tensor type SSR4

  • Type: list of SSR4 🔗
force_SSSSR8_names Prescribed driving force of tensor type SSSSR8

  • Type: list of variable name
force_SSSSR8_values Prescribed driving force values of tensor type SSSSR8

  • Type: list of SSSSR8 🔗
force_SWR4_names Prescribed driving force of tensor type SWR4

  • Type: list of variable name
force_SWR4_values Prescribed driving force values of tensor type SWR4

  • Type: list of SWR4 🔗
force_Scalar_names Prescribed driving force of tensor type Scalar

  • Type: list of variable name
force_Scalar_values Prescribed driving force values of tensor type Scalar

  • Type: list of Scalar 🔗
force_Tensor_names Prescribed driving force of tensor type Tensor

  • Type: list of variable name
force_Tensor_values Prescribed driving force values of tensor type Tensor

  • Type: list of Tensor 🔗
force_Vec_names Prescribed driving force of tensor type Vec

  • Type: list of variable name
force_Vec_values Prescribed driving force values of tensor type Vec

  • Type: list of Vec 🔗
force_WFR4_names Prescribed driving force of tensor type WFR4

  • Type: list of variable name
force_WFR4_values Prescribed driving force values of tensor type WFR4

  • Type: list of WFR4 🔗
force_WR2_names Prescribed driving force of tensor type WR2

  • Type: list of variable name
force_WR2_values Prescribed driving force values of tensor type WR2

  • Type: list of WR2 🔗
force_WSR4_names Prescribed driving force of tensor type WSR4

  • Type: list of variable name
force_WSR4_values Prescribed driving force values of tensor type WSR4

  • Type: list of WSR4 🔗
force_WWR4_names Prescribed driving force of tensor type WWR4

  • Type: list of variable name
force_WWR4_values Prescribed driving force values of tensor type WWR4

  • Type: list of WWR4 🔗
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_SFR4_names Apply initial conditions to these SFR4 variables

  • Type: list of variable name
ic_SFR4_values Initial condition values for the SFR4 variables

  • Type: list of SFR4 🔗
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_WFR4_names Apply initial conditions to these WFR4 variables

  • Type: list of variable name
ic_WFR4_values Initial condition values for the WFR4 variables

  • Type: list of WFR4 🔗
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_mixed_control_signal The actual values of the control signal for mixed control. 0 implies strain/deformation control, 1 implies stress control

  • Type: SR2 🔗
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: SR2 🔗
prescribed_strain Prescribed strain (when control = STRAIN)

  • Type: SR2 🔗
prescribed_stress Prescribed stress (when control = STRESS)

  • Type: SR2 🔗
prescribed_temperature Actual prescibed temperature values, when providing temperatures to the model

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

  • Type: Scalar 🔗
random_seed Random seed for any random number generation

  • Type: number
save_as File path (absolute or relative to the working directory) to store the results

  • Type: string
scheduler The work scheduler to use

  • 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
strain Name of the strain used to drive the update

  • Type: variable name
  • Default: forces/E
stress Name of the stress used to drive the update

  • Type: variable name
  • Default: forces/S
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

Detailed documentation link

TransientDriver

Driver for simulating the transient response of an autonomous system.

async_dispatch Whether to dispatch work asynchronously

  • Type: bool
  • Default: true
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
force_MillerIndex_names Prescribed driving force of tensor type MillerIndex

  • Type: list of variable name
force_MillerIndex_values Prescribed driving force values of tensor type MillerIndex

  • Type: list of MillerIndex 🔗
force_Quaternion_names Prescribed driving force of tensor type Quaternion

  • Type: list of variable name
force_Quaternion_values Prescribed driving force values of tensor type Quaternion

  • Type: list of Quaternion 🔗
force_R2_names Prescribed driving force of tensor type R2

  • Type: list of variable name
force_R2_values Prescribed driving force values of tensor type R2

  • Type: list of R2 🔗
force_R3_names Prescribed driving force of tensor type R3

  • Type: list of variable name
force_R3_values Prescribed driving force values of tensor type R3

  • Type: list of R3 🔗
force_R4_names Prescribed driving force of tensor type R4

  • Type: list of variable name
force_R4_values Prescribed driving force values of tensor type R4

  • Type: list of R4 🔗
force_R5_names Prescribed driving force of tensor type R5

  • Type: list of variable name
force_R5_values Prescribed driving force values of tensor type R5

  • Type: list of R5 🔗
force_R8_names Prescribed driving force of tensor type R8

  • Type: list of variable name
force_R8_values Prescribed driving force values of tensor type R8

  • Type: list of R8 🔗
force_Rot_names Prescribed driving force of tensor type Rot

  • Type: list of variable name
force_Rot_values Prescribed driving force values of tensor type Rot

  • Type: list of Rot 🔗
force_SFFR4_names Prescribed driving force of tensor type SFFR4

  • Type: list of variable name
force_SFFR4_values Prescribed driving force values of tensor type SFFR4

  • Type: list of SFFR4 🔗
force_SFR3_names Prescribed driving force of tensor type SFR3

  • Type: list of variable name
force_SFR3_values Prescribed driving force values of tensor type SFR3

  • Type: list of SFR3 🔗
force_SFR4_names Prescribed driving force of tensor type SFR4

  • Type: list of variable name
force_SFR4_values Prescribed driving force values of tensor type SFR4

  • Type: list of SFR4 🔗
force_SR2_names Prescribed driving force of tensor type SR2

  • Type: list of variable name
force_SR2_values Prescribed driving force values of tensor type SR2

  • Type: list of SR2 🔗
force_SSFR5_names Prescribed driving force of tensor type SSFR5

  • Type: list of variable name
force_SSFR5_values Prescribed driving force values of tensor type SSFR5

  • Type: list of SSFR5 🔗
force_SSR4_names Prescribed driving force of tensor type SSR4

  • Type: list of variable name
force_SSR4_values Prescribed driving force values of tensor type SSR4

  • Type: list of SSR4 🔗
force_SSSSR8_names Prescribed driving force of tensor type SSSSR8

  • Type: list of variable name
force_SSSSR8_values Prescribed driving force values of tensor type SSSSR8

  • Type: list of SSSSR8 🔗
force_SWR4_names Prescribed driving force of tensor type SWR4

  • Type: list of variable name
force_SWR4_values Prescribed driving force values of tensor type SWR4

  • Type: list of SWR4 🔗
force_Scalar_names Prescribed driving force of tensor type Scalar

  • Type: list of variable name
force_Scalar_values Prescribed driving force values of tensor type Scalar

  • Type: list of Scalar 🔗
force_Tensor_names Prescribed driving force of tensor type Tensor

  • Type: list of variable name
force_Tensor_values Prescribed driving force values of tensor type Tensor

  • Type: list of Tensor 🔗
force_Vec_names Prescribed driving force of tensor type Vec

  • Type: list of variable name
force_Vec_values Prescribed driving force values of tensor type Vec

  • Type: list of Vec 🔗
force_WFR4_names Prescribed driving force of tensor type WFR4

  • Type: list of variable name
force_WFR4_values Prescribed driving force values of tensor type WFR4

  • Type: list of WFR4 🔗
force_WR2_names Prescribed driving force of tensor type WR2

  • Type: list of variable name
force_WR2_values Prescribed driving force values of tensor type WR2

  • Type: list of WR2 🔗
force_WSR4_names Prescribed driving force of tensor type WSR4

  • Type: list of variable name
force_WSR4_values Prescribed driving force values of tensor type WSR4

  • Type: list of WSR4 🔗
force_WWR4_names Prescribed driving force of tensor type WWR4

  • Type: list of variable name
force_WWR4_values Prescribed driving force values of tensor type WWR4

  • Type: list of WWR4 🔗
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_SFR4_names Apply initial conditions to these SFR4 variables

  • Type: list of variable name
ic_SFR4_values Initial condition values for the SFR4 variables

  • Type: list of SFR4 🔗
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_WFR4_names Apply initial conditions to these WFR4 variables

  • Type: list of variable name
ic_WFR4_values Initial condition values for the WFR4 variables

  • Type: list of WFR4 🔗
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 🔗
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_time Time steps to perform the material update. The times tensor must have at least one batch dimension representing time steps

  • Type: Scalar 🔗
random_seed Random seed for any random number generation

  • Type: number
save_as File path (absolute or relative to the working directory) to store the results

  • Type: string
scheduler The work scheduler to use

  • 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
time Time

  • Type: variable name
  • Default: forces/t
verbose Whether to output additional logging information

  • Type: bool
  • Default: false

Detailed documentation link