pylbm.stencil.Velocity.get_symmetric¶

method

Velocity.get_symmetric(axis=None)¶

return the symmetric velocity.

Parameters:

axisthe axis of the symmetry, optional

(None involves the symmetric with the origin, 0 with the x axis, 1 with the y axis, and 2 with the z axis)

Returns:

Velocity

The symmetric of the velocity

Raises:

ValueError

if axis is not None and axis < 0 or axis >= dim