Module PyMPDATA.boundary_conditions.constant

boundary condition filling halos with a constant value

""" boundary condition filling halos with a constant value """

# pylint: disable=too-many-arguments
from functools import lru_cache

import numba

from PyMPDATA.impl.traversals_common import (
    make_fill_halos_loop,
    make_fill_halos_loop_vector,
)


class Constant:
    """class which instances are to be passed in boundary_conditions tuple to the
    `PyMPDATA.scalar_field.ScalarField` and
    `PyMPDATA.vector_field.VectorField` __init__ methods"""

    def __init__(self, value):
        self.value = value

    def make_scalar(self, indexers, _, __, jit_flags, ___):
        """returns (lru-cached) Numba-compiled scalar halo-filling callable"""
        return _make_scalar_constant(
            self.value,
            indexers.set,
            jit_flags,
        )

    def make_vector(self, indexers, _, __, jit_flags, dimension_index):
        """returns (lru-cached) Numba-compiled vector halo-filling callable"""
        return _make_vector_constant(
            self.value, indexers.set, jit_flags, dimension_index
        )


@lru_cache()
def _make_scalar_constant(value, set_value, jit_flags):
    @numba.njit(**jit_flags)
    def fill_halos(_1, _2, _3):
        return value

    return make_fill_halos_loop(jit_flags, set_value, fill_halos)


@lru_cache()
def _make_vector_constant(value, set_value, jit_flags, dimension_index):
    @numba.njit(**jit_flags)
    def fill_halos_parallel(_1, _2, _3):
        return value

    @numba.njit(**jit_flags)
    def fill_halos_normal(_1, _2, _3, _4):
        return value

    return make_fill_halos_loop_vector(
        jit_flags, set_value, fill_halos_parallel, fill_halos_normal, dimension_index
    )

Classes

class Constant (value)

class which instances are to be passed in boundary_conditions tuple to the ScalarField and VectorField init methods

Expand source code

class Constant:
    """class which instances are to be passed in boundary_conditions tuple to the
    `PyMPDATA.scalar_field.ScalarField` and
    `PyMPDATA.vector_field.VectorField` __init__ methods"""

    def __init__(self, value):
        self.value = value

    def make_scalar(self, indexers, _, __, jit_flags, ___):
        """returns (lru-cached) Numba-compiled scalar halo-filling callable"""
        return _make_scalar_constant(
            self.value,
            indexers.set,
            jit_flags,
        )

    def make_vector(self, indexers, _, __, jit_flags, dimension_index):
        """returns (lru-cached) Numba-compiled vector halo-filling callable"""
        return _make_vector_constant(
            self.value, indexers.set, jit_flags, dimension_index
        )

Methods

def make_scalar(self, indexers, _, __, jit_flags, ___)

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

Expand source code

def make_scalar(self, indexers, _, __, jit_flags, ___):
    """returns (lru-cached) Numba-compiled scalar halo-filling callable"""
    return _make_scalar_constant(
        self.value,
        indexers.set,
        jit_flags,
    )

def make_vector(self, indexers, _, __, jit_flags, dimension_index)

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

Expand source code

def make_vector(self, indexers, _, __, jit_flags, dimension_index):
    """returns (lru-cached) Numba-compiled vector halo-filling callable"""
    return _make_vector_constant(
        self.value, indexers.set, jit_flags, dimension_index
    )