Information (ESI Function)
- Updated2023-03-14
- 1 minute(s) read
Information (ESI Function)
Owning Class: Callback API
Requires: Control Design and Simulation Module
Prototype
SIM_Error Information(SIM_Solver *solver, char *name, long *isFixedStepsize);
Description
Defines the name for the external solver. When called, the Information function returns the name of the external ODE solver and determines whether the solver has a fixed or variable step size. The solver name can be no greater than SIM_MAX_SOLVER_NAME_LENGTH characters in length. SIM_MAX_SOLVER_NAME_LENGTH is defined in the SIM_Solver.h file located in the labview\CCodeGen\Simulation directory. The solver name appears in the ODE Solver pull-down menu in the Configure Simulation Parameters dialog box. The Information function is the only function the Control Design and Simulation Module can call before the Initialize function or after the Finalize function.
Inputs
| Name | Description |
|---|---|
| solver | Specifies a reference to the external ODE solver. Use this reference as an input to other ESI functions. Do not modify solver directly. |
| name | Specifies the name of the solver. |
Outputs
| Name | Description |
|---|---|
| isFixedStepsize | Returns a non-zero value if the solver has a fixed step size. Otherwise, the solver has a variable step size. |
Return Value
Returns the error condition for this function.