m2d_Boundary
tables.auto_generated.m2d_Boundary
Classes
| Name | Description |
|---|---|
| m2d_BoundaryTable | Table for m2d_Boundary (2D boundary conditions). |
| m2d_BoundaryTableColumns | Column names for m2d_Boundary (2D boundary conditions). |
m2d_BoundaryTable
tables.auto_generated.m2d_Boundary.m2d_BoundaryTable(net_table)Table for m2d_Boundary (2D boundary conditions).
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.m2d_Boundary.m2d_BoundaryTable.delete()Create a DELETE query for this table.
Returns
| Name | Type | Description |
|---|---|---|
| DeleteQuery | A new DeleteQuery object |
get_muids
tables.auto_generated.m2d_Boundary.m2d_BoundaryTable.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.m2d_Boundary.m2d_BoundaryTable.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.m2d_Boundary.m2d_BoundaryTable.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.m2d_Boundary.m2d_BoundaryTable.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 |
m2d_BoundaryTableColumns
tables.auto_generated.m2d_Boundary.m2d_BoundaryTableColumns(table)Column names for m2d_Boundary (2D boundary conditions).
Attributes
| Name | Description |
|---|---|
| ApplyNo | Apply |
| BndGeomLine | BndGeomLine |
| BndTypeNo | Type |
| ConstInitVelApplyNo | Const apply initial velocity |
| ConstStartValue | From, constant |
| ConstStartupNo | Gradual start up, constant |
| ConstTimeInterval | Time, constant [sec] |
| ConstValue | Constant value |
| Description | Description |
| Discharge | Discharge [m^3/s] |
| InterpolationTypeNo | Interpolation type in time |
| MUID | ID |
| QHStartValue | From [m] |
| QHStartupNo | Gradual start up |
| QHTimeInterval | Time [sec] |
| QhDisFilePath | Q/h file |
| QhDisItemName | Discharge item |
| QhDisItemNo | QhDisItemNo |
| QhUVelItemName | u-velocity item |
| QhUVelItemNo | QhUVelItemNo |
| QhVVelItemName | v-velocity item |
| QhVVelItemNo | QhVVelItemNo |
| QhVelocityFilePath | Velocity file |
| Source1X | X [m] |
| Source1Y | Y [m] |
| Source2X | X [m] |
| Source2Y | Y [m] |
| SourceFilePath | File name |
| SourceTypeNo | Source type |
| SpatialOrderNo | Spatial order along boundary |
| SrcDisItemName | Discharge item |
| SrcDisItemNo | SrcDisItemNo |
| SrcUVelItemName | u-velocity item |
| SrcUVelItemNo | SrcUVelItemNo |
| SrcVVelItemName | v-velocity item |
| SrcVVelItemNo | SrcVVelItemNo |
| TimeTypeNo | HD type |
| UVelocity | u-velocity [m/s] |
| VVelocity | v-velocity [m/s] |
| VarInitVelApplyNo | Varying apply initial velocity |
| VarStartValue | From, varying |
| VarStartupNo | Gradual start up, varying |
| VarTimeInterval | Time, varying [sec] |
| VelDefTypeNo | Velocity definition type |
| WaterFilePath | File name |
| WaterItemName | Item |
| WaterItemNo | WaterItemNo |