Source code for openmdao.core.basic_impl
"""Basic vector and data transfer implementation factory."""
from openmdao.core.vec_wrapper import SrcVecWrapper, TgtVecWrapper
from openmdao.core.data_transfer import DataTransfer
from openmdao.core.mpi_wrap import FakeComm
[docs]class BasicImpl(object):
"""Basic vector and data transfer implementation factory."""
idx_arr_type = int
@staticmethod
[docs] def world_comm():
return FakeComm()
@staticmethod
[docs] def create_src_vecwrapper(sysdata, comm):
"""
Create a vecwrapper for source variables.
Args
----
sysdata : _SysData
A data object for System level data.
comm : a fake communicator or None.
This arg is ignored.
Returns
-------
`SrcVecWrapper`
"""
return SrcVecWrapper(sysdata, comm)
@staticmethod
[docs] def create_tgt_vecwrapper(sysdata, comm):
"""
Create a vecwrapper for target variables.
Args
-----
sysdata : _SysData
A data object for system level data
comm : a fake communicator or None.
This arg is ignored.
Returns
-------
`TgtVecWrapper`
"""
return TgtVecWrapper(sysdata, comm)
@staticmethod
[docs] def create_data_xfer(src_vec, tgt_vec,
src_idxs, tgt_idxs, vec_conns, byobj_conns,
mode, sysdata):
"""
Create an object for performing data transfer between source
and target vectors.
Args
----
src_vec : `VecWrapper`
Source vecwrapper for the transfer. In rev mode it will be the
target.
tgt_vec : `VecWrapper`
Target vecwrapper for the transfer. In rev mode it will be the
source.
src_idxs : array
Indices of the source variables in the source vector.
tgt_idxs : array
Indices of the target variables in the target vector.
vec_conns : dict
Mapping of 'pass by vector' variables to the source variables that
they are connected to.
byobj_conns : dict
Mapping of 'pass by object' variables to the source variables that
they are connected to.
mode : str
Either 'fwd' or 'rev', indicating a forward or reverse scatter.
sysdata : `SysData` object
The `SysData` object for the Group that will contain the new
`DataTransfer` object.
Returns
-------
`DataTransfer`
A `DataTransfer` object.
"""
return DataTransfer(src_idxs, tgt_idxs, vec_conns, byobj_conns, mode,
sysdata)
