DCDReporter¶

class openmm.app.dcdreporter.DCDReporter(file, reportInterval, append=False, enforcePeriodicBox=None)¶

DCDReporter outputs a series of frames from a Simulation to a DCD file.

To use it, create a DCDReporter, then add it to the Simulation’s list of reporters.

__init__(file, reportInterval, append=False, enforcePeriodicBox=None)¶

Create a DCDReporter.

Parameters

file (string) – The file to write to
reportInterval (int) – The interval (in time steps) at which to write frames
append (bool=False) – If True, open an existing DCD file to append to. If False, create a new file.
enforcePeriodicBox (bool) – Specifies whether particle positions should be translated so the center of every molecule lies in the same periodic box. If None (the default), it will automatically decide whether to translate molecules based on whether the system being simulated uses periodic boundary conditions.

Methods

`__init__`(file, reportInterval[, append, …])	Create a DCDReporter.
`describeNextReport`(simulation)	Get information about the next report this object will generate.
`report`(simulation, state)	Generate a report.

describeNextReport(simulation)¶

Get information about the next report this object will generate.

Parameters: simulation (Simulation) – The Simulation to generate a report for
Returns: A six element tuple. The first element is the number of steps until the next report. The next four elements specify whether that report will require positions, velocities, forces, and energies respectively. The final element specifies whether positions should be wrapped to lie in a single periodic box.
Return type: tuple

report(simulation, state)¶

Generate a report.

Parameters