module-hpmc-tune.rst

hoomd.hpmc.tune

Overview

.. py:currentmodule:: hoomd.hpmc.tune

.. autosummary::
    :nosignatures:

    BoxMCMoveSize
    MoveSize

Details

.. automodule:: hoomd.hpmc.tune
    :synopsis: Tuners for HPMC.
    :members:

    .. autoclass:: BoxMCMoveSize(trigger, moves, target, solver, max_move_size=None)
        :members: secant_solver, scale_solver

        .. method:: tuned()
            :property:

            Whether or not the moves sizes have converged to the desired acceptance rate.

            :type: bool


    .. autoclass:: MoveSize(trigger, moves, target, solver, types=None, max_move_size=None)
        :members: secant_solver, scale_solver

        .. method:: tuned()
            :property:

            Whether or not the moves sizes have converged to the desired acceptance rate.

            :type: bool