sponge.colvar.ColvarCombine
================================

.. image:: https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/master/resource/_static/logo_source.svg
    :target: https://gitee.com/mindspore/mindscience/blob/master/MindSPONGE/docs/api/api_python/colvar/sponge.colvar.ColvarCombine.rst
    :alt: 查看源文件


.. py:class:: sponge.colvar.ColvarCombine(colvar: Union[List[Colvar], Tuple[Colvar]], weights: Union[float, List[float], Tuple[float], Tensor] = 1, offsets: Union[float, List[float], Tuple[float], Tensor] = 0, exponents: Union[float, List[float], Tuple[float], Tensor] = 1, normal: bool = False, periodic_min: Union[float, ndarray, Tensor] = None, periodic_max: Union[float, ndarray, Tensor] = None, periodic_mask: Union[Tensor, ndarray] = None, use_pbc: bool = None, name: str = 'colvar_combination')

    参见 `CombineCV`。注意：此模块将在将来的版本中删除，请改用 `CombineCV`。

    .. math::

        S = \sum_i^n{w_i (s_i - o_i)^{p_i}}

    参数：
        - **colvar** (list or tuple) - 要组合的 `Colvar` 数组 :math:`{s_i}`。
        - **weights** (list, tuple, float, Tensor) - Weights :math:`{w_i}` 对每组Colvar。如果给定列表或元组，则元素的数量应等于 CVs 的数量。如果给定浮点数或张量，则该值将用于所有 Colvar。默认值：1。
        - **offsets** (list, tuple, float, Tensor) - Offsets :math:`{o_i}` 对每组Colvar。如果给定列表或元组，则元素的数量应等于 CVs 的数量。如果给定浮点数或张量，则该值将用于所有 Colvar。默认值：0。
        - **exponents** (list, tuple, float, Tensor) - Exponents :math:`{p_i}` 对每组Colvar。如果给定列表或元组，则元素的数量应等于 CVs 的数量。如果给定浮点数或张量，则该值将用于所有 Colvar。默认值：1。
        - **normal** (bool) - 是否将所有权重归一化为 1。默认值： ``False``。
        - **periodic_min** (float, ndarray, Tensor) - CVs 组合输出的周期性最小值。如果输出不是周期性的，则应为空。默认值： ``None``。
        - **periodic_max** (float, ndarray, Tensor) - CVs 组合输出的周期性最大值。如果输出不是周期性的，则应为空。默认值： ``None``。
        - **periodic_mask** (Tensor, ndarray) - 输出周期性的掩码。张量的shape应与输出相同，即 (S_1, S_2, ..., S_n) 。默认值： ``None``。
        - **use_pbc** (bool) - 是否使用周期边界条件。如果给出 ``None`` ，它将确定是否使用基于是否提供 `pbc_box` 的周期性边界条件。默认值： ``None``。
        - **name** (str) - 集合变量的名称。默认值：'combine'。