geoparticle.shapes.CylinderSide

class CylinderSide(r: float, l_axis: float, dl: float, axis: str = 'y', name=None, anchor: Sequence[float] = (0, 0, 0))

Bases: Geometry

Side surface of a cylinder.

Shortest import: from geoparticle import CylinderSide

__init__(r: float, l_axis: float, dl: float, axis: str = 'y', name=None, anchor: Sequence[float] = (0, 0, 0))

Parameters:

• r (float) – Radius of the cylinder.

• l_axis (float) – Length of the cylinder along the specified axis.

• dl (float) – Spacing between points in the grid.

• axis (str, optional) – Axis along which the cylinder is oriented. Defaults to ‘y’.

• name (str, optional) – Name of the cylinder side. Defaults to None.

• anchor (Sequence[float]) – The anchor coordinate to determine the absolute position of the cylinder side. The anchor is the bottom/left/back center of the cylinder.

Methods

__init__(r, l_axis, dl[, axis, name, anchor])	param r: Radius of the cylinder.
check_overlap([tol])	Check if there are overlapping points in the geometry.
clip(keep, *[, plane_name, plane_normal, ...])	Clip geometry by a half-space defined by a named plane or an arbitrary plane.
coord2id(x, y, z)	Find the nearest vertex index/indices and its/their coordinates.
copy([name])	Create a deep copy of the geometry object.
equal(geo)	Check if two geometries are equal based on their coordinates.
get_and_delete(ids)	Extract points by their indices and remove them from the geometry.
get_counter()	Get the current value of the class-wide counter.
intersect(geometries[, rmax, inplace, name])	Keep points from self that are within rmax of at least one point in every other geometry.
load_from(other)	Copy coordinate arrays and dimension from another Geometry into this instance.
mirror(plane_name, plane_pos[, inplace, name])	Mirror the geometry across a principal plane.
plot([ax, ms, alpha])	Plot the geometry points in 2D.
rotate(angle_deg[, axis_direction, ...])	Rotate the geometry around a principal axis or a custom axis.
set_coord(xs, ys, zs)	Set the coordinates of the geometry, broadcasting scalars if necessary.
shift([x, y, z, inplace, name])	Translate the geometry by the given offsets.
stack(axis, n_axis, dl, dimension[, ...])	Stack a planar layer (self) along axis by repeating points at spacing dl.
subtract(geo2[, rmax, inplace, name])	Return points from self that are at least rmax away from any point in geo2.
union(geometries[, inplace, name])	Concatenate this geometry with others and return a new Geometry.

Attributes

counter
dl_in_ring	Get the actual spacing between points on a ring.
flatten_coords	Get the flattened array of coordinates.
matrix_coords	Get the coordinates as a 2D array.
size	Get the number of points in the geometry.

property dl_in_ring: float

Get the actual spacing between points on a ring.

Returns:

Spacing between points on the ring.

Return type:

float

counter = 0