parametric_suite.py

class openmdao.test_suite.parametric_suite.ParameterizedInstance(group_type, **kwargs)[source]

Bases: object

Parameterized Instance for a particular ParametricTestGroup. Typically not instantiated directly, but rather through the @parametric_suite decorator.

Attributes

args (dict) Dictionary of kwargs used to construct the instance.
name (str) A “friendly” name of the instance constructed from the kwargs used.
problem (Problem) Containing Problem for the instance.
solver_class (Solver) Non-linear solver to be instantiated at the problem level.
solver_options (dict) Options to pass into the constructor for solver_class.
linear_solver_class (Solver) Linear solver to be instantiated at the problem level.
linear_solver_options (dict) Options to pass into the constructor for linear_solver_class.
__init__(group_type, **kwargs)[source]

Initialize self. See help(type(self)) for accurate signature.

compute_totals(mode='fwd')[source]

Computes the total derivatives across the model.

Parameters:
mode : str

Which mode to use for computing the total derivatives. Must be understood by Problem.setup().

Returns:
dict mapping (out,in) pairs to their associated total derivative.
setup(check=False)[source]

Creates the containing Problem and performs needed initializations.

Parameters:
check : bool

If setup should run checks.

openmdao.test_suite.parametric_suite.parametric_suite(*args, **kwargs)[source]

Decorator used for testing a range of different options for a particular ParametericTestGroup. If args is present, must only be the value ‘*’, indicating running all available groups/parameters. Otherwise, use kwargs to set the options like so:

arg=value will specify that option, arg=’*’ will vary over all default options, arg=iterable will iterate over the given options.

Arguments that are not specified will have a reasonable default chosen.