sponge.colvar.FunctionCV
============================

.. 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.FunctionCV.rst
    :alt: 查看源文件


.. py:class:: sponge.colvar.FunctionCV(colvar: Union[Colvar, List[Colvar], Tuple[Colvar]], function: Callable, periodic: bool, shape: Tuple[int] = None, unit: str = None, use_pbc: bool = None, name: str = 'function')

    组合一组集合变量（CVs）的复合 Colvar :math:`{s_i(R)}` 使用自定义函数 :math:`f(s_1(R), s_2(R), ..., s_i(R))`。

    .. math::

        S = f(s_1(R), s_2(R), ... s_i(R))

    参数：
        - **colvar** (Union[Colvar, List[Colvar], Tuple[Colvar]]) - 要组合的集合变量 :math:`{s_i(R)}`。
        - **function** (callable) - 自定义函数 :math:`f(s_1(R), s_2(R), ... s_i(R))`。
        - **periodic** (bool) - 自定义集合变量是否为周期性变量。
        - **shape** (tuple) - 自定义集合变量的形状。如果给出空并且所有 CVs 都在 `colvar` 中具有相同的shape，然后它将被分配shape。如果每个 CVs 的shape在 `colvar` 中不完全一样，必须设置 `shape`。默认值： ``None``。
        - **unit** (str) - 集合变量的单位。默认值： ``None``。注意：这不是包裹长度和能量的 `Units` 单元格。
        - **name** (str) - 集合变量的名称。默认值：'combine'。

    .. py:method:: set_pbc(use_pbc: bool)

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