SolverDiffeq
Class SolverDiffeq()
SolverDiffeq(parent='MODEL', name='SolverDiffeq_n', label='SolverDiffeq_n',
active=True, static_hold=False, implicit=False, ic=0, ic_dot=0))
Creates a solver differential equation.
Keyword Arguments
Argument | Data Type | Description | Default |
---|---|---|---|
name | String | The variable name. | SolverDiffeq_n, for next available integer n. |
label | String | The descriptive label. | SolverDiffeq_n, for next available integer n. |
parent | Object | The parent. | MODEL |
active | Boolean | Used to activate or deactivate this entity. | True |
static_hold | Boolean | Set STATIC_HOLD if the state of the differential equation is not permitted to change during static and quasi:static analysis of the solver. Otherwise, leave blank by including two commas to hold the space. | False |
implicit | Boolean | Specifies whether the differential equation is of type implicit or explicit. | False |
ic | Double | The initial condition of the differential equation. | 0 |
ic_dot | Double | The initial condition for the first derivative of the user defined variable. This is optional and is usually used in conjunction with an implicit variable. | 0 |
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' |
Instances
value (Nonlinear) : The function expression which describes the differential equation.
Examples
>>> from hw import mview
>>> # Create a solver diffeq
>>> sde = mview.SolverDiffeq()
>>> sde.implicit
False
>>> sde.value.expr = '`DIF1(sde_equation.id) + 8.0 + COS(TIME)`'
>>> sde.ic_dot = 2
>>> sde.ic_dot
2.0