Skip to content

GitLab

Switch branch/tag
Find file Normal viewHistoryPermalink
integrators.rst 1.77 KB
Newer Older
Josh A. Mitchell's avatar
Move to actively maintained dependencies for API docs (#3201)  
Josh A. Mitchell committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74 
===========
Integrators
===========

The ``Integrator`` abstract class
=================================

An ``Integrator`` implements an algorithm for advancing the simulation through
time.  ``Integrator`` is an abstract class; subclasses implement specific
algorithms.

.. toctree::
    :maxdepth: 2

    generated/Integrator


General purpose integrators
===========================

These are integrators appropriate for traditional MD and BD simulations.

.. toctree::
    :maxdepth: 2

    generated/BrownianIntegrator
    generated/LangevinIntegrator
    generated/LangevinMiddleIntegrator
    generated/NoseHooverIntegrator
    generated/VariableLangevinIntegrator
    generated/VariableVerletIntegrator
    generated/VerletIntegrator


Drude integrators
=================

These integrators permit modelling polarization with a Drude particle.

.. toctree::
    :maxdepth: 2

    generated/DrudeIntegrator
    generated/DrudeLangevinIntegrator
    generated/DrudeNoseHooverIntegrator
    generated/DrudeSCFIntegrator


Ring Polymer Molecular Dynamics integrators
===========================================

The RPMD integrator implements Ring Polymer MD.

.. toctree::
    :maxdepth: 2

    generated/RPMDIntegrator


Customizing ``Integrator``
==========================

These classes facilitate customisation of the integrator. ``CustomIntegrator``
allows a wide variety of integration algorithms to be implemented efficiently
without writing any low-level code. The integrator is built up as a series of
steps, each defined as an algebraic expression. ``CompoundIntegrator`` allows
different integrators to be combined by making it possible to switch the active
integrator in the middle of a simulation.

.. toctree::
    :maxdepth: 2

    generated/CustomIntegrator
    generated/CompoundIntegrator