sponge.function.calc_torsion_by_vectors

sponge.function.calc_torsion_by_vectors(vector1: Tensor, vector2: Tensor, axis_vector: Tensor = None, keepdims: bool = False)[source]

Compute torsion angle formed by two direction vectors $\vec{v_{1}}$ and $\vec{v_{2}}$: and an axis vector $\vec{v_{a x i s}}$ .

Parameters

vector1 (Tensor) – Tensor of shape $(. . ., D)$ . Data type is float. D is spatial dimension of the simulation system. Usually is 3. Direction vector $\vec{v_{1}}$
vector2 (Tensor) – Tensor of shape $(. . ., D)$ . Data type is float. Direction vector $\vec{v_{2}}$
axis_vector (Tensor) – Tensor of shape $(. . ., D)$ . Data type is float. Axis vector $\vec{v_{a x i s}}$ . Default: None.
keepdims (bool) – If this is set to True, the last axis will be left in the result as dimensions with size one. Default: False.

Returns

torsion (Tensor), a tensor of shape $(. . .)$ or $(. . ., 1)$ . Data type is float.