SolverArray

Class SolverArray()

SolverArray(parent='MODEL', name='SolverArray_n', label='SolverArray_n', 
active=True, itype='IC', variables=None, hold_order='0', use_sampling_time=False, 
sampling_time=0, use_offset_time=False, offset_time=0, use_in_mtx=False, user=False)

Create a solver array of type U, PLANT_INPUT, PLANT_OUTPUT, IC, X, or Y.

Keyword Arguments

Argument Data Type Description Default
name String The variable name. SolverArray_n, for next available integer n.
label String The descriptive label. SolverArray_n, for next available integer n.
parent Object The parent. MODEL
active Boolean Used to activate or deactivate this entity. True
itype Enum The solver array type. One of X,Y,U,IC,PLANT_INPUT or PLANT_OUTPUT. IC
ic_scale Double Defaults to 1. * ic_offset (Double) : 0
ic_type Enum Specifies the type of data from a data file for the IC component of the curve. One of FILE, VALUE or MATH. 'ic_value'
ic_file File Filename for the IC component of the array. ''
ic_datatype String Specifies the type of data from a data file for the IC component of the curve. ''
ic_request String Specifies a request from a data file for the IC component of the curve. ''
ic_comp String Specifies a component of a request from a data file for the IC component of the curve. Defaults to ''. * ic_math (NumericVector) : A mathematical expression for the IC component of the curve. ''
ic_value NumericVector Discrete values for the IC component of the array. [0.0]
variables SolverVariable The first, second, or nth value in the series of array values or the varname of the solver variable for types U, PLANT_INPUT, and PLANT_OUTPUT. None
hold_order Enum Specifies the order of interpolation/extrapolation applied to the Plant_Input/Plant_Output signals. One of 0, 1 or 2. Defaults to '0'. * use_sampling_time (Bool) : Uses sampling time give by sampling_time parameter when True. False
sampling_time Double Specifies sample time for the Plant_Input/Plant_Output ports. 0
use_offset_time Bool Uses offset time give by offset_time parameter when True False
offset_time Double Specifies sample time offset for the Plant_Input/Plant_Output ports. 0
use_in_mtx Bool Defaults to False. * user (Bool) : Use user defined properties, if true False
usr_sub Function The expression passed to the user dll. When using solver expressions, Templex syntax (within ``) is used and all variables are enclosed in braces {} and the rest is treated as literal. 'USER()'
local_funcname String The function/subroutine name. 'MOTSUB'
use_local_dll Bool Uses a local function instead of default if True. False
local_dll File The path of the local dll which has the local_funcname. ''
local_func_type Enum The type of the user subroutine. One of DLL, PYTHON or MATLAB. 'DLL'