Generated reference › Rate Limiter Dynamic — Control Systems/Discontinuities
kind: generated#block#control-systems-discontinuities

Rate Limiter Dynamic — Control Systems/Discontinuities

Control_Systems/Discontinuities/Rate_Limiter_Dynamic · 3 input / 1 output port(s) at insert · exports to Python, MATLAB, Java, Rust, C, C++, VHDL, Verilog, SystemVerilog, PLC Structured Text

Description#

The block's own DESCRIPTION_HTML, rendered verbatim — the same text the config dialog's info panel and the library navigator show. Fix a wrong sentence in the block's .cpp (R-D9), never here.

Rate Limiter Dynamic

Control Systems / Discontinuities

Caps how fast the output may follow the input, exactly like Rate Limiter, except that the slew band arrives on input ports instead of sitting in the configuration. With y the previously held output and dt the block's sampling period:

and d = u − y the step the input is asking for:

  • d > up·dty = y + up·dt
  • d < lo·dty = y + lo·dt
  • otherwise → y = u, the demanded step already fits

Because the limits are signals they may move while the model runs, which is what the block is for – a slew schedule, a rate envelope that depends on operating point. Applied entry by entry.

Ports

  • Input 1 – up – the rising rate limit, in units per second.
  • Input 2 – u – the demanded signal. Its size is the block's output size.
  • Input 3 – lo – the falling rate limit, in units per second, and therefore negative.
  • Output – the rate-limited signal y, of the SAME size as u.

The port order up, u, lo is Simulink's for this block, top to bottom. All three inputs must carry the same signal size; a mismatch is reported and the run is stopped rather than broadcast.

Parameters

  • Sampling Time (s) – zero or less inherits the solver's rate; a positive value runs the block at that period. It converts both limit signals from rates into per-sample steps, so it is part of the arithmetic and not just the schedule. ICore-side only – see the bridge note below.

There are no other parameters: everything this block needs comes in on a port. In particular there is no initial condition: the first sample passes straight through and seeds the held output, so limiting begins on the second sample. That is the Simulink block's own behaviour, and it differs from the fixed-parameter Rate Limiter, which clamps its very first sample against its configured initial condition.

Code export

All ten targets: Python, MATLAB, Java, Rust, C, C++, VHDL, Verilog, SystemVerilog and PLC Structured Text. Only one constant is baked in – the sampling period that turns the limit signals into steps – because everything else is read from a signal at every step. The exported state is the held output itself, one value per entry, seeded from the first input sample.

The three HDL targets carry the recursion in simulation-only real arithmetic, quantizing only on the way out to the signal port, as the Sine Wave block does. That is forced by the block's shape rather than chosen for convenience: because the limits arrive as signals, the per-sample step has to be formed at run time as up · dt, and a sampling period of 0.01 s is not representable in the Q16.16 port format – it comes out as 0.0099945, a systematic error of 5.5×10−4. In a block that accumulates its own output, that bias integrates into a visible drift instead of staying at the port quantum. The fixed-parameter Rate Limiter has no such problem and stays fully fixed-point, because its step is a constant folded at export time and dt never appears in the generated core.

Simulink bridge

Import and export, mapped to simulink/Discontinuities/Rate Limiter Dynamic. There are no parameters to map in either direction; the block's whole configuration is its wiring, and the up, u, lo port order is what has to line up. "Sampling Time (s)" does NOT cross: this Simulink block has no SampleTime parameter, so the rate stays on the ICore side and an explicitly set one is reported rather than written. That matters more here than on the algebraic dynamic blocks, because the sampling period scales the slew step – two sides stepping differently produce genuinely different outputs.

Notes

  • Stateful, unlike Saturation Dynamic and Dead Zone Dynamic, which are algebraic: this block remembers where its output got to.
  • The first sample is not limited: it seeds the held output. A rig that compares only later samples would never notice a core that got this wrong.
  • Discrete by nature – the band is a step per sample, so the block always runs at its own rate rather than being pushed through a continuous solver's stages.
  • An inverted band (lo·dt above up·dt) is NOT an error here – the limits are signals, so it can happen for a single step. The step is then tested against the upper bound first and the lower bound only if that did not fire, so the upper bound wins. Every one of the ten targets resolves it the same way.
  • Not linear, and so deliberately carries no state space.

Code facts#

