mooflow.classes.Well

class mooflow.classes.Well(idx, times, rates, multiplier=None)
__init__(idx, times, rates, multiplier=None)

The class Well describes a well.

Parameters
idxstr

the identificator

timeslist

list with the date of year in which a saison for the extraction pattern ends e.g. [45, 123, 223, 300, 365] for five saisons

rateslist

list with the same length as ext_times gives the extraction rates

multiplierlist

list with the same length as ext_times, sets multiplier for the exttraction rates

Methods

__init__(idx, times, rates[, multiplier])

The class Well describes a well.

get_pattern_dem()

get_pattern_ext()

get_rate_dem(time_curr[, year])

Return the demand for the current day of year.

get_rate_ext(time_curr[, year])

Return the required extraction rate for the current day of year.

get_sum_year([year, demand])

Calculate annual sum of extractions/demands for a year

is_active_on_date(day, year)

returns True if the date is after the well became active

set_pattern(times, rates[, demand])

Set the pattern of required extraction rates and actual demands.

Attributes

active_on

location

multiplier

property for the multiplier.

pywr_node

sector

type