Event Output Functions

Event Output Functions

Table 11 lists the event output functions. These functions allow you to retrieve the events after they occur. Note that event handling requires a Butcher Table that has dense output.

Table 11 Event Output Functions.

Usage

cvTE = pInteg->GetEventTimes();

Arguments

None.

Return Value

Notes

This function returns a list of all the event times that have been logged by the integrator. There should be one corresponding event state vector for each of these times. These values will be repeated in the output returned by GetTOut( if OutputEventsInYOut() has been called.

Usage

mxYE = pInteg->GetEventStates();

Arguments

None.

Return Value

Notes

This function returns a matrix with all of the logged event values of the state vector. Each column of the matrix is a column vector with the computed state values at each event that has been logged so far. These values will be repeated in the output returned by GetYOut( if OutputEventsInYOut() has been called.

Usage

cvIE = pInteg->GetEventIndex();

Arguments

None.

Return Value

Notes

This function returns a list of all the event indices for the event times that have been logged by the integrator. Each element of the vector is an integer corresponding to which event has occurred (see Section for a discussion of event states). This allows you to track which events occurred at which time, and what those events were.