pyLBM.elements.Circle¶

class pyLBM.elements.Circle(center, radius, label=0, isfluid=False)¶

Class Circle

Parameters:	center : a list that contains the two coordinates of the center radius : a positive float for the radius label : list of one integer (default [0]) isfluid : boolean True if the circle is added False if the circle is deleted

Examples

the circle centered in (0, 0) with radius 1

>>> center = [0., 0.]
>>> radius = 1.
>>> Circle(center, radius)
    Circle([0 0],1) (solid)

Attributes

number_of_bounds	(int) 1
center	(numpy array) the coordinates of the center of the circle
radius	(double) positive float for the radius of the circle
label	(list of integers) the list of the label of the edge
isfluid	(boolean) True if the circle is added and False if the circle is deleted

Methods

get_bounds()	Get the bounds of the circle.
point_inside(grid)	return a boolean array which defines
distance(grid, v[, dmax])	Compute the distance in the v direction between the circle and the points defined by (x, y).