pylbm.elements.Ellipse

class pylbm.elements.Ellipse(center, v1, v2, label=0, isfluid=False)

Class Ellipse

Parameters:
centerlist

the two coordinates of the center

v1list

a vector

v2list

a second vector (v1 and v2 have to be othogonal)

labellist

one integer (default [0])

isfluidboolean
  • True if the ellipse is added

  • False if the ellipse is deleted

Examples

the ellipse centered in (0, 0) with v1=[2,0], v2=[0,1]

>>> center = [0., 0.]
>>> v1 = [2., 0.]
>>> v2 = [0., 1.]
>>> Ellipse(center, v1, v2)
+---------+
| Ellipse |
+---------+
    - dimension: 2
    - center: [0. 0.]
    - v1: [2. 0.]
    - v2: [0. 1.]
    - label: [0]
    - type: solid
Attributes:
number_of_boundsint

1

dim: int

2

centerndarray

the coordinates of the center of the ellipse

v1ndarray

the coordinates of the first vector

v2ndarray

the coordinates of the second vector

labellist

the list of the label of the edge

isfluidboolean

True if the ellipse is added and False if the ellipse is deleted

Methods

distance(grid, v[, dmax, normal])

Compute the distance in the v direction between the ellipse and the points defined by (x, y).

get_bounds()

Get the bounds of the ellipse.

point_inside(grid)

return a boolean array which defines if a point is inside or outside of the ellipse.

test_label()

test if the number of labels is equal to the number of bounds.

visualize(viewer, color[, viewlabel, scale, ...])

visualize the element

Attributes

number_of_bounds