sponge.system.Molecule
- class sponge.system.Molecule(atoms: Union[List[Union[str, int]], ndarray] = None, 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, coordinate: Union[Tensor, ndarray, List[float]] = None, pbc_box: Union[Tensor, ndarray, List[float]] = None, template: Union[dict, str, List[Union[dict, str]]] = None, residue: Union[Residue, List[Residue]] = None, length_unit: str = None, **kwargs)[源代码]
分子体系层。
- 参数：
atoms (Union[List[Union[str, int]], ndarray]) - 体系中的原子。数据可以是原子名称的字符串，也可以是原子序号的int值。默认值：
None。atom_name (Union[List[str], ndarray]) - 原子名称字符串的array。默认值：
None。atom_type (Union[List[str], ndarray]) - 原子种类字符串的array。默认值：
None。atom_mass (Union[Tensor, ndarray, List[float]]) - 原子质量的array，类型为float，shape为 \((B, A)\) 其中B表示batch size， A表示原子数量。默认值：
None。atom_charge (Union[Tensor, ndarray, List[float]]) - 原子电荷数的array，类型为float，shape为 \((B, A)\) 。默认值：
None。atomic_number (Union[Tensor, ndarray, List[float]]) - 原子序数的array，类型为int，shape为 \((B, A)\) 。默认值：
None。bond (Union[Tensor, ndarray, List[int]]) - 键连接的array，数据类型为int，shape为 \((B, b, 2)\) 其中b表示键数量。默认值：
None。coordinate (Union[Tensor, ndarray, List[float]]) - 原子位置坐标 \(R\) 的Tensor，shape为 \((B, A, D)\) 其中D表示模拟体系的维度，一般为3，数据类型为float。默认值：
None。pbc_box (Union[Tensor, ndarray, List[float]]) - 周期性边界条件的box，shape为 \((B, D)\) 或者 \((1, D)\) 。默认值：
None。template (Union[dict, str, List[Union[dict, str]]]) - 分子的模板。可以是一个MindSPONGE模板格式的字典，也可以是一个MindSPONGE模板文件的字符串。如果输入是一个字符串，该类会优先在MindSPONGE模板的构建路径下( mindsponge.data.template )搜索与输入同名的文件。默认值：
None。residue (Union[Residue, List[Residue]]) - 残基或残基列表。如果 template 不是
None的话，只有模板里的残基会被使用。默认值：None。length_unit (str) - 长度单位。如果为
None，则使用全局长度单位。默认值：None。kwargs (dict) - 其他参数，用于扩展。
- 输出：
坐标，shape为 \((B, A, D)\) 的Tensor，其中B表示batch size， A表示原子数量，D表示模拟体系的维度，一般为3。数据类型为float。
周期性边界条件盒子，shape为 \((B, D)\) 的Tensor，其中B表示batch size， D表示模拟体系的维度，一般为3。数据类型为float。
- 支持平台：
AscendGPU
- add_residue(residue: Residue, coordinate: Tensor = None)[源代码]
向当前分子系统增加残基。
- 参数：
residue (class) - 向系统中增加的残基的 Residue 类。
coordinate (Tensor) - 输入残基的坐标。默认值：
None。
- build_space(coordinate: Tensor, pbc_box: Tensor = None)[源代码]
构建坐标系和周期性边界条件箱。
- 参数：
coordinate (Tensor) - 系统的初始坐标。如果是
None，系统会随机生成一个坐标作为它的初始坐标。pbc_box (Tensor) - 系统的初始周期性边界条件箱。如果是
None，则系统不会使用周期性边界系统。默认值：None。
- calc_colvar(colvar: Colvar) Tensor[源代码]
计算系统中特定的集体变量的值。
- 参数：
colvar (Colvar) - 一般的集体变量 \(s(R)\) 的基类。
- 返回：
Tensor，集体变量 \(s(R)\) 的值。
- calc_image(shift: float = 0) Tensor[源代码]
计算坐标图。
- 参数：
shift (float) - 相对于箱子尺寸 \(\vec{L}\) 的偏移比 \(c\) 。默认值：
0。
- 返回：
Tensor，坐标图。
- convert_length_from(unit)[源代码]
从指定的单位转换长度。
- 参数：
unit (Union[str, Units, Length, float, int]) - 长度单位。
- 返回：
float，从指定单位转换所得长度。
- convert_length_to(unit)[源代码]
把长度转换到指定的单位。
- 参数：
unit (Union[str, Units, Length, float, int]) - 长度单位。
- 返回：
float，根据特定单位换算所得长度。
- coordinate_in_pbc(shift: float = 0) Tensor[源代码]
获取在整个周期性边界条件箱中的坐标。
- 参数：
shift (float) - 相对于箱子尺寸的偏移比。默认值：
0。
- 返回：
Tensor，周期性边界条件箱中的坐标。shape为 (B, …, D) ，数据类型为float。
- copy(shift: Tensor = None)[源代码]
返回一个复制当前 Molecule 参数的 Molecule 类。
- 参数：
shift (Tensor) - 系统的移动距离。默认值：
None。
- 返回：
class，复制了当前 Molecule 类的参数的 Molecule 类。
- fill_water(edge: float = None, gap: float = None, box: ndarray = None, pdb_out: str = None, template: str = None)[源代码]
Molecule类中给周期性边界条件箱加水的内部方法。
- 参数：
edge (float) - 系统周围水的边长，默认值
None。gap (float) - 系统原子和水原子之间的最小间隔，默认值
None。box (Tensor) - 周期性边界条件箱，默认值
None。pdb_out (str) - 存放加水后的系统信息的pdb文件的名字，默认值
None。template (str) - 加的水分子的补充模板，默认值
None。
- 返回：
Tensor，加水后的周期性边界条件箱。
- get_atoms(atoms: Union[Tensor, Parameter, ndarray, str, list, tuple])[源代码]
从系统中获取原子。
- 参数：
atoms (Union[Tensor, Parameter, ndarray, str, list, tuple]) - 原子列表。
- 返回：
class。原子或一些原子。
- get_coordinate(atoms: AtomsBase = None)[源代码]
获取坐标的Tensor。
- 参数：
atoms (class) - 特殊原子群的基类，在MindSPONGE中被用作 atoms group module 。默认值：
None。
- 返回：
Tensor，坐标。数据类型为float。
- property heavy_atom_mask
重原子（非氢原子）的掩码。
- 返回：
Tensor，重原子的掩码。
- property length_unit
长度单位。
- 返回：
str，长度单位。
- property ndim
原子坐标的维度数量。
- 返回：
int，原子坐标的维度的数量。
- set_coordianate(coordinate: Tensor)[源代码]
设定坐标的值。
- 参数：
coordinate (Tensor) - 用于设定系统坐标的坐标。
- 返回：
Tensor，系统的坐标。
- set_pbc_box(pbc_box: Tensor = None) Tensor[源代码]
设置周期性边界条件箱。
- 参数：
pbc_box (Tensor) - 设置系统的周期性边界条件箱。如果是None，系统不会使用周期性边界条件箱。默认值：
None。
- 返回：
Tensor，系统的周期性边界条件箱。
- set_pbc_grad(grad_box: bool)[源代码]
设置是否计算周期性边界条件箱的梯度。
- 参数：
grad_box (bool) - 是否计算周期性边界条件箱的梯度。
- 返回：
bool，是否计算周期性边界条件箱的梯度。
- property shape
原子坐标的shape。
- 返回：
Tensor，原子坐标的shape。
- trainable_params(recurse=True)[源代码]
获取可训练参数。
- 参数：
recurse (bool) - 如果为True，则产生此网络层和所有子网络层的参数。否则，只产生作为此网络层直接成员的参数。默认值：
True。
- 返回：
list，所有可训练参数的list。
- update_coordinate(coordinate: Tensor)[源代码]
更新坐标的参数。
- 参数：
coordinate (Tensor) - 用于更新系统坐标的坐标。
- 返回：
Tensor。更新后的系统坐标。