proc_allocator.py

Define the base ProcAllocator class.

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

Bases: Exception

Exception containing subsystem index information for use at higher levels.

Attributes

msg

(str) The message string.

sub_inds

(list of int) Indices of subsystems in _subsystems_allprocs in parent.

__init__(self, msg, sub_inds=None)[source]

Initialize all attributes.

Parameters
msgstr

The message string.

sub_indslist of int

Indices of subsystems in _subsystems_allprocs in parent.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

class openmdao.proc_allocators.proc_allocator.ProcAllocator(parallel=False)[source]

Bases: object

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

Attributes

parallel

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

__init__(self, parallel=False)[source]

Initialize all attributes.

Parameters
parallelbool

If True, split subsystem comm.