sponge.function.calc_distance

sponge.function.calc_distance(position_a: Tensor, position_b: Tensor, pbc_box: Tensor = None, keepdims: bool = False)[源代码]

计算位置A和B之间的距离。

在分子动力学模拟中，需要通过势能对盒子(box)体积的自动微分求解压强，因此在计算势能时，必须要把体系内所有使用到的向量转变为相对盒子尺度的大小，再进行下一步的计算。

若使用 pbc_box 则需要转化为同一个 pbc_box 内坐标计算 A 和B 的距离;若不使用则用绝对坐标计算 A 和B 的距离。在没有周期性边界条件的情况下计算位置A和B之间的距离，用绝对坐标计算。

参数：

position_a (Tensor) - 位置A的坐标，shape为 \((..., D)\) ，D是模拟系统的空间维度, 一般为3。
position_b (Tensor) - 位置B的坐标，shape为 \((..., D)\) 。
pbc_box (Tensor) - 周期性盒子，shape为 \((D)\) 或者 \((B, D)\) ，B是Batch size。
keepdims (bool) - 如果设置为 True ，最后一个维度会被保留，默认值 False 。

返回：

Tensor。A和B之间的距离。shape为 \((...)\) 或者 \((B, ..., 1)\) 。

支持平台：

Ascend GPU

样例：

>>> import mindspore as ms
>>> from mindspore import Tensor
>>> from sponge.function import calc_distance
>>> tensor_a = Tensor([[1, 2, 3], [4, 5, 6]], ms.float32)
>>> tensor_b = Tensor([[1, 2, 4], [6, 8, 10]], ms.float32)
>>> calc_distance(tensor_a, tensor_b)
Tensor(shape=[2], dtype=Float32, value= [ 1.00000000e+00,  5.38516474e+00])
>>> pbc_box = Tensor([[3, 3, 3]], ms.float32)
>>> calc_distance(tensor_a, tensor_b, pbc_box)
>>> Tensor(shape=[2], dtype=Float32, value= [ 1.00000000e+00,  1.41421354e+00])