Function rc_filter_get_saturation_flag¶
Defined in File filter.h
Function Documentation¶
-
int rc_filter_get_saturation_flag(rc_filter_t *f)¶
Checks if the filter saturated the last time step.
This information could also be retrieved by looking at the ‘sat_flag’ value in the filter struct.
- Parameters
f – Pointer to user’s rc_filter_t struct
- Returns
Returns 1 if the filter saturated the last time step. Returns 0 otherwise.