Main Content

sdo.requirements.PZDampingRatio

Damping ratio bound

expand all in page

Description

Specify bounds on the damping ratio of the poles of a linear system. You can then optimize the model response to meet these bounds using sdo.optimize. You can also use this object to specify overshoot bound.

You must have Simulink® Control Design™ software to specify damping ratio requirements.

Creation

Syntax

dampReq = sdo.requirements.PZDampingRatio
dampReq = sdo.requirements.PZDampingRatio(Name=Value)

Description

dampReq = sdo.requirements.PZDampingRatio creates a sdo.requirements.PZDampingRatio object and assigns default values to its properties.

example

dampReq = sdo.requirements.PZDampingRatio(Name=Value) specifies one or more properties using name-value arguments. For example, dampReq = sdo.requirements.PZDampingRatio(DampingRatio=0.8) creates an sdo.requirements.PZDampingRatio object and sets the damping ratio to 0.8

Before R2021a, use commas to separate each name and value, and enclose Name in quotes. For example, dampReq = sdo.requirements.PZDampingRatio("DampingRatio",0.8) creates an sdo.requirements.PZDampingRatio object and sets the damping ratio to 0.8.

example

Properties

expand all

Damping ratio bound, specified as a finite scalar between 0 and 1.

Requirement description, specified as a character vector. For example, 'Requirement on signal 1'.

Requirement name, specified as a character vector.

Damping ratio bound type, specified as one of the following:

  • '<=' — Upper bound

  • '>=' — Lower bound

  • '==' — Equality bound

  • 'max' — Maximization objective

Object Functions

setOvershootSet overshoot of sdo.requirements.PZDampingRatio object
getOvershootGet overshoot from sdo.requirements.PZDampingRatio object
evalRequirementEvaluate design requirement
copyCopy design requirement
getGet design requirement property values
setSet design requirement property values

Examples

collapse all

Open Live Script

Construct a damping ratio object and specify the damping ratio.

r = sdo.requirements.PZDampingRatio;
r.DampingRatio = 0.1;

Alternatively, you can specify the damping ratio during construction.

r = sdo.requirements.PZDampingRatio('DampingRatio',0.1);

Alternatives

Use getbounds to get the bounds specified in a Check Pole-Zero Characteristics (Simulink Control Design) block.

Version History

Introduced in R2010b

See Also

Topics