Grid classes

class pygaf.grids.BasinGrid(gr=100, gd=21)

Bases: object

Square grid class with basin center at grid center.

The default BasinGrid object has radius gr=100 defining the square’s extent and grid density gd=21. An exception occurs if the grid radius is not positive. Grid density defines the numbers of rows and columns comprising the grid; thus, the default grid has 21 rows x 21 cols = 441 grid points. Minimum grid density is constrained to 11 (121 grid points) and maximum grid density is constrained to 41 (1681 grid points). Values for gd outside of these contraints are re-set to the minimum or maximum values as appropriate.

The .pts property returns the grid points attriubutes including local x-y coordinates and world x-y coordinates. The .info method displays grid information and the .draw method displays a plot of the grid in either local or world coordinates.

gr

Radius defining the extent of the solution grid (units L, default 100.0).

Type:

float

gd

Grid density defining the number of rows and columns; minimum and maximum constraints are enforced (default 21).

Type:

int

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

Bases: object

Rectangular basin.

cx

Basin center x coordinate (units L, default 0.0).

Type:

float

cy

Basin center y coordinate (units L, default 0.0).

Type:

float

lx

Basin length in x direction (default 10.0)

Type:

float

ly

Basin length in y direction (default 10.0)

Type:

float

rot

Basin rotation angle in radians (default 0.0).

Type:

float

name

Basin name (default ‘Unnamed’).

Type:

str

property area

Basin area.

Type:

float

draw(dw=4)

Display a drawing of the basin.

Parameters:

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

info()

Print the basin information.

is_circular = False

is_rectangular = True

property lx

Basin length in x direction.

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

Type:

float

property ly

Basin length in y direction.

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

Type:

float

property rot

Basin rotation angle in degrees.

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

Type:

float

property rot_rad

Basin rotation angle in radians.

Type:

float

property verts

x and y coordinates of basin verticies.

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

Type:

dict

property verts_rot

x and y rotated coordinates of basin verticies.

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

Type:

dict

draw(local=False)

Draw the grid points.

Parameters:

local (bool) – Display the grid plot in local coordinates with the well at 0, 0 (default False).

property gr

Grid radius.

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

Type:

float

property grdim

Number of grid rows and columns.

Type:

int

info()

Print the basin grid information.

property npts

Number of grid points.

Type:

int

property pts

grid point attriubutes including local grid point coordinates and world grid point coordinates.

Type:

pandas dataframe

class pygaf.grids.WellGrid(gr=100, gd=21)

Bases: object

Square grid class with regular spacing and well at grid center.

The default WellGrid object has radius gr=100 defining the square’s extent and grid density gd=21. An exception occurs if the grid radius is not positive. Grid density defines the numbers of rows and columns comprising the grid; thus, the default grid has 21 rows x 21 cols = 441 grid points. Minimum grid density is limited to 11 (121 grid points) and maximum grid density is limited to 41 (1681 grid points). Values for gd outside of these contraints are re-set to the minimum or maximum values as appropriate.

The .pts property returns the grid points attriubutes including local x-y coordinates, world x-y coordinates and radius values relative to the well location. The .info method displays grid information and the .draw method displays a plot of the grid in either local or world coordinates.

gr

Radius defining the extent of the solution grid (units L, default 100.0).

Type:

float

gd

Grid density defining the number of rows and columns; minimum and maximum constraints are enforced (default 21).

Type:

int

class Well(x=0.0, y=0.0, r=0.05, pf=1.0, name='Steady state non-flowing well')

Bases: object

Non-flowing well.

x

Well x coordinate (units L, default 0.0).

Type:

float

y

Well y coordinate (units L, default 0.0).

Type:

float

r

Well radius (units L, default 0.05).

Type:

float

pf

Well penetration depth (fraction of aquifer depth, default 1.0).

Type:

float

name

Well name (default ‘’).

Type:

str

info()

Print the well information.

property pf

Well penetration depth.

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

Type:

float

property r

Well radius.

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

Type:

float

draw(local=False)

Draw the grid points.

Parameters:

local (bool) – Display the grid plot in local coordinates with the well at 0, 0 (default False ).

property gr

Grid radius.

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

Type:

float

property grdim

Number of grid rows and columns.

Type:

int

info()

Print the well grid information.

property npts

Number of grid points.

Type:

int

property pts

grid point attriubutes including local grid point coordinates, world grid point coordinates and radius values of grid points relative to the well center.

Type:

pandas dataframe