文档反馈

问题文档片段

问题文档片段包含公式时，显示为空格。

提交类型

issue

有点复杂...

找人问问吧。

PR

小问题，全程线上修改...

一键搞定！

请选择提交类型

问题类型

规范和低错类

- 规范和低错类：

- 错别字或拼写错误，标点符号使用错误、公式错误或显示异常。

- 链接错误、空单元格、格式错误。

- 英文中包含中文字符。

- 界面和描述不一致，但不影响操作。

- 表述不通顺，但不影响理解。

- 版本号不匹配：如软件包名称、界面版本号。

易用性

- 易用性：

- 关键步骤错误或缺失，无法指导用户完成任务。

- 缺少主要功能描述、关键词解释、必要前提条件、注意事项等。

- 描述内容存在歧义指代不明、上下文矛盾。

- 逻辑不清晰，该分类、分项、分步骤的没有给出。

正确性

- 正确性：

- 技术原理、功能、支持平台、参数类型、异常报错等描述和软件实现不一致。

- 原理图、架构图等存在错误。

- 命令、命令参数等错误。

- 代码片段错误。

- 命令无法完成对应功能。

- 界面错误，无法指导操作。

- 代码样例运行报错、运行结果不符。

风险提示

- 风险提示：

- 对重要数据或系统存在风险的操作，缺少安全提示。

内容合规

- 内容合规：

- 违反法律法规，涉及政治、领土主权等敏感词。

- 内容侵权。

请选择问题类型

问题描述

点击输入详细问题描述，以帮助我们快速定位问题。

提交

文档反馈

sponge.function.GetVector

class sponge.function.GetVector(use_pbc: bool = None)

获取有或者没有PBC box的向量。

参数：

• use_pbc (bool) - 计算向量时是否使用周期性边界条件。 如果给出 None ，它将根据是否提供了 pbc_box 来决定是否使用周期性边界条件。默认值： None 。

样例：

>>> import mindspore as ms
>>> import numpy as np
>>> from sponge.function import GetVector
>>> from mindspore import Tensor
>>> crd = Tensor(np.random.random((4, 3)), ms.float32)
>>> pbc_box = Tensor([[0.5, 0.5, 0.5]], ms.float32)
>>> gd = GetVector(use_pbc=True)
>>> gd(crd[0], crd[1], pbc_box)
Tensor(shape=[1, 3], dtype=Float32, value=
[[ 5.14909625e-02, -4.62748706e-02, -1.20763242e-01]])
>>> gd = GetVector(use_pbc=False)
>>> gd(crd[0], crd[1])
Tensor(shape=[3], dtype=Float32, value= [ 5.14909625e-02,  4.53725129e-01, -1.20763242e-01])

calc_vector_default(initial: Tensor, terminal: Tensor, pbc_box: Tensor = None)

获取向量。

参数：

• initial (Tensor) - 起始位置的坐标。张量的shape为 $(B,...,D)$ 。 B表示batchsize，例如，模拟中的步行者数量。D表示仿真系统的空间维度。通常为3。 数据类型为float。

• terminal (Tensor) - 终止位置的坐标。张量的shape为 $(B,...,D)$。数据类型为float。

• pbc_box (Tensor) - 张量的shape为 $(B,D)$。数据类型为float。默认值： None 。

calc_vector_nopbc(initial: Tensor, terminal: Tensor, pbc_box: Tensor = None)

在没有周期性边界条件的情况下获取向量。

参数：

• initial (Tensor) - 起始位置的坐标。张量的shape为 $(B,...,D)$ 。 B表示batchsize，例如，模拟中的步行者数量。D表示仿真系统的空间维度。通常为3。 数据类型为float。

• terminal (Tensor) - 终止位置的坐标。张量的shape为 $(B,...,D)$。数据类型为float。

• pbc_box (Tensor) - 张量的shape为 $(B,D)$。数据类型为float。默认值： None 。

calc_vector_pbc(initial: Tensor, terminal: Tensor, pbc_box: Tensor = None)

在有周期性边界条件的情况下获取向量。

参数：

• initial (Tensor) - 起始位置的坐标。张量的shape为 $(B,...,D)$ 。 B表示batchsize，例如，模拟中的步行者数量。D表示仿真系统的空间维度。通常为3。 数据类型为float。

• terminal (Tensor) - 终止位置的坐标。张量的shape为 $(B,...,D)$。数据类型为float。

• pbc_box (Tensor) - 张量的shape为 $(B,D)$。数据类型为float。默认值： None 。

set_pbc(use_pbc: bool)

设定是否使用周期性边界条件。

参数：

• use_pbc (bool) - 是否使用周期性边界条件。默认值： None 。

property use_pbc

是否使用周期性边界条件。

返回：

bool。是否使用周期性边界条件。