HydPy-SW1D-LIAS (submodel for calculating the discharge between two channel segments based on Bates et al. (2010) and Almeida et al. (2012))¶

The HydPy-SW1D model family member sw1d_lias is a routing submodel that allows applying a 1-dimensional version of the “local inertial approximation of the shallow water equations” introduced by Bates et al. (2010) and “stabilised” by de Almeida et al. (2012).

Please refer to the documentation of the “user model” sw1d_channel and the “composite model” sw1d_network, where we demonstrate and discuss sw1d_lias in detail.

Method features¶

class hydpy.models.sw1d_lias.Model[source]¶

Bases: Main_CrossSectionModel_V2, RoutingModel_V2

HydPy-SW1D-LIAS (submodel for calculating the discharge between two channel segments based on Bates et al. (2010) and Almeida et al. (2012)).

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

Reset_DischargeVolume_V1 Reset the discharge volume to zero (at the beginning of an external simulation step).

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

Pass_Discharge_V1 Pass the calculated average discharge of the current simulation step to an arbitrary number of outlet sequences.

The following interface methods are available to main models using the defined model as a submodel:

Determine_MaxTimeStep_V1 Interface method for determining the highest possible computation time step at a central location.
Determine_Discharge_V1 Interface method for determining the discharge at a central location.
Get_MaxTimeStep_V1 Interface method for querying the highest possible computation time step in s.
Get_Discharge_V1 Interface method for querying the discharge in m³/s.
Get_PartialDischargeUpstream_V1 Return a partial discharge estimate suitable for a downstream model.
Get_PartialDischargeDownstream_V1 Return a partial discharge estimate suitable for an upstream model.
Get_DischargeVolume_V1 Interface method for querying the discharge in m³.
Set_TimeStep_V1 Interface method for setting the actual computation time step in s.

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:

Calc_WaterVolumeUpstream_V1 Query the water volume from an upstream submodel that follows the StorageModel_V1 interface.
Calc_WaterVolumeDownstream_V1 Query the water volume from a downstream submodel that follows the StorageModel_V1 interface.
Calc_WaterLevelUpstream_V1 Query the water level from an upstream submodel that follows the StorageModel_V1 interface.
Calc_WaterLevelDownstream_V1 Query the water level from a downstream submodel that follows the StorageModel_V1 interface.
Calc_WaterLevel_V1 Interpolate the water level based on the water levels of the adjacent channel segments.
Calc_WaterDepth_WettedArea_WettedPerimeter_CrossSectionModel_V2 Let a submodel that follows the CrossSectionModel_V2 submodel interface calculate the water depth, the wetted area, and the wetted perimeter based on the current water level.
Calc_WaterDepth_WettedArea_WettedPerimeter_V1 Let a submodel that follows the CrossSectionModel_V2 submodel interface calculate the water depth, the wetted area, and the wetted perimeter based on the current water level.
Calc_MaxTimeStep_V1 Estimate the highest possible computation time step for which we can expect stability for a central LIAS-like routing model.
Calc_DischargeUpstream_V1 Sum the (partial) discharge of all upstream routing submodels following the RoutingModel_V1 or RoutingModel_V2 interface.
Calc_DischargeDownstream_V1 Sum the (partial) discharge of all downstream routing submodels following the RoutingModel_V2 or RoutingModel_V3 interface.
Calc_Discharge_V1 Calculate the discharge according to Bates et al. (2010) and de Almeida et al. (2012).
Update_Discharge_V1 Reduce the already calculated discharge due to limited water availability in one of the adjacent channel segments.
Update_DischargeVolume_V1 Update the total discharge volume of the current external simulation step.

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.
RoutingModel_V3 Interface for calculating the outflow of a channel.
StorageModel_V1 Interface for calculating the water amount stored in a single channel segment.

DOCNAME = ('SW1D-LIAS', 'submodel for calculating the discharge between two channel segments based on Bates et al. (2010) and Almeida et al. (2012)')¶

crosssection¶: Required submodel that complies with the following interface: CrossSectionModel_V2.

storagemodelupstream¶: Required reference to the neighbour storage model upstream.

storagemodelupstream_is_mainmodel¶

storagemodelupstream_typeid¶

storagemodeldownstream¶: Required reference to the neighbour storage model downstream.

storagemodeldownstream_is_mainmodel¶

storagemodeldownstream_typeid¶

routingmodelsupstream¶: References to the neighbour routing models lying upstream.

routingmodelsdownstream¶: References to the neighbour routing models lying downstream.

REUSABLE_METHODS = ()¶