Source code for brainpy.dyn.channels.leaky

# -*- coding: utf-8 -*-
# Copyright 2025 BrainX Ecosystem Limited. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ==============================================================================
"""
This module implements leakage channels.

"""

from typing import Union, Callable, Sequence

import brainpy.math as bm
from brainpy.dyn.neurons.hh import HHTypedNeuron
from brainpy.initialize import Initializer, parameter
from brainpy.types import ArrayType
from .base import IonChannel

__all__ = [
    'LeakyChannel',
    'IL',
]




class LeakyChannel(IonChannel):
    """Base class for leaky channel dynamics."""

    master_type = HHTypedNeuron

    def reset_state(self, V, batch_size=None):
        pass





class IL(LeakyChannel):
    """The leakage channel current.

    Parameters::

    g_max : float
      The leakage conductance.
    E : float
      The reversal potential.
    """

    def __init__(
        self,
        size: Union[int, Sequence[int]],
        keep_size: bool = False,
        g_max: Union[int, float, ArrayType, Initializer, Callable] = 0.1,
        E: Union[int, float, ArrayType, Initializer, Callable] = -70.,
        method: str = None,
        name: str = None,
        mode: bm.Mode = None,
    ):
        super(IL, self).__init__(size,
                                 keep_size=keep_size,
                                 name=name,
                                 mode=mode)

        self.E = parameter(E, self.varshape, allow_none=False)
        self.g_max = parameter(g_max, self.varshape, allow_none=False)
        self.method = method

    def reset_state(self, V, batch_size=None):
        pass

    def update(self, V):
        pass

    def current(self, V):
        return self.g_max * (self.E - V)