pylbm.elements.Sphere¶

class pylbm.elements.Sphere(center, radius, label=0, isfluid=False)¶

Class Sphere

Parameters

• center (a list that contains the three coordinates of the center) –

• radius (a positive float for the radius) –

• label (list of one integer (default [0])) –

• isfluid (boolean) –

  • True if the sphere is added

  • False if the sphere is deleted

number_of_bounds¶

1

Type

int

center¶

the coordinates of the center of the sphere

Type

numpy array

radius¶

positive float for the radius of the sphere

Type

double

label¶

the list of the label of the edge

Type

list of integers

isfluid¶

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

Type

boolean

number_of_bounds

number of edges (1)

Type

int

Examples

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

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

__init__(center, radius, label=0, isfluid=False)¶

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(center, radius[, label, isfluid])	Initialize self.
distance(grid, v[, dmax])	Compute the distance in the v direction between the sphere and the points defined by (x, y, z).
get_bounds()	Get the bounds of the sphere.
point_inside(grid)	return a boolean array which defines if a point is inside or outside of the sphere.
test_label()	test if the number of labels is equal to the number of bounds.