文档反馈

问题文档片段

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

提交类型

issue

有点复杂...

找人问问吧。

PR

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

一键搞定！

请选择提交类型

问题类型

规范和低错类

- 规范和低错类：

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

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

- 英文中包含中文字符。

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

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

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

易用性

- 易用性：

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

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

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

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

正确性

- 正确性：

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

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

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

- 代码片段错误。

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

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

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

风险提示

- 风险提示：

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

内容合规

- 内容合规：

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

- 内容侵权。

请选择问题类型

问题描述

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

提交

文档反馈

sponge.system.Residue

class sponge.system.Residue(atom_name: Union[List[str], ndarray] = None, atom_type: Union[List[str], ndarray] = None, atom_mass: Union[Tensor, ndarray, List[float]] = None, atom_charge: Union[Tensor, ndarray, List[float]] = None, atomic_number: Union[Tensor, ndarray, List[float]] = None, bonds: Union[Tensor, ndarray, List[int]] = None, settle_index: Union[Tensor, ndarray, List[int]] = None, settle_length: Union[Tensor, ndarray, List[float]] = None, settle_unit: str = None, head_atom: int = None, tail_atom: int = None, start_index: int = 0, name: str = 'MOL', template: Union[dict, str] = None, length_unit: str = None, **kwargs)

残基的基类。 Residue 神经元是 Molecule (system) 的组成部分。 Residue 不止可以代表单一的氨基酸残基，还可以代表分子系统中的一个小分子，例如一个水分子，一个无机盐离子等。这代表着 Residue 和PDB文件中的 “residue” 有着相似的概念。

说明

Residue 只用来表示原子属性和键连接关系，不包含原子坐标。

参数：

• atom_name (Union[List[str], ndarray]) - 原子名称的array，数据类型为str。默认值：None。

• atom_type (Union[List[str], ndarray]) - 原子种类的array，数据类型为str。默认值：None。

• atom_mass (Union[Tensor, ndarray, List[float]]) - 原子质量的array，shape为 $(B,A)$ ，数据类型为float。默认值：None。

• atom_charge (Union[Tensor, ndarray, List[float]]) - 原子电荷的array，shape为 $(B,A)$ ，数据类型为float。默认值：None。

• atomic_number (Union[Tensor, ndarray, List[float]]) - 原子序数的array，shape为 $(B,A)$ ，数据类型为float。默认值：None。

• bonds (Union[Tensor, ndarray, List[int]]) - 键连的array，shape为 $(B,b,2)$ ，数据类型为int。默认值为：None。

• settle_index (Union[Tensor, ndarray, List[int]]) - 用于SETTLE限制算法的原子序数的array，shape为 $(B,3)$ ，数据类型为int。索引的顺序是订点原子和两个基原子。默认值为： None 。

• settle_length (Union[Tensor, ndarray, List[float]]) - 用于SETTLE限制算法的长度array，shape为 $(B,2)$ ，数据类型为int。索引的顺序是leg和base。默认值为：None。

• settle_unit (str) - 用于SETTLE限制算法的单位。默认值：None。

• head_atom (int) - 与前一个残基相连接的头原子的索引。默认值：None。

• tail_atom (int) - 与下一个残基相连的尾原子的索引。默认值：None。

• start_index (int) - 残基中第一个原子的开始索引。默认值：0。

• name (str) - 残基名称。默认值：’MOL’。

• template (Union[dict, str]) - 残基的模板。默认值：None。

• length_unit (str) - 长度单位。默认值：None。

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

符号：

• B - Batch size。

• A - 原子总数。

• b - 键总数。

add_atom(atom_name: str = None, atom_type: str = None, atom_mass: float = None, atom_charge: float = None, atomic_number: str = None)

把一个原子添加到残基中。

参数：

• atom_name (str) - 原子名称。默认值：None。

• atom_type (str) - 原子种类。默认值：None。

• atom_mass (float) - 原子质量。默认值：None。

• atom_charge (float) - 原子电荷数。默认值：None。

• atomic_number (str) - 原子序数。默认值：None。

broadcast_multiplicity(multi_system: int)

将信息广播到所选择的多系统中。

参数：

• multi_system (int) - 多系统中系统的数量。

build_atom_charge(template: dict)

按照模板中原子名称对应的原子索引，获取模板对应索引的原子电荷数并加到残基对应原子上。

参数：

• template (dict) - 残基的模板。

build_atom_mass(template: dict)

按照模板中原子名称对应的原子索引，获取模板对应索引的原子质量并加到残基对应原子上。

参数：

• template (dict) - 残基的模板。

build_atom_type(template: dict)

按照模板中原子名称对应的原子索引，获取模板对应索引的原子种类并加到残基对应原子上。

参数：

• template (dict) - 残基的模板。

build_atomic_number(template: dict)

按照模板中原子名称对应的原子索引，获取模板对应索引的原子数并加到残基对应原子上。

参数：

• template (dict) - 残基的模板。

build_bond(template: dict)

按照模板中原子名称对应的原子索引，获取模板对应索引的原子的化学键并加到残基对应原子上。

参数：

• template (dict) - 残基的模板。

build_settle(template: dict)

按照模板中原子类型对应的原子索引，为SETTLE算法获取模板对应索引和长度并加到残基对应原子上。

参数：

• template (dict) - 残基的模板。

property name

获取残基的名称。

返回：

str，残基名称。

set_name(name: str)

设定残基的残基名。

参数：

• name (str) - 残基名称。

set_start_index(start_index: int)

设定残基的开始索引。

参数：

• start_index (int) - 残基的开始索引。