Basin classes

class basins.CircBasin(cx=0.0, cy=0.0, diam=10, name='Circle basin')

Bases: object

Circular recharge basin class.

Attributes:

cx (float) : Basin center x coordinate (units L, default 0.0). cy (float) : Basin center y coordinate (units L, default 0.0). diam (float) : Basin diameter (default 10.0). rot (float) : Basin rotation angle in radians (default 0.0). name (str) : Basin name (default ‘Unnamed’).

property area

float : basin area.

property diam

float : Basin diameter.

Setter method checks for valid values and triggers an exception if invalid values are specified.

draw(dw=4)

Display a drawing of the basin.

Args:

dw (float) : Width of basin drawing (default 4.0).

info()

Print the basin information.

is_circular = True

is_rectangular = False

property rad

float : Basin radius.

class basins.RectBasin(cx=0.0, cy=0.0, lx=10, ly=10, rot=0, name='Rectangle basin')

Bases: object

Rectangular recharge basin class.

Attributes:

cx (float) : Basin center x coordinate (units L, default 0.0). cy (float) : Basin center y coordinate (units L, default 0.0). lx (float) : Basin length in x direction (default 10.0) ly (float) : Basin length in y direction (default 10.0) rot (float) : Basin rotation angle in radians (default 0.0). name (str) : Basin name (default ‘Unnamed’).

property area

float : Basin area.

draw(dw=4)

Display a drawing of the basin.

Args:

dw (float) : Width of basin drawing (default 4.0).

info()

Print the basin information.

is_circular = False

is_rectangular = True

property lx

float : Basin length in x direction.

Setter method checks for valid values and triggers an exception if invalid values are specified.

property ly

float : Basin length in y direction.

Setter method checks for valid values and triggers an exception if invalid values are specified.

property rot

float : Basin rotation angle in degrees.

Setter method checks for valid values and triggers an exception if invalid values are specified.

property rot_rad

float : Basin rotation angle in radians.

property verts

dict : x and y coordinates of basin verticies.

Vertex keys: ll - lower left, ul - upper left, lr - lower right and ur - upper right.

property verts_rot

dict : x and y rotated coordinates of basin verticies.

Vertex keys: ll - lower left, ul - upper left, lr - lower right and ur - upper right.