wolfhece.channel_rough_ramp

Author: HECE - University of Liege, Pierre Archambeau Date: 2024

Copyright (c) 2024 University of Liege. All rights reserved.

This script and its content are protected by copyright law. Unauthorized copying or distribution of this file, via any medium, is strictly prohibited.

Module Contents

class wolfhece.channel_rough_ramp.BreachElement

Class representing a breach element with its properties.

curvilinear_position: float

width: float

depth: float

class wolfhece.channel_rough_ramp.Channel(idx: str = '', plotted: bool = True, mapviewer=None, need_for_wx: bool = False)

Bases: wolfhece.synthetic_dike.SyntheticDike

Channel class based on a trace vector, width of the sides (left and right) and lateral slopes.

_triangulation = None

_zones

_ds = 1.0

create_from_slopes(trace: wolfhece.PyVertexvectors.vector, slope_left: float, slope_right: float, width_left: float, width_right: float, zmin: float, zmax: float, ds: float)

Create the rough ramp triangulation based on the trace vector and the width of the dike.

Parameters:

• trace – Trace vector of the dike

• slope_left – Slope of the dike on the left side [slope = dz/dx]

• slope_right – Slope of the dike on the right side [slope = dz/dx]

• width_left – Width of the dike on the left side [m]

• width_right – Width of the dike on the right side [m]

• zmin – Minimum elevation of the dike [m]

• zmax – Maximum elevation of the dike [m]

• ds – Distance for rebinning [m]

create_from_shape(trace: wolfhece.PyVertexvectors.vector, shape: wolfhece.PyVertexvectors.vector, ds: float)

create the rough ramp triangulation based on the trace vector and the shape vector

Parameters:

• trace – Trace vector of the dike

• shape – Transversal shape of the dike in (s,z) coordinates, s=0.0 is on the trace vector, elevations are relative to the trace vector

• ds – Distance for rebinning [m]

class wolfhece.channel_rough_ramp.RoughRamp(idx: str = '', plotted: bool = True, mapviewer=None, need_for_wx: bool = False)

Bases: Channel

Rough ramp class based on a trace vector, width of the sides (left and right) and lateral slopes.

_rough_elements: list[wolfhece.synthetic_dike.SyntheticDike]

_breach_elements: list[RoughRamp]

_triangulation = None

_zones

_ds = 1.0

_add_rough_element(shape_horiz: wolfhece.PyVertexvectors.vector, shape_cs: wolfhece.PyVertexvectors.vector, ds: float | None = None, rotation_angle: float = 0.0, translation_vertex: wolfhece.PyVertexvectors.vector = None)

Add rough element

Parameters:

• shape_horiz – Horizontal shape of rough elements (optional)

• shape_cs – Cross-sectional shape of rough elements (optional)

• ds – Distance for rebinning (optional)

_add_breach_element(breach: BreachElement, middle: wolfhece.PyVertexvectors.wolfvertex, orientation: wolfhece.PyVertexvectors.wolfvertex, length: float)

Create a “dike” representing a breach element and add it to the list.

Parameters:

• breach – BreachElement object containing breach properties

• middle – Middle point of the breach element

• orientation – Orientation vector of the breach element

• length – Length of the breach element along the orientation [m]

add_rough_elements_along_trace(shape_horiz: wolfhece.PyVertexvectors.vector = None, shape_cs: wolfhece.PyVertexvectors.vector = None, spacing: float = 10.0, reset: bool = True, ds: float | None = None, breach: BreachElement = None, decal_each: float = 1.0)

Add rough elements along the dike trace

Parameters:

• shape_horiz – Horizontal shape of rough elements (optional)

• shape_cs – Cross-sectional shape of rough elements (optional)

• spacing – Spacing between rough elements along the trace [m]

• reset – If True, reset existing rough elements before adding new ones

• ds – Distance for rebinning (optional)

• breach – BreachElement object containing breach properties (optional)

• decal_each – Lateral offset for breach elements to alternate sides [m]

property triangulations_above: list[wolfhece.PyVertexvectors.Triangulation]

List of triangulations of the rough elements

Returns:

List of triangulations

property triangulations_rough: list[wolfhece.PyVertexvectors.Triangulation]

List of triangulations of the rough elements

Returns:

List of triangulations

property triangulations_below: list[wolfhece.PyVertexvectors.Triangulation]

List of triangulations of the breach elements

Returns:

List of triangulations

property triangulations: tuple[list[wolfhece.PyVertexvectors.Triangulation], list[str]]

List of all triangulations

Returns:

List of triangulations