mss_Project
tables.auto_generated.mss_Project
Classes
| Name | Description |
|---|---|
| mss_ProjectTable | Table for mss_Project (Simulation setup). |
| mss_ProjectTableColumns | Column names for mss_Project (Simulation setup). |
mss_ProjectTable
tables.auto_generated.mss_Project.mss_ProjectTable(net_table)Table for mss_Project (Simulation setup).
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_Project.mss_ProjectTable.delete()Create a DELETE query for this table.
Returns
| Name | Type | Description |
|---|---|---|
| DeleteQuery | A new DeleteQuery object |
get_muids
tables.auto_generated.mss_Project.mss_ProjectTable.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_Project.mss_ProjectTable.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_Project.mss_ProjectTable.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_Project.mss_ProjectTable.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_ProjectTableColumns
tables.auto_generated.mss_Project.mss_ProjectTableColumns(table)Column names for mss_Project (Simulation setup).
Attributes
| Name | Description |
|---|---|
| ActiveProject | Active simulation |
| AllowPondingNo | Allow ponding |
| AntecedentDryDay | Antecedent dry days |
| ComputationBegin | Start |
| ComputationEnd | End |
| ConduitLenTS | Time step for conduit lengthening [sec] |
| ContinuityNo | Continuity check |
| ControlRuleStep | Control rule step |
| ControlsNo | Control actions |
| Description | Description |
| Enable_2DOverland | 2D Overland |
| Enable_M21FM_Coupling | Coupling to MIKE 21 or MIKE 3 FM |
| EndSweep | End sweeping on |
| FlowStatsNo | Flow statistics |
| ForceMainEqNo | Force main equation |
| HDFileName | HD file name |
| HDFolderPath | Result folder path |
| HDOutputNo | Save results in default/this folder |
| HeadConvergenceTolerance | Head convergence tolerance [m] |
| HotstartFileSaveName | Hotstart save file name |
| HotstartFileSaveNo | Save hotstart data |
| HotstartFileUseName | Hotstart use file name |
| HotstartFileUseNo | Use hotstart data |
| InertialTermNo | Inertial terms |
| InfiltrationModelNo | Infiltration model |
| InflowFileUseName | Inflow file name |
| InflowFileUseNo | Use inflow data |
| LatFlowTolerance | Lateral flow tolerance [%] |
| LinksFileName | Links list |
| LinksNo | Links summary |
| M2DADDtMax | Maximum [sec] |
| M2DADDtMin | Minimum [sec] |
| M2DADMaxCFL | Max. CFL factor [()] |
| M2DHDDtMax | Maximum [sec] |
| M2DHDDtMin | Minimum [sec] |
| M2DHDFolderPath | Result folder path |
| M2DHDMaxCFL | Max. CFL factor [()] |
| M2DHDOutputNo | Save results in default/this folder |
| MUID | ID |
| MaxTrialPerTS | Maximum trials per time step |
| MinConduitSlope | Minimum conduit slope [%] |
| MinNodalSurfaceArea | Minimum nodal surface area [m^2] |
| MinVarTS | Minimum variable time step [sec] |
| NodesFileName | Nodes list |
| NodesNo | Nodes summary |
| NormalFlowCritNo | Normal flow criterion |
| OutflowFileSaveName | Outflow file name |
| OutflowFileSaveNo | Save outflow data |
| RDIIFileSaveName | RDII data save file |
| RDIIFileSaveNo | Save RDII data |
| RDIIFileUseName | RDII file name |
| RDIIFileUseNo | Use RDII data |
| RS_DryDay | Runoff step: Dry weather days |
| RS_DryTime | Runoff step: Dry weather time |
| RS_WetDay | Runoff step: Wet weather days |
| RS_WetTime | Runoff step: Wet weather time |
| RainfallFileName | Rainfall file name |
| RainfallFileNo | Rainfall data |
| RainfallFileUseSaveNo | Rainfall file user/save |
| ReportAverageNo | Average summary |
| ReportControlNo | Control summary |
| ReportInputNo | Input summary |
| Report_StartTime | Report start time |
| Report_Timestep | Report time step [sec] |
| RoutingModelNo | Routing model |
| RoutingStep | Routing step [sec] |
| RunoffFileSaveName | Runoff data save file |
| RunoffFileSaveNo | Save runoff data |
| RunoffFileUseName | Runoff file name |
| RunoffFileUseNo | Use runoff data |
| ScenarioName | Scenario |
| SkipSteadyFlowPeriodNo | Skip steady flow periods |
| StartSweep | Start sweeping on |
| SubCatchmentFileName | Subcatchment list |
| SubCatchmentsNo | Subcatchments summary |
| SurchargeMethodNo | Surcharge method |
| SysFlowTolerance | System flow tolerance [%] |
| UseFRNo | Flow routing (HD) |
| UseGWNo | Groundwater |
| UseRDNo | Rainfall dependent I/I |
| UseRRNo | Rainfall runoff |
| UseSMNo | Snow melt |
| UseVarTSNo | Use variable time steps adjusted by |
| UseWQNo | Water quality |
| VarTSAdjustBy | Use variable time steps adjusted by [%] |