decibels = truefalse

Specifies whether the gain-margin is in decibels or is linear. The default is the value of decibels in DynamicSystems[SystemOptions].

hertz = truefalse

parameters = set(name = complexcons) or list(name = complexcons)

Specifies numeric values for parameters in sys. These values override those specified by the parameters field of the system object, which in turn override the settings in in SystemOptions(parameters). The numeric value on the right-hand side of each equation is substituted for the name on the left-hand side in the expressions that define the model. No checking is done during the substitution to determine whether the substituted value is valid. For example, a complex value can be substituted for the coefficient of a polynomial. If the complex value had been originally assigned to the model at creation, a warning would be generated.

The GainMargin command returns the gain margin and corresponding phase-crossover frequency of the linear system sys.

This command normally returns a Matrix of lists. Each list consists of the gain-margin and associated crossover-frequency corresponding to the transfer function of each Matrix element. However, if the Matrix of transfer functions is one by one, then the single list is returned directly.

A phase-crossover frequency is a frequency at which the phase of the transfer function equals $\mathrm{\pi }$ radians (180 degrees).

If there is more than one phase-crossover frequency, then the one with the minimum gain-margin is used.

If there is no phase-crossover frequency for a transfer function, then the associated list is [Float(undefined),Float(undefined)].

For a sampled (discrete) system, the z to s transformation z = exp(s*Ts), where Ts is the sample period, is applied to the transfer function(s). The frequency range is limited to the Nyquist frequency.

$\mathrm{with}\left(\mathrm{DynamicSystems}\right)\:$

$\mathrm{sys}≔\mathrm{TransferFunction}\left(\frac{1}{{\left(1+s\right)}^3}\right)\:$

$\mathrm{GainMargin}\left(\mathrm{sys}\right)$

$\left[18.06179974\,1.732050808\right]$

$g≔\mathrm{GainMargin}\left(\mathrm{sys}\,\mathrm{decibels}=\mathrm{false}\right)$

$g≔\left[8.000000000\,1.732050808\right]$

$\mathrm{gain}≔g\left[1\right]$

$\mathrm{gain}≔8.000000000$

$\mathrm{freq}≔g\left[2\right]$

$\mathrm{freq}≔1.732050808$

$\mathrm{sys}≔\mathrm{TransferFunction}\left(⟨⟨\frac{1}{{\left(s+1\right)}^3}\,\frac{1}{s^3+4s^2+s-6}⟩⟩\right)\:$

$\mathrm{GainMargin}\left(\mathrm{sys}\right)$

$\left[\begin{array}{c}\left[18.06179974\,1.732050808\right]\\ \left[20.00000000\,1.\right]\end{array}\right]$

$\mathrm{p1}≔\mathrm{plot}\left(\left[\left[\mathrm{freq}\,0\right]\,\left[\mathrm{freq}\,-\mathrm{gain}\right]\right]\,\mathrm{color}=\mathrm{blue}\,\mathrm{thickness}=2\right)\:$

$\mathrm{p2}≔\mathrm{MagnitudePlot}\left(\mathrm{sys}\right)\:$

$\mathrm{plots}\left[\mathrm{display}\right]\left(\mathrm{p1}\,\mathrm{p2}\right)$