Module PyMPDATA_MPI.impl.mpi_boundary_condition

common base class for MPI boundary conditions

""" common base class for MPI boundary conditions """

from PyMPDATA_MPI.impl.boundary_condition_commons import make_scalar_boundary_condition


class MPIBoundaryCondition:
    """common base class for MPI boundary conditions"""

    def __init__(self, base, size, mpi_dim):
        self.__mpi_size_one = size == 1
        self.worker_pool_size = size
        self.base = base
        self.mpi_dim = mpi_dim

    @staticmethod
    def make_get_peer(_, __):
        """returns (lru-cached) numba-compiled callable."""
        raise NotImplementedError()

    # pylint: disable=too-many-arguments
    def make_scalar(self, indexers, halo, dtype, jit_flags, dimension_index):
        """returns (lru-cached) Numba-compiled scalar halo-filling callable"""
        if self.__mpi_size_one:
            return self.base.make_scalar(
                indexers, halo, dtype, jit_flags, dimension_index
            )
        return make_scalar_boundary_condition(
            indexers=indexers,
            jit_flags=jit_flags,
            dimension_index=dimension_index,
            dtype=dtype,
            get_peer=self.make_get_peer(jit_flags, self.worker_pool_size),
            mpi_dim=self.mpi_dim,
        )

Classes

class MPIBoundaryCondition (base, size, mpi_dim)

common base class for MPI boundary conditions

Expand source code

class MPIBoundaryCondition:
    """common base class for MPI boundary conditions"""

    def __init__(self, base, size, mpi_dim):
        self.__mpi_size_one = size == 1
        self.worker_pool_size = size
        self.base = base
        self.mpi_dim = mpi_dim

    @staticmethod
    def make_get_peer(_, __):
        """returns (lru-cached) numba-compiled callable."""
        raise NotImplementedError()

    # pylint: disable=too-many-arguments
    def make_scalar(self, indexers, halo, dtype, jit_flags, dimension_index):
        """returns (lru-cached) Numba-compiled scalar halo-filling callable"""
        if self.__mpi_size_one:
            return self.base.make_scalar(
                indexers, halo, dtype, jit_flags, dimension_index
            )
        return make_scalar_boundary_condition(
            indexers=indexers,
            jit_flags=jit_flags,
            dimension_index=dimension_index,
            dtype=dtype,
            get_peer=self.make_get_peer(jit_flags, self.worker_pool_size),
            mpi_dim=self.mpi_dim,
        )

Subclasses

• MPIPeriodic
• MPIPolar

Static methods

def make_get_peer(_, __)

returns (lru-cached) numba-compiled callable.

Expand source code

@staticmethod
def make_get_peer(_, __):
    """returns (lru-cached) numba-compiled callable."""
    raise NotImplementedError()

Methods

def make_scalar(self, indexers, halo, dtype, jit_flags, dimension_index)

returns (lru-cached) Numba-compiled scalar halo-filling callable

Expand source code

def make_scalar(self, indexers, halo, dtype, jit_flags, dimension_index):
    """returns (lru-cached) Numba-compiled scalar halo-filling callable"""
    if self.__mpi_size_one:
        return self.base.make_scalar(
            indexers, halo, dtype, jit_flags, dimension_index
        )
    return make_scalar_boundary_condition(
        indexers=indexers,
        jit_flags=jit_flags,
        dimension_index=dimension_index,
        dtype=dtype,
        get_peer=self.make_get_peer(jit_flags, self.worker_pool_size),
        mpi_dim=self.mpi_dim,
    )