sponge.optimizer.Updater
- class sponge.optimizer.Updater(system: Molecule, controller: Union[Controller, List[Controller]] = None, time_step: float = 0.001, velocity: Union[Tensor, ndarray, List[float]] = None, weight_decay: float = 0.0, loss_scale: float = 1.0, **kwargs)[源代码]
MindSPONGE更新器的基类。是MindSpore中 Optimizer 的特殊子类。 Updater 更新仿真系统中的原子坐标。原子坐标的更新要求原子受力和原子速度。力是从外界传递而来，速度是 Updater 自己的参数。 当使用周期性边界条件的时候， Updater 也能够通过仿真系统的维里更新周期性边界条件箱的尺寸。 在通过一系列的 Controller 的仿真模拟中， Updater 控制着七个变量的值，分别是：坐标、速度、力、能量、动力学、维里和周期性边界条件箱。如果传入超过一个 Controller ，它们将按照队列顺序进行工作。
- 参数：
system (Molecule) - 模拟系统。
controller (Union[Controller, List[Controller]]) - 控制器或控制器列表来控制模拟系统中的七个变量（坐标、速度、力、能量、动力学、维里和周期性边界条件箱）。默认值：
None。time_step (float) - 单步时间。默认值：
1e-3。velocity (Union[Tensor, ndarray, List[float]]) - 原子速度的array，shape为
None。weight_decay (float) - 权重衰减值。默认值：
0.0。loss_scale (float) - 梯度缩放系数。默认值：
1.0。kwargs (dict) - 其他参数。
- 输入：
energy (Tensor) - 系统的能量。 shape为 (B, A, D) 的Tensor。数据类型为float。
force (Tensor) - 系统的力。 shape为 (B, A, D) 的Tensor。数据类型为float。
virial (Tensor) - 系统的维里。 shape为 (B, A, D) 的Tensor。数据类型为float。默认值：”None”。
- 输出：
bool，是否成功完成当前优化单步并且移动到下一步。
说明
B - Batch size。
A - 原子总数。
D - 模拟系统的维度，一般为3。
- 支持平台：
AscendGPU
- property boltzmann
当前单位下的布尔兹曼常数。
- 返回：
float，当前单位下的布尔兹曼常数。
- decay_and_scale_grad(force: Tensor, virial: Tensor = None)[源代码]
对力和维里进行权重衰减和梯度标度。
- 参数：
force (Tensor) - 力的Tensor，数据类型为float。
virial (Tensor) - 维里的Tensor，数据类型为float。默认值：”None”。
- 返回：
Tensor，权重衰减和梯度标度之后的力。
Tensor，权重衰减和梯度标度之后的维里。如果pbc_box是None，输出维里与输入保持一致。
- get_kinetics(velocity: Tensor)[源代码]
获取动力学。
- 参数：
velocity (Tensor) - 原子速度的Tensor，数据类型为float。
- 返回：
Tensor，系统中的动力学。
- get_pressure(kinetics: Tensor, virial: Tensor, pbc_box: Tensor)[源代码]
获得压力。
- 参数：
kinetics (Tensor) - 动力学的Tensor，数据类型为float。默认值：”None”。
virial (Tensor) - 维里的Tensor，数据类型为float。默认值：”None”。
pbc_box (Tensor) - 周期性边界条件箱的Tensor，数据类型为float。默认值：”None”。
- 返回：
Tensor，系统的压力。
- get_temperature(kinetics: Tensor = None)[源代码]
获取温度。
- 参数：
kinetics (Tensor) - 动力学的Tensor，数据类型为float。默认值：”None”。
- 返回：
Tensor，系统的温度。
- next_step(success: bool = True)[源代码]
完成当前优化step并且进行到下一个step。
- 参数：
success (bool) - 是否完成当前优化step并且移动到下一步。默认值：
True。
- 返回：
bool，是否成功完成当前优化step并且移动到下一步。
- property press_unit_scale
压力的参考值。
- 返回：
float，压力的参考值。
- update_coordinate(coordinate: Tensor, success: bool = True)[源代码]
更新坐标的参数。
- 参数：
coordinate (Tensor) - 原子的位置坐标的Tensor。数据类型为float。
success (bool) - 判断是否更新坐标。默认值：
True。
- 返回：
bool，是否成功更新了坐标的参数。
- update_kinetics(kinetics: Tensor, success: bool = True)[源代码]
更新动力学参数。
- 参数：
kinetics (Tensor) - 动力学的Tensor。数据类型为float。
success (bool) - 判断是否更新动力学参数。默认值：
True。
- 返回：
bool。是否成功更新了动力学参数。
- update_pbc_box(pbc_box: Tensor, success: bool = True)[源代码]
更新周期性边界条件箱的参数。
- 参数：
pbc_box (Tensor) - 周期性边界条件box的Tensor。数据类型为float。
success (bool) - 判断是否更新周期性边界条件箱的参数。默认值：
True。
- 返回：
bool，是否成功更新了周期性边界条件箱的参数。
- update_pressure(pressure: Tensor, success: bool = True)[源代码]
更新压力参数。
- 参数：
pressure (Tensor) - 压力的Tensor。数据类型为float。
success (bool) - 判断是否更新压力参数。默认值：
True。
- 返回：
bool。是否成功更新了压力参数。
- update_temperature(temperature: Tensor, success: bool = True)[源代码]
更新温度参数。
- 参数：
temperature (Tensor) - 温度的Tensor。数据类型为float。
success (bool) - 判断是否更新温度参数。默认值：
True。
- 返回：
bool。是否成功更新了温度参数。
