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: 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: 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: 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: Sequences, cls_fastaccess: Type[TypeFastAccess_co] | None = None, cymodel: CyModelProtocol | None = None)

Bases: FluxSequences

Flux sequences of model dummy.

The following classes are selected:

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

class hydpy.models.dummy.dummy_fluxes.Q(subvars: ModelSequences[ModelSequence, FastAccess])[source]

Bases: FluxSequence

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[int | float | bool | None, int | float | bool | None] = (0.0, None)
name: str = 'q'

Name of the variable in lower case letters.

unit: str = 'm³/s'

Unit of the variable.

Inlet sequences

class hydpy.models.dummy.InletSequences(master: Sequences, cls_fastaccess: Type[TypeFastAccess_co] | None = None, cymodel: CyModelProtocol | None = None)

Bases: InletSequences

Inlet sequences of model dummy.

The following classes are selected:

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

class hydpy.models.dummy.dummy_inlets.Q(subvars: ModelSequences[ModelSequence, FastAccess])[source]

Bases: InletSequence

Abfluss (runoff) [m³/s].

Required by the method:

Pick_Q_V1

NDIM: int = 1
NUMERIC: bool = False
name: str = 'q'

Name of the variable in lower case letters.

unit: str = 'm³/s'

Unit of the variable.

Outlet sequences

class hydpy.models.dummy.OutletSequences(master: Sequences, cls_fastaccess: Type[TypeFastAccess_co] | None = None, cymodel: CyModelProtocol | None = None)

Bases: OutletSequences

Outlet sequences of model dummy.

The following classes are selected:

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

class hydpy.models.dummy.dummy_outlets.Q(subvars: ModelSequences[ModelSequence, FastAccess])[source]

Bases: OutletSequence

Abfluss (runoff) [m³/s].

Calculated by the method:

Pass_Q_V1

NDIM: int = 0
NUMERIC: bool = False
name: str = 'q'

Name of the variable in lower case letters.

unit: str = 'm³/s'

Unit of the variable.

class hydpy.models.dummy.FluxSequences(master: Sequences, cls_fastaccess: Type[TypeFastAccess_co] | None = None, cymodel: CyModelProtocol | None = None)

Bases: FluxSequences

Flux sequences of model dummy.

The following classes are selected:

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

class hydpy.models.dummy.InletSequences(master: Sequences, cls_fastaccess: Type[TypeFastAccess_co] | None = None, cymodel: CyModelProtocol | None = None)

Bases: InletSequences

Inlet sequences of model dummy.

The following classes are selected:

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

class hydpy.models.dummy.OutletSequences(master: Sequences, cls_fastaccess: Type[TypeFastAccess_co] | None = None, cymodel: CyModelProtocol | None = None)

Bases: OutletSequences

Outlet sequences of model dummy.

The following classes are selected:

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