parallel_fd_group.py

Defines the base class for a Group in OpenMDAO.

class openmdao.core.parallel_fd_group.ParallelFDGroup(num_par_fds)[source]

Bases: openmdao.core.group.Group

A Group that can do finite difference in parallel.

Args:

num_par_fds : int(1)

Number of FD’s to perform in parallel. If num_par_fds is 1, this just behaves like a normal Group.

Options:

fd_options[‘force_fd’] : bool(True)

Set to True to finite difference this system.

fd_options[‘form’] : str(‘forward’)

Finite difference mode. (forward, backward, central) You can also set to ‘complex_step’ to perform the complex step method if your components support it.

fd_options[‘step_size’] : float(1e-06)

Default finite difference stepsize

fd_options[‘step_type’] : str(‘absolute’)

Set to absolute, relative

fd_options[‘extra_check_partials_form’] : None or str

Finite difference mode: (“forward”, “backward”, “central”, “complex_step”) During check_partial_derivatives, you can optionally do a second finite difference with a different mode.

fd_options[‘linearize’] : bool(False)

Set to True if you want linearize to be called even though you are using FD.

get_req_procs()[source]
Returns:

tuple

A tuple of the form (min_procs, max_procs), indicating the min and max processors usable by this Group.