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. When set, run() writes the result here (the same flat dict result returns, via save_result); empty (the default) leaves run() side-effect-free.
prescribed_Scalar_names — list: Scalar variable names assigned a prescribed value.
prescribed_Scalar_values — list: Scalar prescribed tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match prescribed_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.
prescribed_Vec_names — list: Vec variable names assigned a prescribed value.
prescribed_Vec_values — list: Vec prescribed tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match prescribed_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.
prescribed_SR2_names — list: SR2 variable names assigned a prescribed value.
prescribed_SR2_values — list: SR2 prescribed tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match prescribed_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.
prescribed_WR2_names — list: WR2 variable names assigned a prescribed value.
prescribed_WR2_values — list: WR2 prescribed tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match prescribed_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.
prescribed_R2_names — list: R2 variable names assigned a prescribed value.
prescribed_R2_values — list: R2 prescribed tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match prescribed_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.
prescribed_MRP_names — list: MRP variable names assigned a prescribed value.
prescribed_MRP_values — list: MRP prescribed tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match prescribed_MRP_names.
ic_MRP_names — list: MRP variable names assigned an initial condition value.
ic_MRP_values — list: MRP initial condition tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match ic_MRP_names.
prescribed_SSR4_names — list: SSR4 variable names assigned a prescribed value.
prescribed_SSR4_values — list: SSR4 prescribed tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match prescribed_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.
prescribed_MillerIndex_names — list: MillerIndex variable names assigned a prescribed value.
prescribed_MillerIndex_values — list: MillerIndex prescribed tokens. Each is either an inline Scalar literal (Scalar only) or a [Tensors] block name. Length must match prescribed_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.