simulation.rst



Simulation
The simulation finally connects a :class:`Topology` with an
:class:`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.
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:
Entity from which a default
:class:`Topology` will be created according to the
settings


param settings:
Controls the parametrization of
the :class:`Simulation` and the buildup of the
internal :class:`Topology`


type entity:
:class:`EntityHandle`


type settings:
:class:`Settings`


raises:
:class:`RuntimeError` when construction of
:class:`Topology` fails


Second constructor that takes a :class:`Topology`, a consistent
:class:`ost.mol.EntityHandle` and a :class:`Settings` as input.


param topology:
Topology to initialize the :class:`Simulation`


param entity:
Entity that is consistent with
the provided topology


param settings:
Controls the parametrization of
the :class:`Simulation`


type topology:
:class:`Topology`


type entity:
:class:`EntityHandle`


type settings:
:class:`Settings`


raises:
:class:`RuntimeException` when number of atoms in
entity is not equal the number of particles
in topology