Ctrl+K
Ctrl+K
Ctrl+K

Individual Urban 1D Unit Classes#

This section summarises all the Flood Modeller Urban 1D unit types which are supported in the API. Being ‘supported’ means that the units can be read, updated and written via the API directly.

Junction Units#

JUNCTION()#

class floodmodeller_api.urban1d.junctions.JUNCTION(unit_block=None, from_json: bool = False, **kwargs)#

Class to hold and process JUNCTION unit type

Parameters:

  • name (str) – Unit name

  • elevation (float) – Elevation of junction invert (ft or m). (required)

  • max_depth (float) – Depth from ground to invert elevation (ft or m) (default is 0). (optional)

  • initial_depth (float) – Water depth at start of simulation (ft or m) (default is 0). (optional)

  • surface_depth (float) – Maximum additional head above ground elevation that manhole junction can sustain under surcharge conditions (ft or m) (default is 0). (optional)

  • area_ponded (float) – Area subjected to surface ponding once water depth exceeds Ymax (ft2 or m2) (default is 0) (optional).

Returns:

Flood Modeller JUNCTION Unit class object

Return type:

JUNCTION

Raingauge Units#

RAINGAUGE()#

class floodmodeller_api.urban1d.raingauges.RAINGAUGE(unit_block=None, from_json: bool = False, **kwargs)#

Class to hold and process RAINGAUGE unit type

Parameters:

  • name (str) – Unit name

  • format (str) – Form of recorded rainfall, either ‘INTENSITY’, ‘VOLUME’ or ‘CUMULATIVE’ (mandatory)

  • interval (float) – Time interval between gauge readings in decimal hours or hours:minutes format (e.g., 0:15 for 15-minute readings). (mandatory)

  • snow_catch_factor (float) – Snow catch deficiency correction factor (SCF) (use 1.0 for no adjustment). (mandatory)

  • data_option (str) – ‘TIMESERIES’ or ‘FILE’ defining where the data is provdied.

  • timeseries (str) – Name of time series in [TIMESERIES] section with rainfall data (mandatory, if data_option = ‘TIMESERIES’)

  • filename (str) – Name of external file with rainfall data. (mandatory, if data_option = ‘File’)

  • station (str)Name of recording station used in the rain file (mandatory, if data_option = 'File')

  • units (str) – Rain depth units used in the rain file, either ‘IN’ (inches) or ‘MM’ (millimeters).(mandatory, if data_option = ‘File’)

Returns:

Flood Modeller RAINGAUGE Unit class object

Return type:

RAINGAUGE

Outfall Units#

OUTFALL()#

class floodmodeller_api.urban1d.outfalls.OUTFALL(unit_block=None, from_json: bool = False, **kwargs)#

Class to hold and process OUTFALL unit type

Parameters:

  • name (str) – Unit name

  • elevation (float) – Elevation of outfall invert (ft or m). (required)

  • type (string) – “FREE”, “NORMAL”, “FIXED”, “TIDAL” or “TIMESERIES”. (required)

  • stage (float) – elevation of fixed stage for outfall (ft or m) (required when “FIXED” type)

  • tcurve (string) – name of curve in [CURVES] section containing tidal height (required when “TIDAL” type)

  • tseries (string) – name of timeseries in [TIMESERIES] section that describes how outfall stage varies with time (required when “TIMESERIES” type)

  • gated (sring) – “YES” or “NO” depending on whether flat gate is present that prevents reverse flow. (optional for all types, default is “NO”) TODO: is this required, or can it be missing

  • routeto (string) – Optional name of a subcatchment that recieves the outfall’s discharge. (default is not be “”, and to no route outfall’s discharge)

Returns:

Flood Modeller OUTFALL Unit class object TODO: add urban 1d in to all instances within urban 1d API

Return type:

OUTFALL

Conduit Units#

CONDUIT()#

class floodmodeller_api.urban1d.conduits.CONDUIT(unit_block=None, from_json: bool = False, **kwargs)#

Class to hold and process CONDUIT unit type

Parameters:

  • name (str) – Unit name. (required)

  • node1 (str) – Name of upstream node. (required)

  • node2 (str) – Name of downstream node. (required)

  • length (float) – Conduit length (ft or m). (required)

  • n (float) – Mannings n value. (required)

  • z1 (float) – Offset of upstream end of conduit invert above the invert elevation of it’s upstream node (ft or m). (required)

  • z1 – Offset of downstream end of conduit invert above the invert elevation of it’s downstream node (ft or m). (required)

  • q0 (float) – Flow in conduit at start of simulation (flow units).(optional, default 0)

  • qmax (float) – maximum flow allowed in the conduit (flow units) (optional, default unlimited)

Returns:

Flood Modeller CONDUIT Unit class object

Return type:

CONDUIT

Loss Units#

LOSS()#

class floodmodeller_api.urban1d.losses.LOSS(unit_block=None, from_json: bool = False, **kwargs)#

Class to hold and process LOSS unit type

Parameters:

  • name (str) – Name of conduit. (required)

  • kentry (float) – Entrance minor head loss coefficient. (required) # TODO: FM name - Entry Loss Coeff.

  • kexit (float) – Exit minor head loss coefficient. (required) # TODO: FM name - Exit Loss Coeff.

  • kavg (float) – Average minor head loss coefficient across lenght of culvert. (required) # TODO: FM name - Avg. Loss Coeff.

  • flap (str) – YES/NO. If conduit has a flat valve that prevents back flow. (optional, default NO ) # TODO: FM name - Flap Gate.

  • seepage (float) – Rate of seepage loss into surrounding soil (in/hr or mm/hr). (optional, default is 0) # TODO: FM name - Seepage Loss Rate

Returns:

Flood Modeller LOSS Unit class object

Return type:

LOSS

XSection Units#

XSECTION()#

class floodmodeller_api.urban1d.xsections.XSECTION(unit_block=None, from_json: bool = False, **kwargs)#

Class to hold and process XSECTION unit type

Parameters:

  • name (str) – Link name of the conduit, orifice, or weir. (required)

  • shape (str) – cross-section shape type (see Tables D-1 or 3-1 for available shapes). (required)

  • geom1 (float) – Full height of the cross-section (ft or m). (required, for shape types or “CUSTOM” or “IREGULAR)

  • geom2 (float) – auxiliary parameter (width, side slopes, etc.) as listed in Table D-1. (required, applicable to shape types)

  • geom3 (float) – auxiliary parameter (width, side slopes, etc.) as listed in Table D-1. (required, applicable to shape types)

  • geom4 (float) – auxiliary parameter (width, side slopes, etc.) as listed in Table D-1. (required, applicable to shape types)

  • barrels (float) – Barrels type number of barrels (i.e., number of parallel pipes of equal size, slope, and roughness) associated with a conduit of shape type , or “CUSTOM” type (optional, default is 1).

  • culvert (int) – Culvert code number from Table A.10 for the conduit’s inlet geometry if it is a culvert subject to possible inlet flow control. Only an option for shape type (leave blank otherwise) (optional, default is “”).

  • curve (str) – Curve name of a Shape Curve in the [CURVES] section that defines how width varies with depth. (optional, applicable to shape types only)

  • tsect (str) – Name of an entry in the [TRANSECTS] section that describes the cross-section geometry of an irregular channel. (required, applicable to “IREGUALAR types only)

Returns:

Flood Modeller XSECTION Unit class object TODO: add urban 1d in to all instances within urban 1d API

Return type:

XSECTION

On this page
Show Source