[Drivers]

Table of Contents

• Available objects and their input file syntax
  • TransientDriver

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.

TransientDriver

Driver for simulating the transient response of an autonomous system.

async_dispatch Whether to dispatch work asynchronously

• Type: bool
• Required: No
• 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
• Required: No
• Default: cpu

force_MillerIndex_names Prescribed driving force of tensor type MillerIndex

• Type: list of string
• Required: No

force_MillerIndex_values Prescribed driving force values of tensor type MillerIndex

• Type: list of MillerIndex> 🔗
• Required: No

force_Quaternion_names Prescribed driving force of tensor type Quaternion

• Type: list of string
• Required: No

force_Quaternion_values Prescribed driving force values of tensor type Quaternion

• Type: list of Quaternion> 🔗
• Required: No

force_R2_names Prescribed driving force of tensor type R2

• Type: list of string
• Required: No

force_R2_values Prescribed driving force values of tensor type R2

• Type: list of R2> 🔗
• Required: No

force_R3_names Prescribed driving force of tensor type R3

• Type: list of string
• Required: No

force_R3_values Prescribed driving force values of tensor type R3

• Type: list of R3> 🔗
• Required: No

force_R4_names Prescribed driving force of tensor type R4

• Type: list of string
• Required: No

force_R4_values Prescribed driving force values of tensor type R4

• Type: list of R4> 🔗
• Required: No

force_Rot_names Prescribed driving force of tensor type Rot

• Type: list of string
• Required: No

force_Rot_values Prescribed driving force values of tensor type Rot

• Type: list of Rot> 🔗
• Required: No

force_SFFR4_names Prescribed driving force of tensor type SFFR4

• Type: list of string
• Required: No

force_SFFR4_values Prescribed driving force values of tensor type SFFR4

• Type: list of SFFR4> 🔗
• Required: No

force_SFR3_names Prescribed driving force of tensor type SFR3

• Type: list of string
• Required: No

force_SFR3_values Prescribed driving force values of tensor type SFR3

• Type: list of SFR3> 🔗
• Required: No

force_SR2_names Prescribed driving force of tensor type SR2

• Type: list of string
• Required: No

force_SR2_values Prescribed driving force values of tensor type SR2

• Type: list of SR2> 🔗
• Required: No

force_SSR4_names Prescribed driving force of tensor type SSR4

• Type: list of string
• Required: No

force_SSR4_values Prescribed driving force values of tensor type SSR4

• Type: list of SSR4> 🔗
• Required: No

force_SWR4_names Prescribed driving force of tensor type SWR4

• Type: list of string
• Required: No

force_SWR4_values Prescribed driving force values of tensor type SWR4

• Type: list of SWR4> 🔗
• Required: No

force_Scalar_names Prescribed driving force of tensor type Scalar

• Type: list of string
• Required: No

force_Scalar_values Prescribed driving force values of tensor type Scalar

• Type: list of Scalar> 🔗
• Required: No

force_Tensor_names Prescribed driving force of tensor type Tensor

• Type: list of string
• Required: No

force_Tensor_values Prescribed driving force values of tensor type Tensor

• Type: list of Tensor> 🔗
• Required: No

force_Vec_names Prescribed driving force of tensor type Vec

• Type: list of string
• Required: No

force_Vec_values Prescribed driving force values of tensor type Vec

• Type: list of Vec> 🔗
• Required: No

force_WFFR4_names Prescribed driving force of tensor type WFFR4

• Type: list of string
• Required: No

force_WFFR4_values Prescribed driving force values of tensor type WFFR4

• Type: list of WFFR4> 🔗
• Required: No

force_WR2_names Prescribed driving force of tensor type WR2

• Type: list of string
• Required: No

force_WR2_values Prescribed driving force values of tensor type WR2

• Type: list of WR2> 🔗
• Required: No

force_WSR4_names Prescribed driving force of tensor type WSR4

• Type: list of string
• Required: No

force_WSR4_values Prescribed driving force values of tensor type WSR4

• Type: list of WSR4> 🔗
• Required: No

force_WWR4_names Prescribed driving force of tensor type WWR4

• Type: list of string
• Required: No

force_WWR4_values Prescribed driving force values of tensor type WWR4

• Type: list of WWR4> 🔗
• Required: No

ic_MillerIndex_names Apply initial conditions to these MillerIndex variables

