HydPy-SW1D-Q-Out (submodel for subtracting pre-determined discharge from a channel outlet)

The HydPy-SW1D model family member sw1d_q_out is a simple routing submodel, which allows taking observed or previously simulated discharge series as “longitudinal” channel outflow.

Please refer to the documentation of the “composite model” sw1d_network, where we demonstrate and discuss sw1d_q_out in more detail (see the Bifurcations example).

class hydpy.models.sw1d_q_out.Model[source]

Bases: Main_CrossSectionModel_V2, RoutingModel_V3

HydPy-SW1D-Q-Out (submodel for subtracting pre-determined discharge from a channel outlet).

The following interface methods are available to main models using the defined model as a submodel:
The following “additional methods” might be called by one or more of the other methods or are meant to be directly called by the user:
Users can hook submodels into the defined main model if they satisfy one of the following interfaces:
  • CrossSectionModel_V2 Interface for calculating discharge-related properties at a channel cross-section.

  • RoutingModel_V1 Interface for calculating the inflow into a channel.

  • RoutingModel_V2 Interface for calculating the discharge between two channel segments.

  • StorageModel_V1 Interface for calculating the water amount stored in a single channel segment.

DOCNAME: DocName = ('SW1D-Q-Out', 'submodel for subtracting pre-determined discharge from a channel outlet')
crosssection: SubmodelProperty[CrossSectionModel_V2]

Required submodel that complies with the following interface: CrossSectionModel_V2.

storagemodelupstream: modeltools.SubmodelProperty[StorageModel_V1]

Required reference to the neighbour storage model upstream.

storagemodelupstream_is_mainmodel
storagemodelupstream_typeid
routingmodelsupstream: modeltools.SubmodelsProperty[RoutingModel_V1 | RoutingModel_V2]

References to the neighbour routing models lying upstream.

REUSABLE_METHODS: ClassVar[tuple[type[ReusableMethod], ...]] = ()
cymodel: CyModelProtocol | None
parameters: parametertools.Parameters
sequences: sequencetools.Sequences
masks: masktools.Masks
class hydpy.models.sw1d_q_out.ControlParameters(master: Parameters, cls_fastaccess: type[FastAccessParameter] | None = None, cymodel: CyModelProtocol | None = None)

Bases: SubParameters

Control parameters of model sw1d_q_out.

The following classes are selected:
  • LengthUpstream() The upstream channel segment’s length [km].

  • TimeStepFactor() A factor for reducing the estimated computation time step to increase numerical stability [-].

class hydpy.models.sw1d_q_out.DerivedParameters(master: Parameters, cls_fastaccess: type[FastAccessParameter] | None = None, cymodel: CyModelProtocol | None = None)

Bases: SubParameters

Derived parameters of model sw1d_q_out.

The following classes are selected:
  • Seconds() The length of the actual simulation step size in seconds [s].

class hydpy.models.sw1d_q_out.FactorSequences(master: Sequences, cls_fastaccess: type[TypeFastAccess_co] | None = None, cymodel: CyModelProtocol | None = None)

Bases: FactorSequences

Factor sequences of model sw1d_q_out.

The following classes are selected:
class hydpy.models.sw1d_q_out.FluxSequences(master: Sequences, cls_fastaccess: type[TypeFastAccess_co] | None = None, cymodel: CyModelProtocol | None = None)

Bases: FluxSequences

Flux sequences of model sw1d_q_out.

The following classes are selected:
  • Outflow() Longitudinal flow out of the last channel segment [m³/s].

  • DischargeVolume() The total amount of discharge of a simulation step [m³/T].

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

Bases: OutletSequences

Outlet sequences of model sw1d_q_out.

The following classes are selected:
  • LongQ() The longitudinal outflow of the last channel segment [m³/s].

class hydpy.models.sw1d_q_out.StateSequences(master: Sequences, cls_fastaccess: type[TypeFastAccess_co] | None = None, cymodel: CyModelProtocol | None = None)

Bases: StateSequences

State sequences of model sw1d_q_out.

The following classes are selected: