proc_allocator.py

Define the base ProcAllocator class.

exception openmdao.proc_allocators.proc_allocator.ProcAllocationError(msg, sub_inds=None)

Bases: Exception

Exception containing subsystem index information for use at higher levels.

Parameters:

msgstr

The message string.

sub_indslist of int

Indices of subsystems in _subsystems_allprocs in parent.

Attributes:

msgstr

The message string.

sub_indslist of int

Indices of subsystems in _subsystems_allprocs in parent.

__init__(msg, sub_inds=None)

Initialize all attributes.

class openmdao.proc_allocators.proc_allocator.ProcAllocator(parallel=False)

Bases: object

Algorithm for allocating processors to a given system’s subsystems.

Parameters:

parallelbool

If True, split subsystem comm.

Attributes:

parallelbool

True means the comm is split across subsystems; False means the comm is passed to all subsystems.

Methods

__call__(proc_info, nsubs, comm)

Perform the allocation if parallel.

__init__(parallel=False)

Initialize all attributes.