Well classes

class pygaf.wells.SteadyWell(x=0.0, y=0.0, r=0.05, q=0.0, pf=1, name='Steady state flowing well')

Bases: object

Steady state flowing well.

The default SteadyWell object has coordinates x=0.0 and y=0.0, well radius r=0.05, penetration fraction pf=1.0 and well rate q=0.0. Exceptions occur if invalid values are provided for r or pf. The well rate can be negative, positive or zero and is used to set the .state attribute as extract, inject or off.

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

q

Well rate (units L3/T, default 0.0).

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.

is_steady = True

is_transient = False

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

property state

Well state.

Type:

str

class pygaf.wells.TransientWell(x=0.0, y=0.0, r=0.05, pf=1, name='Transient flowing well')

Bases: object

Transient state flowing well.

The default TransientWell object has well coordinates x=0.0 and y=0.0, well radius r=0.05, penetration fraction pf=1.0 and default StressSeries object. Exceptions occur if invalid values are provided for r or pf. The well rate can be negative, positive or zero and is used to set the .state attribute as extract, inject or off.

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

ss

StressSeries object.

Type:

obj

pf

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

Type:

float

name

Well name (default ‘’).

Type:

str

class StressSeries(periods=[1.0], values=[0.0], from_csv='', title='Stress Series', xlabel='Time', ylabel='Value')

Bases: object

Stress series class defining sress periods and values.

The default StressSeries object has default values periods=[1.0] and values=[0.0]. Stress periods and values are provided in corresponding lists, which can be created manually or loaded from a csv file containig comma-separated period and value pairs, one per line. Exceptions occur if a period is negative or if the number of periods and stresses do not match.

The .plot method displays a timeseries graph of the stress series.

Example csv file with three stress periods:

10,25.6

15.2,38.7

48,-12

periods

List of stress period lengths; used if from_csv is an empty string (units T, default [1.0]).

Type:

float

values

List of stress period values, one per stress period; used if from_csv is an empty string (units consistent, default [0.0]).

Type:

float

from_csv

File path of csv file to read stress data from; no data are read if the string is empty (default ‘’).

Type:

str

property periods

List of stress period lengths.

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

Type:

list (float)

plot(dw=8)

Plot the stress series.

Parameters:

dw (float) – Width of figure (default 8).

property series

stress series dataframe.

Type:

pandas dataframe

property values

List of stress period values.

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

Type:

list (float)

info()

Print the well information.

is_steady = False

is_transient = True

pandas = <module 'pandas' from '/home/docs/checkouts/readthedocs.org/user_builds/pygaf/envs/latest/lib/python3.7/site-packages/pandas/__init__.py'>

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

property state

Well state.

Type:

str

class pygaf.wells.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