• Type: list of string
• Required: No

ic_MillerIndex_values Initial condition values for the MillerIndex variables

• Type: list of MillerIndex> 🔗
• Required: No

ic_Quaternion_names Apply initial conditions to these Quaternion variables

• Type: list of string
• Required: No

ic_Quaternion_values Initial condition values for the Quaternion variables

• Type: list of Quaternion> 🔗
• Required: No

ic_R2_names Apply initial conditions to these R2 variables

• Type: list of string
• Required: No

ic_R2_values Initial condition values for the R2 variables

• Type: list of R2> 🔗
• Required: No

ic_R3_names Apply initial conditions to these R3 variables

• Type: list of string
• Required: No

ic_R3_values Initial condition values for the R3 variables

• Type: list of R3> 🔗
• Required: No

ic_R4_names Apply initial conditions to these R4 variables

• Type: list of string
• Required: No

ic_R4_values Initial condition values for the R4 variables

• Type: list of R4> 🔗
• Required: No

ic_Rot_names Apply initial conditions to these Rot variables

• Type: list of string
• Required: No

ic_Rot_values Initial condition values for the Rot variables

• Type: list of Rot> 🔗
• Required: No

ic_SFFR4_names Apply initial conditions to these SFFR4 variables

• Type: list of string
• Required: No

ic_SFFR4_values Initial condition values for the SFFR4 variables

• Type: list of SFFR4> 🔗
• Required: No

ic_SFR3_names Apply initial conditions to these SFR3 variables

• Type: list of string
• Required: No

ic_SFR3_values Initial condition values for the SFR3 variables

• Type: list of SFR3> 🔗
• Required: No

ic_SR2_names Apply initial conditions to these SR2 variables

• Type: list of string
• Required: No

ic_SR2_values Initial condition values for the SR2 variables

• Type: list of SR2> 🔗
• Required: No

ic_SSR4_names Apply initial conditions to these SSR4 variables

• Type: list of string
• Required: No

ic_SSR4_values Initial condition values for the SSR4 variables

• Type: list of SSR4> 🔗
• Required: No

ic_SWR4_names Apply initial conditions to these SWR4 variables

• Type: list of string
• Required: No

ic_SWR4_values Initial condition values for the SWR4 variables

• Type: list of SWR4> 🔗
• Required: No

ic_Scalar_names Apply initial conditions to these Scalar variables

• Type: list of string
• Required: No

ic_Scalar_values Initial condition values for the Scalar variables

• Type: list of Scalar> 🔗
• Required: No

ic_Tensor_names Apply initial conditions to these Tensor variables

• Type: list of string
• Required: No

ic_Tensor_values Initial condition values for the Tensor variables

• Type: list of Tensor> 🔗
• Required: No

ic_Vec_names Apply initial conditions to these Vec variables

• Type: list of string
• Required: No

ic_Vec_values Initial condition values for the Vec variables

• Type: list of Vec> 🔗
• Required: No

ic_WFFR4_names Apply initial conditions to these WFFR4 variables

• Type: list of string
• Required: No

ic_WFFR4_values Initial condition values for the WFFR4 variables

• Type: list of WFFR4> 🔗
• Required: No

ic_WR2_names Apply initial conditions to these WR2 variables

• Type: list of string
• Required: No

ic_WR2_values Initial condition values for the WR2 variables

• Type: list of WR2> 🔗
• Required: No

ic_WSR4_names Apply initial conditions to these WSR4 variables

• Type: list of string
• Required: No

ic_WSR4_values Initial condition values for the WSR4 variables

• Type: list of WSR4> 🔗
• Required: No

ic_WWR4_names Apply initial conditions to these WWR4 variables

• Type: list of string
• Required: No

ic_WWR4_values Initial condition values for the WWR4 variables

• Type: list of WWR4> 🔗
• Required: No

model The model to be updated by the driver

• Type: string
• Required: Yes

postprocessor The postprocessor model to be applied on the model output

• Type: string
• Required: No

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

• Type: Scalar 🔗
• Required: Yes

random_seed Random seed for any random number generation

• Type: number
• Required: No

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

• Type: string
• Required: No

scheduler The work scheduler to use

• Type: string
• Required: No

time Time

• Type: string
• Required: No
• Default: t

verbose Whether to output additional logging information

• Type: bool
• Required: No
• Default: false

Detailed documentation link