anuga.Rate_operator

class anuga.Rate_operator(domain, rate=0.0, factor=1.0, region=None, indices=None, polygon=None, center=None, radius=None, default_rate=0.0, description=None, label=None, logging=False, verbose=False, monitor=False)

__init__(domain, rate=0.0, factor=1.0, region=None, indices=None, polygon=None, center=None, radius=None, default_rate=0.0, description=None, label=None, logging=False, verbose=False, monitor=False)

Create a Rate_operator that adds water over a region at a specified rate (ms^{-1} = vol/Area/sec)

Parameters specifying locaton of operator

Parameters:

• region – Region object where water applied

• indices – List of triangles where water applied

• polygon – List of [x,y] points specifying a polygon where water applied

• center – [x.y] point of circle where water applied

• radius – radius of circle where water applied

Parameters specifying rate

Parameters:

• rate – scalar, function of (t), (x,y), or (x,y,t), or a Quantity, a numpy array of size (number_of_triangles), or an xarray with rate at points and time

• factor – scalar, function of t, or 2 by n numpy array time sequence, used to specify conversion from rate argument to m/s

• default_rate – use this rate if outside time interval of rate function or xarray

Parameters involving communication

Parameters:

• description

• label

• logging

• verbose

• monitor

Methods

__init__(domain[, rate, factor, region, ...])	Create a Rate_operator that adds water over a region at a specified rate (ms^{-1} = vol/Area/sec)
activate_logging()
get_Q([full_only])	Calculate current overall discharge
get_factor([t])	Provide a factor to calculate added volume
get_non_spatial_rate([t])	Provide a rate to calculate added volume
get_spatial_rate([x, y, t])	Provide a rate to calculate added volume only call if self.rate_spatial = True
get_time()
get_timestep()
log_timestepping_statistics()
parallel_safe()	Operator is applied independently on each cell and so is parallel safe.
print_statistics()
print_timestepping_statistics()
set_areas()
set_default_rate(default_rate)	Check and store default_rate
set_factor(factor)	Set factor.
set_full_indices()
set_label([label])
set_logging([flag])
set_rate(rate)	Set rate.
statistics()
timestepping_statistics()

Attributes

counter