Boundary

To do:

  • Define boundary conditions for hipims model

class IO.Boundary.Boundary(boundary_list=None, outline_boundary='fall')

Class for boundary conditions

num_of_bound

number of boundaries

type

a list of string ‘open’, ‘rigid’, ‘fall’ ‘open’: timeseries of boundary depth/discharge/velocity can

be given for this type. If no given timeseries data, water will flow out flatly

‘rigid’: no outlet ‘fall’: water flow out like a fall, a fix zero water depth and

velocities will be given

extent

(2-col numpy array) poly points to define the extent of a IO boundary. If extent is not given, then the boundary is the domain outline

hSources

a two-col numpy array. The 1st col is time(s). The 2nd col is water depth(m)

hUSources

a two-col numpy array. The 1st col is time(s). The 2nd col is discharge(m3/s) or a three-col numpy array, the 2nd col and the 3rd col are velocities(m/s) in x and y direction, respectively.

h_code

3-element int to define the type of depth boundary

hU_code

3-element int to define th type of velocity boundary

description

(str) description of a boundary

__init__(boundary_list=None, outline_boundary='fall')

Initialise the object

Parameters

  • boundary_list –

    (list of dicts), each dict contain keys (polyPoints, type, h, hU) to define a IO boundary’s position, type, and Input-Output (IO) sources timeseries. Keys including:

    1.polyPoints is a numpy array giving X(1st col) and Y(2nd col)

    coordinates of points to define the position of a boundary. A bound without polyPoints is regarded as the outline_boundary.

    2.type: string, type of the boundary
    ’open’: timeseries of boundary depth/discharge/velocity

    can be given for this type. If no given timeseries data, water will flow out flatly

    ’rigid’: water cannot flow in or out ‘fall’: water flow out like a fall, a fix zero water depth

    and velocities will be given

    3.h: a two-col numpy array. The 1st col is time(s). The 2nd col

    is water depth(m)

    4.hU: a two-col numpy array. The 1st col is time(s). The 2nd

    col is discharge(m3/s) or a three-col numpy array, the 2nd col and the 3rd col are velocities(m/s) in x and y direction, respectively.

  • outline_boundary – (str) ‘open’|’rigid’, default outline boundary is open and both h and hU are set as zero

  • given (if h or hU is) – function _setup_boundary_data_table

  • in (then the boundary type is set as 'open') – function _setup_boundary_data_table

get_summary()

Get summary information strings

print_summary()

Print the summary information