Source code for espressomd.virtual_sites

# Copyright (C) 2010-2022 The ESPResSo project
#
# This file is part of ESPResSo.
#
# ESPResSo is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# ESPResSo is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
from .__init__ import has_features
from .script_interface import ScriptInterfaceHelper, script_interface_register

if has_features("VIRTUAL_SITES"):
[docs] @script_interface_register class ActiveVirtualSitesHandle(ScriptInterfaceHelper): """Handle for the virtual sites implementation active in the core This should not be used directly. Attributes ---------- have_quaternion : :obj:`bool` Whether the virtual sites has a quaternion (only relevant for :class:`~espressomd.virtual_sites.VirtualSitesRelative`). override_cutoff_check : :obj:`bool` Whether to disable the sanity check that triggers when attempting to set up a virtual site too far away from the real particle in a MPI-parallel simulation with more than 1 core. Disabling this check is not recommended; it is only relevant in rare situations when using the :ref:`Hybrid decomposition` cell system. """ _so_name = "VirtualSites::ActiveVirtualSitesHandle"
[docs] @script_interface_register class VirtualSitesOff(ScriptInterfaceHelper): """Virtual sites implementation which does nothing (default)""" _so_name = "VirtualSites::VirtualSitesOff"
if has_features("VIRTUAL_SITES_INERTIALESS_TRACERS"):
[docs] @script_interface_register class VirtualSitesInertialessTracers(ScriptInterfaceHelper): """Virtual sites which are advected with an LB fluid without inertia. Forces are on them are transferred to the fluid instantly. """ _so_name = "VirtualSites::VirtualSitesInertialessTracers"
if has_features("VIRTUAL_SITES_RELATIVE"):
[docs] @script_interface_register class VirtualSitesRelative(ScriptInterfaceHelper): """Virtual sites implementation placing virtual sites relative to other particles. See :ref:`Rigid arrangements of particles` for details. """ _so_name = "VirtualSites::VirtualSitesRelative"