ParOpt¶
ParOpt is a nonlinear interior point optimizer that is designed for large parallel design optimization problems with structured sparse constraints.
ParOpt is open source and can be downloaded at https://github.com/gjkennedy/paropt.
Documentation and examples for ParOpt can be found at https://gjkennedy.github.io/paropt/.
ParOpt does not provide version tagging, but the commit f692160
from October 2019 has been verified to work.
Installation¶
Please follow the instructions here to install ParOpt as a separate Python package.
Make sure that the package is named paropt
and the installation location can be found by Python, so that from paropt import ParOpt
works within the pyOptSparse folder.
This typically requires installing it in a location which is already present under $PYTHONPATH
environment variable, or you can modify the .bashrc
file and manually append the path.
API¶

class
pyoptsparse.pyParOpt.ParOpt.
ParOpt
(*args, **kwargs)[source]¶ ParOpt optimizer class
ParOpt has the capability to handle distributed design vectors. This is not replicated here since pyOptSparse does not have the capability to handle this type of design problem.

__call__
(self, optProb, sens=None, sensStep=None, sensMode=None, storeHistory=None, hotStart=None, storeSens=True)[source]¶ This is the main routine used to solve the optimization problem.
Parameters:  optProb : Optimization or Solution class instance
This is the complete description of the optimization problem to be solved by the optimizer
 sens : str or python Function.
Specifiy method to compute sensitivities. To explictly use pyOptSparse gradient class to do the derivatives with finite differenes use ‘FD’. ‘sens’ may also be ‘CS’ which will cause pyOptSpare to compute the derivatives using the complex step method. Finally, ‘sens’ may be a python function handle which is expected to compute the sensitivities directly. For expensive function evaluations and/or problems with large numbers of design variables this is the preferred method.
 sensStep : float
Set the step size to use for design variables. Defaults to 1e6 when sens is ‘FD’ and 1e40j when sens is ‘CS’.
 sensMode : str
Use ‘pgc’ for parallel gradient computations. Only available with mpi4py and each objective evaluation is otherwise serial
 storeHistory : str
File name of the history file into which the history of this optimization will be stored
 hotStart : str
File name of the history file to “replay” for the optimziation. The optimization problem used to generate the history file specified in ‘hotStart’ must be IDENTICAL to the currently supplied ‘optProb’. By identical we mean, EVERY SINGLE PARAMETER MUST BE IDENTICAL. As soon as he requested evaluation point from ParOpt does not match the history, function and gradient evaluations revert back to normal evaluations.
 storeSens : bool
Flag sepcifying if sensitivities are to be stored in hist. This is necessay for hotstarting only.
