Storm Pipe Network File

File extension: spn

File Object

class gsshapy.orm.StormPipeNetworkFile[source]

Bases: sqlalchemy.ext.declarative.api.Base, gsshapy.base.file_base.GsshaPyFileObjectBase

Object interface for the Storm Pipe Network File.

This file is similar in structure as the channel input file. The contents of this file is abstracted to several supporting objects: SuperLink, SuperNode, Pipe, SuperJunction, and Connection.

See: http://www.gsshawiki.com/Subsurface_Drainage:Subsurface_Drainage
http://www.gsshawiki.com/images/d/d6/SUPERLINK_TN.pdf
tableName = 'spn_storm_pipe_network_files'

Database tablename

id

PK

fileExtension

STRING

connections

RELATIONSHIP

RELATIONSHIP

superJunctions

RELATIONSHIP

projectFile

RELATIONSHIP

Supporting Objects

Bases: sqlalchemy.ext.declarative.api.Base

Object containing data for a single super link in the subsurface drainage network. A super link consists of several pipes and super nodes.

tableName = 'spn_super_links'

Database tablename

id

PK

stormPipeNetworkFileID

FK

stormPipeNetworkFile

RELATIONSHIP

superNodes

RELATIONSHIP

pipes

RELATIONSHIP

slinkNumber

INTEGER

numPipes

INTEGER

class gsshapy.orm.SuperNode(nodeNumber, groundSurfaceElev, invertElev, manholeSA, nodeInletCode, cellI, cellJ, weirSideLength, orificeDiameter)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Object containing data for a single super node in the subsurface drainage network. Super nodes belong to one super link.

tableName = 'spn_super_nodes'

Database tablename

id

PK

superLinkID

FK

RELATIONSHIP

nodeNumber

INTEGER

groundSurfaceElev

FLOAT

invertElev

FLOAT

manholeSA

FLOAT

nodeInletCode

INTEGER

cellI

INTEGER

cellJ

INTEGER

weirSideLength

FLOAT

orificeDiameter

FLOAT

class gsshapy.orm.Pipe(pipeNumber, xSecType, diameterOrHeight, width, slope, roughness, length, conductance, drainSpacing)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Object containing data for a single pipe in the subsurface drainage network. Pipes belong to one super link.

tableName = 'spn_pipes'

Database tablename

id

PK

superLinkID

FK

RELATIONSHIP

pipeNumber

INTEGER

xSecType

INTEGER

diameterOrHeight

FLOAT

width

FLOAT

slope

FLOAT

roughness

FLOAT

length

FLOAT

conductance

FLOAT

drainSpacing

FLOAT

class gsshapy.orm.SuperJunction(sjuncNumber, groundSurfaceElev, invertElev, manholeSA, inletCode, linkOrCellI, nodeOrCellJ, weirSideLength, orificeDiameter)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Object containing data for a single super junction in the subsurface drainage network. Super junctions are where two or more super links join or the unconnected end of a super link.

tableName = 'spn_super_junctions'

Database tablename

id

PK

stormPipeNetworkFileID

FK

stormPipeNetworkFile

RELATIONSHIP

sjuncNumber

INTEGER

groundSurfaceElev

FLOAT

invertElev

FLOAT

manholeSA

FLOAT

inletCode

INTEGER

linkOrCellI

INTEGER

nodeOrCellJ

INTEGER

weirSideLength

FLOAT

orificeDiameter

FLOAT

class gsshapy.orm.Connection(slinkNumber, upSjuncNumber, downSjuncNumber)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Object containing data for a single connection in the subsurface drainage network. Connections between super links and super junctions are mapped via these records.

tableName = 'spn_connections'

Database tablename

id

PK

stormPipeNetworkFileID

FK

stormPipeNetworkFile

RELATIONSHIP

slinkNumber

INTEGER

upSjuncNumber

INTEGER

downSjuncNumber

INTEGER