pylbm.elements.Parallelogram

class pylbm.elements.Parallelogram(point, vecta, vectb, label=0, isfluid=False)

Class Parallelogram

Parameters:
pointlist

the coordinates of the first point of the parallelogram

vectalist

the coordinates of the first vector

vectblist

the coordinates of the second vector

labellist

four integers (default [0, 0, 0, 0])

isfluidboolean
  • True if the parallelogram is added

  • False if the parallelogram is deleted

Examples

the square [0,1]x[0,1]

>>> point = [0., 0.]
>>> vecta = [1., 0.]
>>> vectb = [0., 1.]
>>> Parallelogram(point, vecta, vectb)
+---------------+
| Parallelogram |
+---------------+
    - dimension: 2
    - start point: [0. 0.]
    - v1: [1. 0.]
    - v2: [0. 1.]
    - label: [0, 0, 0, 0]
    - type: solid
Attributes:
number_of_boundsint

4

dim: int

2

pointndarray

the coordinates of the first point of the parallelogram

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 parallelogram is added and False if the parallelogram is deleted

Methods

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

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

get_bounds()

return the bounds of the parallelogram.

point_inside(grid)

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

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