Optimzer

class pyoptsparse.pyOpt_optimizer.Optimizer(name=None, category=None, defOptions=None, informs=None, **kwargs)

Base optimizer class

Parameters:

name : str

Optimizer name

category : str

Typically local or global

defOptions : dictionary

A dictionary containing the default options

informs : dict

Dictionary of the inform codes

getInform(self, infocode=None)

Get optimizer result inform code at exit

Parameters:

infocode : int

Integer information code

getOption(self, name)

Return the optimizer option value for name

Parameters:

name : str

name of option for which to retrieve value

Returns:

value : varies

value of option for ‘name’

setOption(self, name, value=None)

Generic routine for all option setting. The routine does error checking on the type of the value.

Parameters:

name : str

Name of the option to set

value : varies

Variable value to set.

pyoptsparse.pyOpt_optimizer.OPT(optName, *args, **kwargs)

This is a simple utility function that enables creating an optimizer based on the ‘optName’ string. This can be useful for doing optimization studies with respect to optimizer since you don’t need massive if-statements.

Parameters:

optName : str

String identifying the optimizer to create

*args, **kwargs : varies

Passed to optimizer creation.

Returns:

opt : pyOpt_optimizer inherited optimizer

The desired optimizer