dummy

The Dummy model is a placeholder model. Its inputs are directly handed to the output sequence and therefore can be used to (temporarily) delete a model component while maintaining the network structure.

Method Features

class hydpy.models.dummy.dummy_model.Model[source]

Bases: hydpy.core.modeltools.AdHocModel

The HydPy-Dummy model.

The following “inlet update methods” are called in the given sequence at the beginning of each simulation step:

  • Pick_Q_V1 Query the current inflow from all inlet nodes.

The following “outlet update methods” are called in the given sequence at the end of each simulation step:

  • Pass_Q_V1 Uptdate the outlet link sequence.

class hydpy.models.dummy.dummy_model.Pick_Q_V1[source]

Bases: hydpy.core.modeltools.Method

Query the current inflow from all inlet nodes.

Requires the inlet sequence:

Q

Calculates the flux sequence:

Q

Basic equation:

\(Q_{fluxes} = \sum Q_{inputs}\)

class hydpy.models.dummy.dummy_model.Pass_Q_V1[source]

Bases: hydpy.core.modeltools.Method

Uptdate the outlet link sequence.

Requires the flux sequence:

Q

Calculates the outlet sequence:

Q

Basic equation:

\(Q_{outlets} = Q_{fluxes}\)

Sequence Features

Flux sequences

class hydpy.models.dummy.FluxSequences(master: hydpy.core.sequencetools.Sequences, cls_fastaccess: Optional[Type[FastAccessType]] = None, cymodel: Optional[hydpy.core.typingtools.CyModelProtocol] = None)

Bases: hydpy.core.sequencetools.OutputSequences[FluxSequence]

Flux sequences of model dummy.

The following classes are selected:

  • Q() Abfluss [m³/s].

class hydpy.models.dummy.dummy_fluxes.Q(subvars: SubVariablesType)[source]

Bases: hydpy.core.sequencetools.OutputSequence[hydpy.core.sequencetools.FluxSequences]

Abfluss [m³/s].

Calculated by the method:

Pick_Q_V1

Required by the method:

Pass_Q_V1

NDIM: int = 0
NUMERIC: bool = False
SPAN: Tuple[Union[int, float, bool, None], Union[int, float, bool, None]] = (0.0, None)
name: str = 'q'
unit: str = 'm³/s'

Inlet sequences

class hydpy.models.dummy.InletSequences(master: hydpy.core.sequencetools.Sequences, cls_fastaccess: Optional[Type[FastAccessType]] = None, cymodel: Optional[hydpy.core.typingtools.CyModelProtocol] = None)

Bases: hydpy.core.sequencetools.LinkSequences[InletSequence]

Inlet sequences of model dummy.

The following classes are selected:

  • Q() Abfluss (runoff) [m³/s].

class hydpy.models.dummy.dummy_inlets.Q(subvars: SubVariablesType)[source]

Bases: hydpy.core.sequencetools.LinkSequence[hydpy.core.sequencetools.InletSequences]

Abfluss (runoff) [m³/s].

Required by the method:

Pick_Q_V1

NDIM: int = 1
NUMERIC: bool = False
name: str = 'q'
unit: str = 'm³/s'

Outlet sequences

class hydpy.models.dummy.OutletSequences(master: hydpy.core.sequencetools.Sequences, cls_fastaccess: Optional[Type[FastAccessType]] = None, cymodel: Optional[hydpy.core.typingtools.CyModelProtocol] = None)

Bases: hydpy.core.sequencetools.LinkSequences[OutletSequence]

Outlet sequences of model dummy.

The following classes are selected:

  • Q() Abfluss (runoff) [m³/s].

class hydpy.models.dummy.dummy_outlets.Q(subvars: SubVariablesType)[source]

Bases: hydpy.core.sequencetools.LinkSequence[hydpy.core.sequencetools.OutletSequences]

Abfluss (runoff) [m³/s].

Calculated by the method:

Pass_Q_V1

NDIM: int = 0
NUMERIC: bool = False
name: str = 'q'
unit: str = 'm³/s'
class hydpy.models.dummy.FluxSequences(master: hydpy.core.sequencetools.Sequences, cls_fastaccess: Optional[Type[FastAccessType]] = None, cymodel: Optional[hydpy.core.typingtools.CyModelProtocol] = None)

Bases: hydpy.core.sequencetools.OutputSequences[FluxSequence]

Flux sequences of model dummy.

The following classes are selected:

  • Q() Abfluss [m³/s].

class hydpy.models.dummy.InletSequences(master: hydpy.core.sequencetools.Sequences, cls_fastaccess: Optional[Type[FastAccessType]] = None, cymodel: Optional[hydpy.core.typingtools.CyModelProtocol] = None)

Bases: hydpy.core.sequencetools.LinkSequences[InletSequence]

Inlet sequences of model dummy.

The following classes are selected:

  • Q() Abfluss (runoff) [m³/s].

class hydpy.models.dummy.OutletSequences(master: hydpy.core.sequencetools.Sequences, cls_fastaccess: Optional[Type[FastAccessType]] = None, cymodel: Optional[hydpy.core.typingtools.CyModelProtocol] = None)

Bases: hydpy.core.sequencetools.LinkSequences[OutletSequence]

Outlet sequences of model dummy.

The following classes are selected:

  • Q() Abfluss (runoff) [m³/s].