Optimizer Class#

class Optimizer(**kwds)#

Contains all the elements required to set up and run an optimization process.

Name

Type

Required

Default

Modifiable

accuracy

Double

0.001

active

Bool

True

\(\checkmark\)

dsa

Enum

AUTO

dtout

Double

end

Double

eqConstraints

Reference - Response [0]

fdStep

Double

0.001

fdStepType

Enum

AUTO

ineqConstraints

Reference - Response [0]

label

Str

Optimizer

log

Enum

Normal

maxit

Int

50

method

Enum

SLSQP

numProcess

Int

0

objective

Alias

objectives

Reference - Response [0]

\(\checkmark\)

plot

Bool

True

simFunction

Routine

type

Enum

STATICS

updatefdStep

Int

0

weight

Alias

weights

Double [0]

\(\checkmark\)

Name

Description

optimize (self)

Starts the Optimization process.

getDesignAndLimits (self)

Returns an array of the values and limits of all design variables in the model.

accuracy#

Accuracy to be satisfied for a successful optimization.

Type=Double, Default=0.001

active#

Defines the state of the object.

Type=Bool, Default=True, Modifiable

dsa#

Type of the DSA analysis.

See Comment 1.

Type=Enum, Default=AUTO

Permitted values are:

  • ADJOINT

  • AUTO

  • DIRECT

  • FD

  • NONE

dtout#

Output interval.

Type=Double

end#

End time for the Simulation.

Type=Double

eqConstraints#

List of equality constraints.

Type=Reference (Response) [0]

fdStep#

Size of numerical perturbation in finite differencing optimization.

See Comment 4.

Type=Double, Default=0.001

fdStepType#

Method to compute step size for the Finite Difference Method.

See Comment 4.

Type=Enum, Default=AUTO

Permitted values are:

  • AUTO

  • PROPORTIONAL

  • UNIFORM

getDesignAndLimits()#

Returns an array of the values and limits of all design variables in the model.

ineqConstraints#

List of inequality constraints.

Type=Reference (Response) [0]

label#

Label of the Optimizer.

Type=Str, Default=Optimizer

log#

Log information type.

Type=Enum, Default=Normal

Permitted values are:

  • All

  • Debug

  • Normal

maxit#

Maximum number of iterations.

Type=Int, Default=50

method#

Select one of the supported methods of scipy.optimize.minimize.

Type=Enum, Default=SLSQP

Permitted values are:

  • SLSQP

numProcess#

Specifies the number of concurrent processes spawned during the optimization run.

Type=Int, Default=0

objective#

Alias to objectives.

Type=Alias

objectives#

List of response variables to be optimized.

Type=Reference (Response) [0], Required

optimize()#

Starts the Optimization process.

plot#

Set to True to generate a plot of the responses during optimization.

Type=Bool, Default=True

simFunction#

Optional simulation function called if supplied.

Type=Routine

type#

Type of Simulation.

Type=Enum, Default=STATICS

Permitted values are:

  • DYNAMICS

  • KINEMATICS

  • QUASISTATICS

  • STATIC

  • STATICS

  • TRANSIENT

updatefdStep#

Frequency of updating the step size in finite differencing.

Type=Int, Default=0

weight#

Alias to weights.

Type=Alias

weights#

List of multiplying factors for each response variable.

Type=Double [0], Required, Default=(1,)