文档反馈

问题文档片段

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

提交类型
issue

有点复杂...

找人问问吧。

PR

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

一键搞定!

请选择提交类型

问题类型
规范和低错类

- 规范和低错类:

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

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

- 英文中包含中文字符。

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

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

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

易用性

- 易用性:

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

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

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

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

正确性

- 正确性:

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

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

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

- 代码片段错误。

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

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

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

风险提示

- 风险提示:

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

内容合规

- 内容合规:

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

- 内容侵权。

请选择问题类型

问题描述

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

sponge.potential.EnergyCell

查看源文件
class sponge.potential.EnergyCell(name: str = 'energy', length_unit: str = 'nm', energy_unit: str = 'kj/mol', use_pbc: bool = None, **kwargs)[源代码]

能量项的基础类。 EnergyCell 通常被用作传统力场中单独的能量项的一个基类。力场参数通常有单位,因此作为能量项的 EnergyCell 的单位必须与力场参数的单位保持一致,而不是与全局单位相同。

说明

  • B - 批处理大小,用于模拟的walkers数目。

参数:
  • name (str) - 能量的名称。默认值: "energy"

  • length_unit (str) - 长度单位。如果是None的话,与全局长度单位保持一致。默认值: "nm"

  • energy_unit (str) - 能量单位。如果是None的话,与全局能量单位保持一致。默认值: "kj/mol"

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

  • kwargs (dict) - 其他参数字典。

返回:

Tensor。能量,shape为 (B,1) ,数据类型为float。

支持平台:

Ascend GPU

样例:

>>> from mindspore import Tensor
>>> from mindspore.nn import Adam
>>> from sponge.potential import EnergyCell, ForceFieldBase
>>> from sponge import WithEnergyCell, Sponge
>>> from sponge.callback import RunInfo
>>> class MyEnergy(EnergyCell):
...     def construct(self, coordinate: Tensor, **kwargs):
...         return coordinate.sum()[None, None]
>>> # system represents a custom molecular system
>>> potential = MyEnergy(system)
>>> forcefield = ForceFieldBase(potential)
>>> withenergy = WithEnergyCell(system, forcefield)
>>> opt = Adam(system.trainable_params(), 1e-3)
>>> mini = Sponge(withenergy, optimizer=opt)
>>> run_info = RunInfo(5)
>>> mini.run(10, callbacks=[run_info])
[MindSPONGE] Started simulation at 2024-03-22 11:08:34
[MindSPONGE] Step: 5, E_pot: 0.31788814
[MindSPONGE] Step: 10, E_pot: 0.13788882
[MindSPONGE] Finished simulation at 2024-03-22 11:08:35
[MindSPONGE] Simulation time: 0.98 seconds.
--------------------------------------------------------------------------------
property check_system(system: Molecule)[源代码]

检查系统是否需要计算这个能量形式。

参数:
  • system (Molecule) - 系统。

convert_energy_from(unit: str)[源代码]

将能量数值从外部单位换算到内部单位。

参数:
  • unit (str) - 能量的单位。

返回:

float,从外部单位换算到内部单位的能量数值。

convert_energy_to(unit: str)[源代码]

将能量数值从内部单位换算到外部单位。

参数:
  • unit (str) - 能量的单位。

返回:

float,从内部单位换算到外部单位的能量数值。

property energy_unit

能量单位。

返回:

str,能量单位。

property length_unit

长度单位。

返回:

str,长度单位。

property name

能量的名称。

返回:

str,能量的名称。

set_cutoff(cutoff: float, unit: str = None)[源代码]

设置截断距离。

参数:
  • cutoff (float) - 截断距离。

  • unit (str) - 长度单位。默认值: None

set_input_unit(length_unit: Union[str, Units, Length])[源代码]

设置输入坐标的长度单位。

参数:
  • length_unit (Union[str, Units, Length]) - 输入坐标的长度单位。

set_pbc(use_pbc: bool)[源代码]

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

参数:
  • use_pbc (bool) - 是否使用周期性边界条件。

set_units(length_unit: str = None, energy_unit: str = None, units: Units = None)[源代码]

设置长度、能量单位。

参数:
  • length_unit (str) - 长度单位。默认值: None

  • energy_unit (str) - 能量单位。默认值: None

  • units (Units) - 单位。默认值: None

property use_pbc

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

返回:

bool,返回一个标志来判断是否使用了周期性边界条件。