sponge.function.GetShiftGrad
================================

.. image:: https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/r2.2/resource/_static/logo_source.svg
    :target: https://gitee.com/mindspore/mindscience/blob/r0.5/MindSPONGE/docs/api/api_python/function/sponge.function.GetShiftGrad.rst
    :alt: 查看源文件


.. py:class:: sponge.function.GetShiftGrad(num_atoms: int, bonds: Tensor, num_walkers: int = 1, dimension: int = 3, use_pbc: bool = None)

    计算维度为 :math:`(K, N, D)` 的B矩阵的微分，N是原子的邻居原子数，D是模拟系统的维度。

    参数：
        - **num_atoms** (int) - 系统中原子总数。
        - **bonds** (Tensor) - 需要被约束的键，shape为 :math:`(C, 2)` ，数据类型是int。
        - **num_walkers** (int) - 多线程的数量。默认值： ``1`` 。
        - **dimension** (int) - 维度数量。默认值： ``3`` 。
        - **use_pbc** (bool) - 是否使用周期性边界条件。如果是 ``None`` ，则根据是否提供pbc_box决定是否在周期性边界中计算距离。默认值： ``None`` 。