Solver API (ESI Category)
- Updated2023-03-14
- 2 minute(s) read
Requires: Control Design and Simulation Module
Use members of the Solver API category to get and set information about the solver. Use these functions to obtain or supply solver information and to obtain references to states, derivatives, and other simulation information.
| Function | Description |
|---|---|
| SIM_SolverGetAbsoluteTolerance | Returns the absolute tolerance for the simulation. |
| SIM_SolverGetData | Returns a pointer to data you allocate with the SIM_SolverSetData function. Call the SIM_SolverSetData function during the Initialize function to allocate data and set a pointer to that data. |
| SIM_SolverGetDerivatives | Returns a pointer to the derivatives of the states of the ODE solver. |
| SIM_SolverGetIsAcceptedStep | Indicates whether the LabVIEW Control Design and Simulation Module accepted the previous major step. |
| SIM_SolverGetIsFixedStepsize | Indicates whether the ODE solver has a fixed step size. |
| SIM_SolverGetIsMajorStep | Indicates whether the current step is a major step. |
| SIM_SolverGetLastMajorOutput | Returns a pointer to the value of the states at the previous accepted major step. |
| SIM_SolverGetMaximumStepSize | Returns the maximum allowable step size for the ODE solver. You can set the maximum step size on the Simulation Parameters page of the Configure Simulation Parameters dialog box. |
| SIM_SolverGetMinimumStepSize | Returns the minimum allowable step size for the ODE solver. You can set the minimum step size on the Simulation Parameters page of the Configure Simulation Parameters dialog box. |
| SIM_SolverGetNumContinuousStates | Returns the number of continuous states of the model. |
| SIM_SolverGetRelativeTolerance | Returns the relative tolerance for the ordinary differential equation (ODE) solver. You can set the relative tolerance in the Configure Simulation Parameters dialog box. |
| SIM_SolverGetStates | Returns a pointer to the continuous states of the model. |
| SIM_SolverSetData | Stores a pointer to data you allocate during the Initialize function. Use the SIM_SolverGetData function to retrieve this pointer. |
| SIM_SolverSetIsMajorStep | Specifies whether the current step is a major step. Call this function within the UpdateStates function. |
| SIM_SolverSetStepsize | Specifies the ideal step size for the next step of the simulation. Use this function within the EvaluateError function. |