FactValue
registered typeControl_Systems/Discontinuities/Rate_Limiter_Dynamic
familyControl_Systems/Discontinuities
solver environment classICoreBlock_0_Control_Systems_1_Discontinuities_2_Rate_Limiter_Dynamic
sourcesrc/ICoreSDK/ICoreBlockLibrary/Blocks/Control_Systems/Discontinuities/Rate_Limiter_Dynamic/ICoreBlock_0_Control_Systems_1_Discontinuities_2_Rate_Limiter_Dynamic.cpp
headersrc/ICoreSDK/ICoreBlockLibrary/Blocks/Control_Systems/Discontinuities/Rate_Limiter_Dynamic/ICoreBlock_0_Control_Systems_1_Discontinuities_2_Rate_Limiter_Dynamic.h
default size on canvas80 × 80 px
ports at insert3 in, 1 out
code generators implementedPython, MATLAB, Java, Rust, C, C++, VHDL, Verilog, SystemVerilog, PLC Structured Text

Ports#

#DirectionSignal typeDescription label
1inICoreDoubleup
2inICoreDoubleu
3inICoreDoublelo
4outICoreDouble

Ports the constructor creates. A block whose port list changes with its configuration adds or removes ports at load time; the count above is the one a freshly inserted block has.

Configuration variables#

No config variable beyond the Sampling Time (s) every block carries.

Every block also carries Sampling Time (s) from ICoreBlockSolverEnvironment: zero or less inherits the solver's rate, a positive value runs the block at that period.

supportSupport::Both
Simulink pathsimulink/Discontinuities/Rate Limiter Dynamic
port-count rulePortsParam::None
SampleTime parameterno — the counterpart defines none; the rate stays on the ICore side

Caveat (shown to the user): the slew band arrives on ports (up, u, lo); the block runs at the surrounding Simulink rate, so "Sampling Time (s)" does not cross even though it scales the per-sample step

Catalog contract: src/ICoreSDK/ICoreCoder/ICoreCommandSystem/SimulinkBridge/ICoreSimulinkBlockCatalog.h

Description vs code#

The lists agree. check_block_descriptions.py finds no disagreement between the description's Ports, Parameters, Code export and Simulink bridge lists and the code's.

The verdict above is tools/docs/check_block_descriptions.py (P7.1), which compares LISTS. It cannot read a sentence: "stateless" on a block with a state, an initial-value semantic the recursion does not implement, a "not synthesizable" caveat the HDL banner contradicts. That is the agent audit (P7.3) on BLOCK_DESCRIPTION_AUDIT.md, and this tool's green is not a substitute for one.

File banner (developer view)#

The top comment of the block's .cpp — the maths, the realization and the export strategy, addressed to whoever changes it. It must not contradict the description above (P7.5).

Rate Limiter Dynamic block — slew limiter whose band arrives on signals With d = u - y: a step beyond up*dt or lo*dt moves y by that limit, and anything inside the band ASSIGNS u outright (y + (u - y) is not exactly u in floating point). Entry by entry, with up / u / lo on input ports 0 / 1 / 2 -- Simulink's order. The limits are RATES, so each is scaled by the sampling period to become a per-sample step. The held output starts at zero: there is no initial-condition parameter, and the R2026a block matches the static Rate Limiter with IC = 0 exactly.

The FIRST sample passes through unlimited -- the block seeds its held output with the input rather than with zero, verified directly against the R2026a block. Stateful, unlike the algebraic Saturation Dynamic it otherwise resembles. Same per-language state contract as Backlash. Discrete by nature.

The Simulink block exposes NO dialog parameters at all and no SampleTime -- verified against the R2026a block -- hence an empty params list and hasSampleTimeParam=false.

Sample results#

Rate Limiter Dynamic — Step: 0 -> 1 at t = 1 sRate Limiter Dynamic — Step: 0 -> 1 at t = 1 s024012345t (s)in ICoreDouble-Out-0in ICoreDouble-Out-0in ICoreDouble-Out-0out ICoreDouble-Out-0

The same rig also ran:

StimulusWhat it isOutput range
impulseImpulse: one sample of 1 at k = 5, 0 elsewhere (Repeating Sequence Stair)0 … 0.1
rampRamp: slope 1 from t = 00 … 17.11
sineSine Wave: amplitude 1, 2 rad/s, no phase, no bias-0.002431 … 0.9987
tableRepeating Sequence Stair: [-2 -1 -0.5 0 0.5 1 2 3], one entry per sample-2.15 … 0.3

Plotted: step — Step: 0 -> 1 at t = 1 s

Category dynamic · sample time 0.1 · 60 steps · commit ccf005c8 · produced by docsSample --out <folder> --steps 60 · data docs/generated/samples/Control_Systems__Discontinuities__Rate_Limiter_Dynamic.json · the SVG is generated from those numbers by tools/docs/plot_svg.py, so it is a run and not a drawing (R-D10).