andes.core.block.WashoutOrLag

class andes.core.block.WashoutOrLag(u, T, K, name=None, zero_out=True, tex_name=None, info=None)

Washout with the capability to convert to Lag when K = 0.

Can be enabled with zero_out. Need to provide name to construct.

Exports state x (symbol x'), output algebraic variable y, and a LessThan block LT.

Parameters:

zero_outbool, optional

If True, sT will become 1, and the washout will become a low-pass filter. If False, functions as a regular Washout.

__init__(u, T, K, name=None, zero_out=True, tex_name=None, info=None)

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.