mss_Groundwater

tables.auto_generated.mss_Groundwater

Classes

Name	Description
mss_GroundwaterTable	Table for mss_Groundwater (Ground water).
mss_GroundwaterTableColumns	Column names for mss_Groundwater (Ground water).

mss_GroundwaterTable

tables.auto_generated.mss_Groundwater.mss_GroundwaterTable(net_table)

Table for mss_Groundwater (Ground water).

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.mss_Groundwater.mss_GroundwaterTable.delete()

Create a DELETE query for this table.

Returns

Name	Type	Description
	DeleteQuery	A new DeleteQuery object

get_muids

tables.auto_generated.mss_Groundwater.mss_GroundwaterTable.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.mss_Groundwater.mss_GroundwaterTable.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.mss_Groundwater.mss_GroundwaterTable.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.mss_Groundwater.mss_GroundwaterTable.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

mss_GroundwaterTableColumns

tables.auto_generated.mss_Groundwater.mss_GroundwaterTableColumns(table)

Column names for mss_Groundwater (Ground water).

Attributes

Name	Description
A1	GW flow coefficient (A1) [m^2/s/ha]
A2	Surface water flow coefficient (A2) [m^2/s/ha]
A3	GW interaction coefficient (A3) [m/s/ha]
AquiferID	Aquifer ID
B1	GW flow exponent (B1)
B2	Surface water flow exponent (B2)
BottomElev	Bottom elevation [m]
DeepFlowEquation	Deep flow equation
DeepFlowNo	Custom deep flow equation
Description	Description
Hcb	Channel bottom height (Hcb) [m]
Hsw	Surface water height (Hsw) [m]
LateralFlowEquation	Lateral flow equation
LateralFlowNo	Custom lateral flow equation
MUID	ID
NodeID	Node ID
SubCatchID	Catchment ID
SurfElev	Catchment surface elev. [m]
UZoneMoisture	Unsat. zone moisture
WTElev	Water table elevation [m]