control.DescribingFunctionNonlinearity

class control.DescribingFunctionNonlinearity

Bases: object

Base class for nonlinear systems with a describing function.

This class is intended to be used as a base class for nonlinear functions that have an analytically defined describing function. Subclasses should override the __call__ and describing_function methods and (optionally) the _isstatic method (should be False if __call__ updates the instance state).

Methods

__call__	Evaluate the nonlinearity at a (scalar) input value.
describing_function	Return the describing function for a nonlinearity.

__call__(A)

Evaluate the nonlinearity at a (scalar) input value.

describing_function(A)

Return the describing function for a nonlinearity.

This method is used to allow analytical representations of the describing function for a nonlinearity. It turns the (complex) value of the describing function for sinusoidal input of amplitude A.

Parameters:

Afloat

Amplitude of the sinusoidal input to the nonlinearity.

Returns:

float

Value of the describing function at the given amplitude.