Source code for festim.exports.derived_quantities.hydrogen_flux

from festim import SurfaceFlux




class HydrogenFlux(SurfaceFlux):
    """
    Computes the surface flux of hydrogen at a given surface

    Args:
        surface (int): the surface id

    Attributes:
        field (str): the hydrogen solute field
        surface (int): the surface id
        title (str): the title of the derived quantity
        show_units (bool): show the units in the title in the derived quantities
            file
        function (dolfin.function.function.Function): the solution function of
            the hydrogen solute field

    .. note::
        units are in H/m2/s in 1D, H/m/s in 2D and H/s in 3D domains

    """

    def __init__(self, surface) -> None:
        super().__init__(field="solute", surface=surface)