Source code for pybamm.models.submodels.interface.lithium_plating.no_plating

#
# Class for no plating
#
import pybamm

from .base_plating import BasePlating




class NoPlating(BasePlating):
    """Base class for no lithium plating/stripping.

    Parameters
    ----------
    param : parameter class
        The parameters to use for this submodel
    options : dict, optional
        A dictionary of options to be passed to the model.
    """



    def get_fundamental_variables(self):
        phase_name = self.phase_name
        if self.size_distribution is False:
            zero = pybamm.FullBroadcast(
                pybamm.Scalar(0), f"{self.domain} electrode", "current collector"
            )
        else:
            zero = pybamm.FullBroadcast(
                pybamm.Scalar(0),
                f"{self.domain} {phase_name}particle size",
                {
                    "secondary": f"{self.domain} electrode",
                    "tertiary": "current collector",
                },
            )
        variables = self._get_standard_concentration_variables(zero, zero)
        if self.size_distribution:
            variables.update(
                self._get_standard_size_distribution_overpotential_variables(zero)
            )
            variables.update(
                self._get_standard_size_distribution_reaction_variables(zero)
            )
        else:
            variables.update(self._get_standard_reaction_variables(zero))
        variables.update(self._get_standard_overpotential_variables(zero))

        return variables




    def get_coupled_variables(self, variables):
        # Update whole cell variables, which also updates the "sum of" variables
        variables.update(super().get_coupled_variables(variables))

        return variables