diff --git a/modules/mol/mm/doc/integrators.rst b/modules/mol/mm/doc/integrators.rst index 641b5e16817d19dc9d4fb4fea5d125174fb7835d..011def6a712c6f0880071cf097d008553e315f29 100644 --- a/modules/mol/mm/doc/integrators.rst +++ b/modules/mol/mm/doc/integrators.rst @@ -7,16 +7,25 @@ The Integrators are a wrapper around the integrators provided by OpenMM and have to be attached to the :class:`Settings` when setting up a simulation to provide a way of making the thing shake. -.. class:: VerletIntegrator +.. class:: VerletIntegrator(step_size) Implementation of Verlet dynamics + :param step_size: :class:`float` defining timestep in ps. -.. class:: BrownianIntegrator + +.. class:: BrownianIntegrator(temperature, friction_coeff, step_size) Implementation of Brownian dynamics + :param temperature: :class:`float` temperature of heat bath in K + + :param friction_coeff: :class:`float` friction coefficient coupling the + system to the heat bath in 1/ps + + :param step_size: :class:`float` defining timestep in ps. + .. method:: GetTemperature() :returns: :class:`float` @@ -44,10 +53,17 @@ to provide a way of making the thing shake. -.. class:: LangevinIntegrator +.. class:: LangevinIntegrator(temperature, friction_coeff, step_size) Implementation of the Langevin dynamics + :param temperature: :class:`float` temperature of heat bath in K + + :param friction_coeff: :class:`float` friction coefficient coupling the + system to the heat bath in 1/ps + + :param step_size: :class:`float` defining timestep in ps. + .. method:: GetTemperature() :returns: :class:`float` @@ -74,10 +90,12 @@ to provide a way of making the thing shake. -.. class:: VariableVerletIntegrator +.. class:: VariableVerletIntegrator(error_tol) Implementation of Verlet dynamics with variable time steps + :param error_tol: :class:`float` error tolerance + .. method:: GetErrorTolerance() :returns: :class:`float` @@ -88,10 +106,17 @@ to provide a way of making the thing shake. -.. class:: VariableLangevinIntegrator +.. class:: VariableLangevinIntegrator(temperature, friction_coeff, error_tol) Implementation of Langevin dynamics with variable time steps + :param temperature: :class:`float` temperature of heat bath in K + + :param friction_coeff: :class:`float` friction coefficient coupling the + system to the heat bath in 1/ps + + :param error_tol: :class:`float` error_tolerance. + .. method:: GetTemperature() :returns: :class:`float` diff --git a/modules/mol/mm/doc/interaction.rst b/modules/mol/mm/doc/interaction.rst index b2bd0439ff64f8a8d0112abcdb174f3adfc2c3b1..b25b9d01e3c96447d3d0a144ad73946dd134cda9 100644 --- a/modules/mol/mm/doc/interaction.rst +++ b/modules/mol/mm/doc/interaction.rst @@ -29,7 +29,9 @@ a harmonic angle) -------------------------------------------------------------------------------- -.. class:: Interaction +.. class:: Interaction(func_type) + + :param func_type: :class:`FuncType` defining a particular interaction ..method:: SetTypes(types) diff --git a/modules/mol/mm/doc/simulation.rst b/modules/mol/mm/doc/simulation.rst index 3de0804fb4ec3ee6be3a86135e1e1c50180cf61b..0a7176133487ddbd8f7f72bf7b9b87deea222af6 100644 --- a/modules/mol/mm/doc/simulation.rst +++ b/modules/mol/mm/doc/simulation.rst @@ -3,11 +3,45 @@ Simulation .. currentmodule:: ost.mol +The simulation finally connects a :class:`Topology` with an +:class:`ost.mol.EntityHandle`. While applying minimization or +MD tasks, the current positions of the simulation object can be +mapped back to the attached structure at any time. -.. class:: Simulation - The :class:`mm.Simulation` class is used to run a simulation. +.. class:: Simulation(entity, settings) + + first constructor, that takes an :class:`ost.mol.EntityHandle` as an input + and automatically constructs an internal :class:`Topology` according + to the provided **settings**. Be aware, that the **entity** will be altered + depending on hydrogen/termini definitions in the :class:`Forcefield` attached + to the **settings** + + :param entity: :class:`ost.mol.EntityHandle` from which a default + :class:`Topology` will be created according to the + **settings** + + :param settings: :class:`Settings` to control the parametrization of + the :class:`Simulation` and the buildup of the + internal :class:`Topology` + + :raises: :class:`RuntimeError` when construction of + :class:`Topology` fails + +.. class:: Simulation(topology,entity,settings) + + second constructor, that takes a :class:`Topology` and a consistent + :class:`ost.mol.EntityHandle` as an input. + + :param topology: :class:`Topology` to initialize the :class:`Simulation` + + :param entity: :class:`ost.mol.EntityHandle` that is consistent with + the provided **topology** + + :param settings: :class:`Settings` to control the parametrization of + the :class:`Simulation` + .. method:: Save(filename) diff --git a/modules/mol/mm/doc/topology.rst b/modules/mol/mm/doc/topology.rst index 5fb169e76eea21d677883bf831a8fab3993963bb..2a4f63604739c43bd453702267150865a91a22a0 100644 --- a/modules/mol/mm/doc/topology.rst +++ b/modules/mol/mm/doc/topology.rst @@ -43,8 +43,9 @@ that should suffice most needs. :class:`RuntimeError` can be supressed by the according flag in the :class:`Settings` object. -.. class:: Topology +.. class:: Topology(masses) + :param masses: :class:`list` of the particles masses .. method:: Save(filename)