Public Member Functions
def	__init__ (self, rundirs, minimumTime)

def	getAutocorrelation (self, deltaT)

def	getCorrelationTimes (self)

Detailed Description

Analysis class for data on mean square displacement, as produced by
`OpenMPCD::CUDA::MPCFluid::Instrumentation::VelocityAutocorrelation`.

Unless specified otherwise, all times are measured in units of MPC time.

@see OpenMPCD::CUDA::MPCFluid::Instrumentation::VelocityAutocorrelation

Definition at line 20 of file VelocityAutocorrelation.py.

Constructor & Destructor Documentation

◆ init()

def MPCDAnalysis.VelocityAutocorrelation.VelocityAutocorrelation.__init__	(	self,
		rundirs,
		minimumTime
	)

    The constructor.

    @throw TypeError
           Throws if `rundir` is not a `str`, or a `list` of `str`.
    @throw ValueError
           Throws if the given `rundir` does not exist, or does not contain
           a readable, valid data file.
    @throw ValueError
           Throws if `rundir` is an empty list.

    @param[in] rundirs
               The run directory, as a `string`. From this directory, the
               file `velocityAutocorrelations.data` will be read as input.
               If this file does not exist,
               `velocityAutocorrelations.data.xz` will be read instead.
               Alternatively, this can be a list of strings, each element
               of which specifies a directory that is treated as described
               above.
    @param[in] minimumTime
               Discard all measurements involving simulation times smaller
               than this value.

Definition at line 46 of file VelocityAutocorrelation.py.

Member Function Documentation

◆ getAutocorrelation()

def MPCDAnalysis.VelocityAutocorrelation.VelocityAutocorrelation.getAutocorrelation	(	self,
		deltaT
	)

    Returns an `OnTheFlyStatisticsDDDA` object that holds information on the
    sample of measured mean square displacements for time difference
    `deltaT`.

    @throw TypeError
           Throws if any of the arguments have invalid types.
    @throw ValueError
           Throws if any of the arguments have invalid values.

    @param[in] deltaT
               The time difference to return results for. This must be of
               type `float` and an element of `getCorrelationTimes()`.

Definition at line 126 of file VelocityAutocorrelation.py.

◆ getCorrelationTimes()

def MPCDAnalysis.VelocityAutocorrelation.VelocityAutocorrelation.getCorrelationTimes ( self )

    Returns a sorted list of valid correlation times.

Definition at line 140 of file VelocityAutocorrelation.py.

The documentation for this class was generated from the following file:

VelocityAutocorrelation.py