TransientDriver¶

Source: drivers/TransientDriver.py

Drive a model over a prescribed time history.

Mirrors C++ TransientDriver. See module docstring for differences.

Other options¶

model — str · required: The Model to drive over the time history.
prescribed_time — str · required: [Tensors] block name of a Scalar whose leading axis is the per-step time history.
time — str · default t: Name of the model input that receives the per-step time value.
save_as — str: Output file path. Accepted for compatibility with the C++ driver but ignored by the native runtime; results are held in memory and retrieved via result.
force_Scalar_names — list: Scalar variable names assigned a driving force value.
force_Scalar_values — list: Scalar driving force tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match force_Scalar_names.
ic_Scalar_names — list: Scalar variable names assigned an initial condition value.
ic_Scalar_values — list: Scalar initial condition tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match ic_Scalar_names.
force_Vec_names — list: Vec variable names assigned a driving force value.
force_Vec_values — list: Vec driving force tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match force_Vec_names.
ic_Vec_names — list: Vec variable names assigned an initial condition value.
ic_Vec_values — list: Vec initial condition tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match ic_Vec_names.
force_SR2_names — list: SR2 variable names assigned a driving force value.
force_SR2_values — list: SR2 driving force tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match force_SR2_names.
ic_SR2_names — list: SR2 variable names assigned an initial condition value.
ic_SR2_values — list: SR2 initial condition tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match ic_SR2_names.
force_WR2_names — list: WR2 variable names assigned a driving force value.
force_WR2_values — list: WR2 driving force tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match force_WR2_names.
ic_WR2_names — list: WR2 variable names assigned an initial condition value.
ic_WR2_values — list: WR2 initial condition tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match ic_WR2_names.
force_R2_names — list: R2 variable names assigned a driving force value.
force_R2_values — list: R2 driving force tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match force_R2_names.
ic_R2_names — list: R2 variable names assigned an initial condition value.
ic_R2_values — list: R2 initial condition tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match ic_R2_names.
force_Rot_names — list: Rot variable names assigned a driving force value.
force_Rot_values — list: Rot driving force tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match force_Rot_names.
ic_Rot_names — list: Rot variable names assigned an initial condition value.
ic_Rot_values — list: Rot initial condition tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match ic_Rot_names.
force_SSR4_names — list: SSR4 variable names assigned a driving force value.
force_SSR4_values — list: SSR4 driving force tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match force_SSR4_names.
ic_SSR4_names — list: SSR4 variable names assigned an initial condition value.
ic_SSR4_values — list: SSR4 initial condition tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match ic_SSR4_names.
force_MillerIndex_names — list: MillerIndex variable names assigned a driving force value.
force_MillerIndex_values — list: MillerIndex driving force tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match force_MillerIndex_names.
ic_MillerIndex_names — list: MillerIndex variable names assigned an initial condition value.
ic_MillerIndex_values — list: MillerIndex initial condition tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match ic_MillerIndex_names.