anuga.Boyd_box_operator

class anuga.Boyd_box_operator(domain, losses, width, height=None, barrels=1.0, blockage=0.0, z1=0.0, z2=0.0, end_points=None, exchange_lines=None, enquiry_points=None, invert_elevations=None, apron=0.1, manning=0.013, enquiry_gap=0.0, smoothing_timescale=0.0, use_momentum_jet=True, use_velocity_head=True, description=None, label=None, structure_type='boyd_box', logging=False, verbose=False)[source]

Culvert flow - transfer water from one rectangular box to another. Sets up the geometry of problem

This is the base class for culverts. Inherit from this class (and overwrite compute_discharge method for specific subclasses)

Input: minimum arguments

domain, losses (scalar, list or dictionary of losses), width (= height if height not given)

__init__(domain, losses, width, height=None, barrels=1.0, blockage=0.0, z1=0.0, z2=0.0, end_points=None, exchange_lines=None, enquiry_points=None, invert_elevations=None, apron=0.1, manning=0.013, enquiry_gap=0.0, smoothing_timescale=0.0, use_momentum_jet=True, use_velocity_head=True, description=None, label=None, structure_type='boyd_box', logging=False, verbose=False)[source]

Create a box culvert using Boyd flow algorithm

Parameters:

  • domain – Culvert applied to this domain

  • losses – Losses

  • width – Width of culvert

  • height – height of culvert

  • barrels – Number of barrels

  • blockage – Set between 0.0 - 1.0 Set to 1.0 to close off culvert

  • z1 – Elevation of end of Culvert

  • z2 – Elevation of other end of Culvert

  • end_points – [[x1,y1], [x2,y2]] of centre of ends of culvert

  • exchange_lines – [ [[x1,y1], [x2,y2]], [[x1,y1], [x2,y2]] ] list of two lines defining ends of culvert

  • enquiry_points – [[x1,y1], [x2,y2]] location of enquiry points

  • invert_elevations – [ e1, e2 ] invert elevations of culvert inlets

  • apron –

  • manning –

  • enquiry_gap –

  • smoothing_timescale –

  • use_momentum_jet –

  • use_velocity_head –

  • description –

  • label –

  • structure_type –

  • logging –

  • verbose –

Methods

__init__(domain, losses, width[, height, ...])

Create a box culvert using Boyd flow algorithm

activate_logging()

discharge_routine()

Procedure to determine the inflow and outflow inlets.

get_culvert_apron()

get_culvert_barrels()

get_culvert_blockage()

get_culvert_diameter()

get_culvert_height()

get_culvert_length()

get_culvert_slope()

get_culvert_width()

get_culvert_z1()

get_culvert_z2()

get_enquiry_depths()

get_enquiry_elevations()

get_enquiry_invert_elevations()

get_enquiry_positions()

get_enquiry_specific_energys()

get_enquiry_speeds()

get_enquiry_stages()

get_enquiry_total_energys()

get_enquiry_velocity_heads()

get_enquiry_velocitys()

get_enquiry_water_depths()

get_enquiry_xmoms()

get_enquiry_xvelocitys()

get_enquiry_ymoms()

get_enquiry_yvelocitys()

get_inlets()

get_master_proc()

get_time()

get_timestep()

log_timestepping_statistics()

parallel_safe()

By default an operator is not parallel safe

print_statistics()

print_timestepping_statistics()

set_culvert_barrels(barrels)

set_culvert_blockage(blockage)

set_culvert_height(height)

set_culvert_width(width)

set_culvert_z1(z1)

set_culvert_z2(z2)

set_label([label])

set_logging([flag])

statistics()

timestepping_statistics()

Attributes

counter