mrm_SHECouplings

tables.auto_generated.mrm_SHECouplings

Classes

Name	Description
mrm_SHECouplingsTable	Table for mrm_SHECouplings (Groundwater couplings).
mrm_SHECouplingsTableColumns	Column names for mrm_SHECouplings (Groundwater couplings).

mrm_SHECouplingsTable

tables.auto_generated.mrm_SHECouplings.mrm_SHECouplingsTable(net_table)

Table for mrm_SHECouplings (Groundwater couplings).

Attributes

Name	Description
columns	Get the columns for the table.
description	Get the table description.
display_name	Get the display name for the table.
name	Get the table name.

Methods

Name	Description
delete	Create a DELETE query for this table.
get_muids	Get a list of MUIDs for the table.
insert	Insert a row with the given values.
select	Create a SELECT query for this table.
update	Create an UPDATE query for this table.

delete

tables.auto_generated.mrm_SHECouplings.mrm_SHECouplingsTable.delete()

Create a DELETE query for this table.

Returns

Name	Type	Description
	DeleteQuery	A new DeleteQuery object

get_muids

tables.auto_generated.mrm_SHECouplings.mrm_SHECouplingsTable.get_muids(
    order_by=None,
    descending=False,
)

Get a list of MUIDs for the table.

Parameters

Name	Type	Description	Default
order_by	str or None	Column to order the MUIDs by	None
descending	bool	Whether to order in descending order	False

Returns

Name	Type	Description
	list of str	A list of MUIDs

insert

tables.auto_generated.mrm_SHECouplings.mrm_SHECouplingsTable.insert(
    values,
    execute=True,
)

Insert a row with the given values.

Parameters

Name	Type	Description	Default
values	dict of str to Any	Column-value pairs to insert	required
execute	bool	Whether to execute the query immediately (default: True)	True

Returns

Name	Type	Description
	str or InsertQuery	If execute is True, returns the ID of the newly inserted row (MUID) If execute is False, returns an InsertQuery instance

select

tables.auto_generated.mrm_SHECouplings.mrm_SHECouplingsTable.select(columns=[])

Create a SELECT query for this table.

Parameters

Name	Type	Description	Default
columns	list of str	The columns to select	[]

Returns

Name	Type	Description
	SelectQuery	A new SelectQuery object

update

tables.auto_generated.mrm_SHECouplings.mrm_SHECouplingsTable.update(values)

Create an UPDATE query for this table.

Parameters

Name	Type	Description	Default
values	dict of str to Any	Column-value pairs to set in the UPDATE	required

Returns

Name	Type	Description
	UpdateQuery	A new UpdateQuery object

mrm_SHECouplingsTableColumns

tables.auto_generated.mrm_SHECouplings.mrm_SHECouplingsTableColumns(table)

Column names for mrm_SHECouplings (Groundwater couplings).

Attributes

Name	Description
ApplyNo	Apply
BedLeakageNo	Bed leakage
BedTopoNo	Bed topography
ConductanceNo	Conductance
CoupleToDrainageNo	Couple to overland drainage
CoupleToOverlandFlowNo	Couple to overland flow
CoupleToSaturatedZoneDrainageNo	Couple to saturated zone drainage
CoupleToSaturatedZoneNo	Couple to saturated zone
ExchangeCoeff	Weir coefficient
ExchangeExponent	Weir exponent [()]
ExchangeTypeNo	Conductance
FloodAreaNo	Flood area option
FloodCode	Flood code
FromChainage	From lowest chainage [m]
GridCode	Overland drainage grid code
GroutingCoeff	Grouting coefficient [m/s]
GroutingThickness	Grouting thickness [m]
LeakageCoef	Leakage coefficient [/s]
LineResExcNo	Linear reservoir exchange
LinkID	Pipe ID
MUID	ID
MinFlowArea	Min. flow area for overbank spilling [m^2]
MinHeight	Min. upstream height above bank for full weir width [m]
NetworkGridCode	Saturated zone drainage grid code
NodeID	Node ID
OverbankSpillNo	Allow overbank spilling from river to overland domain
RiverID	River ID
ToChainage	To highest chainage [m]
TypeNo	Type
WeirCoef	Weir coefficient
WeirExpCoeff	Weir exponent