andes.core.block.LagRate#

class andes.core.block.LagRate(u, T, K, rate_lower, rate_upper, D=1, rate_no_lower=False, rate_no_upper=False, rate_lower_cond=None, rate_upper_cond=None, name=None, tex_name=None, info=None)[source]#

Lag (low pass filter) transfer function block with a rate limiter.

             / rate_upper
       ┌────────┐
       │    K   │
  u -> │ ────── │ -> y
       │ D + sT │
       └────────┘
rate_lower /

Exports one state variable y as the output and one AntiWindupRate instance lim.

Parameters:
K

Gain

T

Time constant

D

Constant

u

Input variable

__init__(u, T, K, rate_lower, rate_upper, D=1, rate_no_lower=False, rate_no_upper=False, rate_lower_cond=None, rate_upper_cond=None, name=None, tex_name=None, info=None)[source]#

Methods

define()

Notes

enforce_tex_name(fields)

Enforce tex_name is not None

export()

Method for exporting instances defined in this class in a dictionary.

f_numeric(**kwargs)

Function call to update differential equation values.

g_numeric(**kwargs)

Function call to update algebraic equation values.

j_numeric(**kwargs)

Per-iteration numerical Jacobian update.

j_reset()

Helper function to clear the lists holding the numerical Jacobians.

j_setup()

One-time Jacobian sparsity pattern and constant value setup.

Attributes

class_name

Return the class name.