Source code for hydpy.models.dam.dam_solver

# pylint: disable=missing-module-docstring

import numpy

from hydpy.core import parametertools
from hydpy.core.typingtools import *

from hydpy.models.dam import dam_control




class AbsErrorMax(parametertools.SolverParameter):
    """Absolute numerical error tolerance [m³/s]."""

    NDIM: Final[Literal[0]] = 0
    TYPE: Final = float
    SPAN = (0.0, None)
    INIT = 0.0001

    CONTROLPARAMETERS = (dam_control.CatchmentArea,)



    def modify_init(self) -> float:
        r"""Adjust and return the value of class constant `INIT`.

        Note that the default initial value 0.0001 refers to mm/T.  Hence the actual
        default initial value in m³/s is:

        :math:`AbsErrorMax = 0.0001 \cdot CatchmentArea \cdot 1000 / Seconds`

        >>> from hydpy.models.dam import *
        >>> simulationstep("1h")
        >>> parameterstep("1d")
        >>> solver.abserrormax.INIT
        0.0001
        >>> catchmentarea(2.0)
        >>> derived.seconds.update()
        >>> from hydpy import round_
        >>> round_(solver.abserrormax.modify_init())
        0.000056
        """
        pars = self.subpars.pars
        catchmentarea = pars.control.catchmentarea
        seconds = pars.derived.seconds
        return self.INIT * catchmentarea * 1000.0 / seconds






class RelErrorMax(parametertools.SolverParameter):
    """Relative numerical error tolerance [1/T]."""

    NDIM: Final[Literal[0]] = 0
    TYPE: Final = float
    SPAN = (0.0, None)
    INIT = numpy.nan





class RelDTMin(parametertools.SolverParameter):
    """Smallest relative integration time step size allowed [-]."""

    NDIM: Final[Literal[0]] = 0
    TYPE: Final = float
    SPAN = (0.0, 1.0)
    INIT = 0.001





class RelDTMax(parametertools.SolverParameter):
    """Largest relative integration time step size allowed [-]."""

    NDIM: Final[Literal[0]] = 0
    TYPE: Final = float
    SPAN = (0.0, 1.0)
    INIT = 1.0





class MaxEval(parametertools.SolverParameter):
    """Maximum number of function evaluations before stopping the Explicit Labatto
    Sequence [-]."""

    NDIM: Final[Literal[0]] = 0
    TYPE: Final = int
    SPAN = (0, None)
    INIT = 1000000





class MaxCFL(parametertools.SolverParameter):
    """Maximum Caurant-Friedrichs-Lewy number for using the Explicit Labatto Sequence
    [-]."""

    NDIM: Final[Literal[0]] = 0
    TYPE: Final = float
    SPAN = (0.0, numpy.inf)
    INIT = numpy.inf