doe_driver.py

Design-of-Experiments Driver.

class openmdao.drivers.doe_driver.DOEDriver(generator=None, **kwargs)

Bases: Driver

Design-of-Experiments Driver.

Parameters:

generatorDOEGenerator, list or None

The case generator or a list of DOE cases.

**kwargsdict of keyword arguments

Keyword arguments that will be mapped into the Driver options.

Attributes:

_namestr

The name used to identify this driver in recorded cases.

_problem_commMPI.Comm or None

The MPI communicator for the Problem.

_colorint or None

In MPI, the cached color is used to determine which cases to run on this proc.

_indep_listlist

List of design variables, used to compute derivatives.

_quantitieslist

Contains the objectives plus nonlinear constraints, used to compute derivatives.

Methods

add_recorder(recorder)	Add a recorder to the driver.
check_relevance()	Check if there are constraints that don't depend on any design vars.
cleanup()	Clean up resources prior to exit.
compute_lagrange_multipliers([...])	Get the approximated Lagrange multipliers of one or more constraints.
declare_coloring([num_full_jacs, tol, ...])	Set options for total deriv coloring.
get_coloring_fname([mode])	Get the filename for the coloring file.
get_constraint_values([ctype, lintype, ...])	Return constraint values.
get_design_var_values([get_remote, ...])	Return the design variable values.
get_driver_derivative_calls()	Return number of derivative evaluations made during a driver run.
get_driver_objective_calls()	Return number of objective evaluations made during a driver run.
get_exit_status()	Return exit status of driver run.
get_objective_values([driver_scaling])	Return objective values.
get_reports_dir()	Get the path to the directory where the report files should go.
record_derivatives()	Record the current total jacobian.
record_iteration()	Record an iteration of the current Driver.
run()	Generate cases and run the model for each set of generated input values.
scaling_report([outfile, title, ...])	Generate a self-contained html file containing a detailed connection viewer.
set_design_var(name, value[, set_remote])	Set the value of a design variable.
use_fixed_coloring([coloring])	Tell the driver to use a precomputed coloring.

__init__(generator=None, **kwargs)

Construct A DOEDriver.

run()

Generate cases and run the model for each set of generated input values.

Returns:

bool

Failure flag; True if failed to converge, False is successful.